Find a company

Finds companies by ticker or name. Use the country and ticker from a result in the other endpoints.

Only companies with verified data are returned.

Endpoint


GET https://api.vitati360.com/proxy/external/v1/companies

Query parameters

Parameter	Required	Description
`q`	Yes	Ticker or company name, 2 to 80 characters. Matches anywhere in the name or the ticker. Case-insensitive.
`country`	No	Restrict results to one country code, for example `qa`.
`limit`	No	Maximum results, default `20`, at most `50`.

The most exact ticker match comes first, then the rest sorted by name.

Response

An array of companies:

Field	Type	Description
`ticker`	string	The ticker, for example `qnbk`.
`name`	string	The company name.
`country`	string	The country code, for example `qa`.
`exchange`	string	The exchange the company is listed on.
`sector`	string or `null`	The sector.
`reportedCurrency`	string	The currency the company reports in.

Examples

Search for companies whose name or ticker contains qnb, in Qatar:

cURL


curl --compressed \
  -H "x-api-key: YOUR_API_KEY" \
  "https://api.vitati360.com/proxy/external/v1/companies?q=qnb&country=qa"

Python


import os
import requests
 
response = requests.get(
    "https://api.vitati360.com/proxy/external/v1/companies",
    headers={"x-api-key": os.environ["VITATI_API_KEY"]},
    params={"q": "qnb", "country": "qa"},
    timeout=30,
)
response.raise_for_status()
 
for company in response.json():
    print(company["country"], company["ticker"], company["name"])

JavaScript


const url = new URL("https://api.vitati360.com/proxy/external/v1/companies");
url.search = new URLSearchParams({ q: "qnb", country: "qa" });
 
const response = await fetch(url, {
  headers: { "x-api-key": process.env.VITATI_API_KEY },
});
if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}
 
for (const company of await response.json()) {
  console.log(company.country, company.ticker, company.name);
}

Errors

Status	When
`400`	`q` is missing or shorter than 2 characters, or `country` is not a country code.
`401`	The API key is missing, disabled, or expired.
`429`	The key has sent more requests than its limit in the current minute.

See Errors and rate limits.