Schemas
Symbol
SymbolResponse · object
Reference data for one price feed: identifiers, classification, data-quality parameters, trading schedules and, for derivatives, expiration metadata.
Each Symbol object contains the following fields.
asset_typeThe market the feed's price comes from, such as equity, crypto, fx or commodity.
descriptionstringDescription of the instrument.
exponentintegerExponent used to scale decimal field values: value * 10^exponent.
groupsstring[]Access groups associated with this feed. The array is empty for feeds that do not require membership in an access group.
instrument_typeThe form of what the feed prices within its market, such as spot, future or index.
market_session_scheduleobjectTrading schedules grouped by market session.
regularstring | nullTrading schedule for the regular session.
over_nightstring | nullTrading schedule for the overnight session.
post_marketstring | nullTrading schedule for the post-market session.
pre_marketstring | nullTrading schedule for the pre-market session.
market_sessionsobjectTrading schedules, availability states, and publisher requirements for each market session.
regularobject | nullConfiguration for the regular session.
min_pubintegerMinimum number of publishers required for this session.
schedulestringTrading schedule for this session.
statestringAvailability state for this session.
over_nightobject | nullConfiguration for the overnight session.
min_pubintegerMinimum number of publishers required for this session.
schedulestringTrading schedule for this session.
statestringAvailability state for this session.
post_marketobject | nullConfiguration for the post-market session.
min_pubintegerMinimum number of publishers required for this session.
schedulestringTrading schedule for this session.
statestringAvailability state for this session.
pre_marketobject | nullConfiguration for the pre-market session.
min_pubintegerMinimum number of publishers required for this session.
schedulestringTrading schedule for this session.
statestringAvailability state for this session.
min_channelFastest update channel supported by the feed.
min_publishersintegerDefault minimum number of publishers required for this feed.
namestringName of the instrument.
pyth_lazer_idintegerNumeric ID used to request this feed from the Pyth Price Feeds API.
schedulestringTrading schedule for the regular session.
statestringAvailability state of the feed.
symbolstringSymbol used to request this feed.
asset_sectorstring | nullAsset sector inherited from the feed's exchange. null if no classification is available.
asset_subclassstring | nullAsset subclass inherited from the feed's exchange. null if no classification is available.
availability_patternstring[] | nullContract months in which this futures chain is available. null when not applicable.
cmc_idinteger | nullCoinMarketCap asset ID, when available.
corporate_actionsobject[] | nullCorporate actions associated with the instrument. Omitted when none are configured.
activationobjectCondition that determines when the corporate action takes effect.
us_equity_ex_dateobjectActivation on the ex-date of a US equity corporate action.
ex_datestringEx-date of the corporate action, in YYYY-MM-DD format.
event_typestringType of corporate action.
- SPLIT
- REVERSE_SPLIT
split_fromstringDenominator of the split ratio. An empty string when no split ratio applies.
split_tostringNumerator of the split ratio. An empty string when no split ratio applies.
expiration_patternstring[] | nullContract months in which this futures chain expires. null when not applicable.
expiration_timestring | nullExpiration time of the instrument, when applicable. Uses the time zone of the regular trading session.
hermes_idstring | nullHexadecimal ID used to request this feed from the Hermes-compatible API.
intervalstring | nullFunding rate interval as a duration string, when applicable.
nasdaq_symbolstring | nullNasdaq symbol for the instrument.
quote_currencystring | nullCurrency in which the price is quoted.
symbol_chain_idstring | nullIdentifier of the futures chain, such as VX. null when not applicable.
The following endpoint uses this schema.
- getList symbols
Response, each item