Discovery endpoints help you find instruments when you don't already know the exact identifier. The Asset Catalog is the phone book; Discovery is the search engine on top of it.
The symbol search endpoint allows users to find financial instruments by name or symbol. It returns a list of matching symbols, ordered by relevance, with the most relevant instrument first. This is useful for quickly locating specific stocks, ETFs, or other financial instruments when only partial information is available.
Route
/symbol_searchAPI credits cost
1 per request
✱ symbol
stringSymbol to search. Supports:
Example:
AAPL
outputsize
integerNumber of matches in response. Max 120
Default:
30
show_plan
booleanAdds info on which plan symbol is available.
Default:
false
Request example
Response
{
"data": [
{
"symbol": "AA",
"instrument_name": "Alcoa Corp",
"exchange": "NYSE",
"mic_code": "XNYS",
"exchange_timezone": "America/New_York",
"instrument_type": "Common Stock",
"country": "United States",
"currency": "USD",
"access": {
"global": "Basic",
"plan": "Basic",
"plan_business": "Basic"
}
}
],
"status": "ok"
}
The cross_listings endpoint provides a daily updated list of cross-listed symbols for a specified financial instrument. Cross-listed symbols represent the same security available on multiple exchanges. This endpoint is useful for identifying all the exchanges where a particular security is traded, allowing users to access comprehensive trading information across different markets.
Route
/cross_listingsAPI credits cost
40 per request
✱ symbol
stringThe ticker symbol of an instrument for which data is requested
Example:
AAPL
exchange
stringExchange where instrument is traded
Example:
NASDAQ
mic_code
stringMarket identifier code (MIC) under ISO 10383 standard
Example:
XNGS
country
stringCountry to which stock exchange belongs to
Example:
United States
Response
{
"result": {
"count": 4,
"list": [
{
"exchange": "NASDAQ",
"mic_code": "XNGS",
"name": "NVIDIA Corporation",
"symbol": "NVDA"
},
{
"exchange": "VSE",
"mic_code": "XWBO",
"name": "NVIDIA Corporation",
"symbol": "NVDA"
},
{
"exchange": "BVS",
"mic_code": "XSGO",
"name": "NVIDIA Corporation",
"symbol": "NVDACL"
},
{
"exchange": "BVS",
"mic_code": "XSGO",
"name": "NVIDIA Corporation",
"symbol": "NVDA"
}
]
}
}
The earliest_timestamp endpoint provides the earliest available date and time for a specified financial instrument at a given data interval. This endpoint is useful for determining the starting point of historical data availability for various assets, such as stocks or currencies, allowing users to understand the time range covered by the data.
Route
/earliest_timestampAPI credits cost
1 per request
symbol
stringSymbol ticker of the instrument.
Example:
AAPL
figi
stringFilter by financial instrument global identifier (FIGI). This parameter is available on the Ultra plan (individual) and the Enterprise plan (business) and above.
Example:
BBG000B9XRY4
isin
stringLook up an instrument by its International Securities Identification Number (ISIN). Available on all plans. Returning ISIN values in responses requires the ISIN Data add-on.
Example:
US0378331005
cusip
stringLook up an instrument by its Committee on Uniform Securities Identification Procedures (CUSIP) number. Available on all plans. Returning CUSIP values in responses requires the CUSIP Data add-on.
Example:
594918104
✱ interval
stringInterval between two consecutive points in time series.
Supports: 1min, 5min, 15min, 30min, 45min, 1h, 2h, 4h, 8h, 1day, 1week, 1month
Example:
1day
exchange
stringExchange where instrument is traded.
Example:
Nasdaq
mic_code
stringMarket Identifier Code (MIC) under ISO 10383 standard.
Example:
XNAS
timezone
stringTimezone at which output datetime will be displayed. Supports:
Exchange for local exchange timeUTC for datetime at universal UTC standardAmerica/New_York, Asia/Singapore. Full list of timezones can be found here.Interval Limitation: The timezone parameter is only applicable for intraday intervals (less than 1 day). For intervals of 1day, 1week, or 1month, the timezone parameter is ignored, and data is strictly returned in the Exchange local time.
Take note that the IANA Timezone name is case-sensitive
Default:
Exchange
Response
{
"unix_time": 345479400,
"datetime": "1980-12-12"
}