Get API key

Schemas

Symbol

SymbolResponse · object

Reference data for one price feed: identifiers, classification, data-quality parameters, trading schedules and, for derivatives, expiration metadata.

Fields

Each Symbol object contains the following fields.

asset_type

The market the feed's price comes from, such as equity, crypto, fx or commodity.

descriptionstring

Description of the instrument.

exponentinteger

Exponent 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_type

The form of what the feed prices within its market, such as spot, future or index.

market_session_scheduleobject

Trading schedules grouped by market session.

regularstring | null

Trading schedule for the regular session.

over_nightstring | null

Trading schedule for the overnight session.

post_marketstring | null

Trading schedule for the post-market session.

pre_marketstring | null

Trading schedule for the pre-market session.

market_sessionsobject

Trading schedules, availability states, and publisher requirements for each market session.

regularobject | null

Configuration for the regular session.

min_pubinteger

Minimum number of publishers required for this session.

schedulestring

Trading schedule for this session.

statestring

Availability state for this session.

over_nightobject | null

Configuration for the overnight session.

min_pubinteger

Minimum number of publishers required for this session.

schedulestring

Trading schedule for this session.

statestring

Availability state for this session.

post_marketobject | null

Configuration for the post-market session.

min_pubinteger

Minimum number of publishers required for this session.

schedulestring

Trading schedule for this session.

statestring

Availability state for this session.

pre_marketobject | null

Configuration for the pre-market session.

min_pubinteger

Minimum number of publishers required for this session.

schedulestring

Trading schedule for this session.

statestring

Availability state for this session.

min_channel

Fastest update channel supported by the feed.

min_publishersinteger

Default minimum number of publishers required for this feed.

namestring

Name of the instrument.

pyth_lazer_idinteger

Numeric ID used to request this feed from the Pyth Price Feeds API.

schedulestring

Trading schedule for the regular session.

statestring

Availability state of the feed.

symbolstring

Symbol used to request this feed.

asset_sectorstring | null

Asset sector inherited from the feed's exchange. null if no classification is available.

asset_subclassstring | null

Asset subclass inherited from the feed's exchange. null if no classification is available.

availability_patternstring[] | null

Contract months in which this futures chain is available. null when not applicable.

cmc_idinteger | null

CoinMarketCap asset ID, when available.

corporate_actionsobject[] | null

Corporate actions associated with the instrument. Omitted when none are configured.

activationobject

Condition that determines when the corporate action takes effect.

us_equity_ex_dateobject

Activation on the ex-date of a US equity corporate action.

ex_datestring

Ex-date of the corporate action, in YYYY-MM-DD format.

event_typestring

Type of corporate action.

  • SPLIT
  • REVERSE_SPLIT
split_fromstring

Denominator of the split ratio. An empty string when no split ratio applies.

split_tostring

Numerator of the split ratio. An empty string when no split ratio applies.

expiration_patternstring[] | null

Contract months in which this futures chain expires. null when not applicable.

expiration_timestring | null

Expiration time of the instrument, when applicable. Uses the time zone of the regular trading session.

hermes_idstring | null

Hexadecimal ID used to request this feed from the Hermes-compatible API.

intervalstring | null

Funding rate interval as a duration string, when applicable.

nasdaq_symbolstring | null

Nasdaq symbol for the instrument.

quote_currencystring | null

Currency in which the price is quoted.

symbol_chain_idstring | null

Identifier of the futures chain, such as VX. null when not applicable.

Used by

The following endpoint uses this schema.