Company metrics

Lists the metrics one company reports, grouped by section. Metric names vary by company, so use this list to find the keys to read from Financial history.

Endpoint


GET https://api.vitati360.com/proxy/external/v1/company/{country}/{ticker}/metrics

Path parameter	Description
`country`	Country code, for example `qa`. Case-insensitive.
`ticker`	Ticker symbol, for example `qnbk`. Case-insensitive.

Response

An array of sections:

Field	Type	Description
`section`	string	The section name. Use it in the `sections` parameter of the financials endpoint.
`label`	string	The section’s display name.
`metrics`	array	The metrics in the section.

Each metric has:

Field	Type	Description
`key`	string	The metric key. It is the field name in the financials response.
`label`	string	The metric’s display name.
`unitClass`	string or `null`	`MONETARY` and `MONETARY_PER_SHARE` values are converted by the `currency` parameter. Other values are not.
`unit`	string or `null`	The unit, where the data has one.

Examples

cURL


curl --compressed \
  -H "x-api-key: YOUR_API_KEY" \
  "https://api.vitati360.com/proxy/external/v1/company/qa/qnbk/metrics"

Python


import os
import requests
 
response = requests.get(
    "https://api.vitati360.com/proxy/external/v1/company/qa/qnbk/metrics",
    headers={"x-api-key": os.environ["VITATI_API_KEY"]},
    timeout=30,
)
response.raise_for_status()
 
for section in response.json():
    print(section["section"], [metric["key"] for metric in section["metrics"]])

JavaScript


const response = await fetch(
  "https://api.vitati360.com/proxy/external/v1/company/qa/qnbk/metrics",
  { headers: { "x-api-key": process.env.VITATI_API_KEY } },
);
if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}
 
for (const section of await response.json()) {
  console.log(section.section, section.metrics.map((metric) => metric.key));
}

Errors

Status	When
`401`	The API key is missing, disabled, or expired.
`404`	No company matches the country and ticker.
`429`	The key has sent more requests than its limit in the current minute.

See Errors and rate limits.