View Metadata

Get display metadata for a company.

Returns metadata used for displaying company information, including counts of available data in each category.

Endpoint

GET /api/v1/companies/:company_id/view/meta

Parameters

Parameter	Type	In	Description
`company_id`	`integer`	path	The unique identifier of the company.

Code Examples

import requests

url = 'https://statsnet.co/api/v1/companies/12345/view/meta'
headers = {
  'Authorization': 'Bearer sk_live_YOUR_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Response

The response body has no {"ok": ...} envelope — it is a flat object of per-category counts.

Success response

{
  "id": 12345,
  "trademarks": 0,
  "quasi_contracts": 0,
  "websites": 1,
  "shareholders": 1,
  "officers": 1,
  "procurement": 0,
  "employment_contracts": 24,
  "employees": 12,
  "social_networks": 2,
  "debtors": 1,
  "debtors_amount": null,
  "pos_terminals": 0,
  "stores": 0,
  "places": 0,
  "gov_loans": 0,
  "certs": 2,
  "jobs": 5,
  "companies_contacts": 3,
  "subsidiaries": 0,
  "bank_accounts": 3,
  "intellectual_properties": 0,
  "counterparties": 12,
  "names": 1,
  "events": 0,
  "marketplaces": 0,
  "shareholders_by_count": "1 shareholder",
  "officers_by_count": "1 officers",
  "gov_contracts": 2,
  "activities": 4,
  "court_cases": 0
}

Error Handling

Errors are returned as {"status": <HTTP code>, "message": "<text>"}.

Error response

{
  "status": 403,
  "message": "access denied"
}