Start trial

API reference

Reference

Search, identifiers, exchanges and trading calendars, plus our sector, currency and chain lists.

Supported chains

GET /v1/chains

Free Operation ID reference.chains

Every chain we cover. Token symbols use the namespace, like SOLANA:9BB6...pump.

Query parameters

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 7 fields
    • evmChainId integer or null

      The EIP-155 chain id, null for chains that aren't EVM

    • id string
    • kind string

      One of evmutxosvmtvmother

    • name string
    • namespace string
    • nativeDecimals integer
    • nativeSymbol string
  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Supported currencies

GET /v1/currencies

Free Operation ID reference.currencies

Every currency prices can be converted into with currency=.

Query parameters

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 3 fields
    • code string
    • minorUnits integer or null

      Decimal places of the minor unit, null for units without one like gold

    • name string
  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Exchanges

GET /v1/exchanges

Free Operation ID reference.exchanges

Every exchange we cover with its country, timezone, currency and regular trading hours in local time.

Query parameters

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 12 fields
    • aliases array of strings

      Other names symbols can use for this exchange, like ASX

    • breaks array of objects

      Midday pauses, local time

      Show 2 fields
      • end string
      • start string
    • close string

      Regular session close, local time

    • country string
    • currency string
    • mic string
    • name string
    • open string

      Regular session open, local time

    • operatingMic string
    • quoteUnit string or null

      The minor unit prices are quoted in, like GBX, null when quoted in major units

    • timezone string

      IANA timezone the hours are in

    • weekend array of strings
  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Exchange trading calendar

GET /v1/exchanges/{mic}/calendar

Free Operation ID reference.exchangeCalendar

Trading sessions between from and to with their open, close and breaks in UTC, plus the holidays and early closes in that range. Up to five years per call.

Path parameters

  • mic string Required

    A MIC, or an alias like ASX

    Up to 16 characters

Query parameters

  • from date Required

    First day, YYYY-MM-DD

  • to date Required

    Last day, YYYY-MM-DD

Response

  • data object
    Show 4 fields
    • holidays array of objects

      Weekdays in the range the exchange is closed or closes early

      Show 4 fields
      • close string or null

        The early close in local time, null when closed all day

      • date date
      • kind string

        One of closedearly_close

      • name string
    • mic string
    • sessions array of objects

      Every trading day in the range

      Show 5 fields
      • breaks array of objects
        Show 2 fields
        • end timestamp
        • start timestamp
      • close timestamp
      • date date
      • earlyClose boolean
      • open timestamp
    • timezone string
  • meta object
    Show 3 fields
    • asOf timestamp or null

      The point in time this data describes, like when a filing was published. Null where that doesn't apply, as with account data

    • credits integer

      Credits this call cost

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden404 Not Found422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Instruments listed on an exchange

GET /v1/exchanges/{mic}/instruments

1 credit per page 2 credits with fresh=true Operation ID reference.exchangeInstruments

The exchange's whole listing universe, ordered by ticker.

Path parameters

  • mic string Required

    A MIC, or an alias like ASX

    Up to 16 characters

Query parameters

  • cursor string

    From meta.nextCursor of the previous page

    Up to 512 characters

  • limit integer

    Page size

    From 1 to 1000. Defaults to 100

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 4 fields
    • industry string or null

      An industry id from /v1/sectors, null when unclassified

    • instrument object
      Show 7 fields
      • country string or null
      • currency string or null
      • id string
      • mic string or null
      • name string
      • symbol string
      • type string

        One of equityetffundindexfxcryptotokenratefuturecommoditybond

    • isin string or null
    • snapshotDate date

      The trading day this listing was last seen on

  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden404 Not Found422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Instrument details

GET /v1/instruments

1 credit per instrument 2 credits with fresh=true Operation ID reference.instruments

Every identifier we hold, status, listing dates, and the history of listings and names. Licensed identifiers like CUSIP and SEDOL work as symbols but are never returned.

Query parameters

  • symbols array of strings Required

    Comma separated identifiers, up to 100, like ASX:VAS, isin:AU000000VAS1 or ins_...

    Up to 100 items

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 9 fields
    • asOf timestamp

      The point in time this data describes. For history and events it's the date of the newest record, or the end of your range when there are none. Live values give when they were observed, and reference data gives when we last checked it with a source

    • identifiers object
      Show 13 fields
      • apir string or null
      • cik string or null
      • compositeFigi string or null
      • contract string or null

        chain:address, for tokens

      • cryptoSymbol string or null
      • figi string or null
      • futureCode string or null
      • fxPair string or null
      • indexCode string or null
      • isin string or null
      • lei string or null
      • rateCode string or null
      • shareClassFigi string or null
    • instrument object

      What the symbol resolved to

      Show 7 fields
      • country string or null
      • currency string or null
      • id string
      • mic string or null
      • name string
      • symbol string
      • type string

        One of equityetffundindexfxcryptotokenratefuturecommoditybond

    • listedFrom date or null

      First trading day on any exchange, null when unknown or never listed

    • listedTo date or null

      Last trading day, null while listed

    • listings array of objects

      Every exchange and ticker it has traded under, oldest first

      Show 4 fields
      • from date or null

        First trading day, null when unknown

      • mic string
      • ticker string
      • to date or null

        Last trading day, null while listed

    • names array of objects

      Every name it has had, oldest first

      Show 3 fields
      • from date or null

        First day under this name, null when unknown

      • name string
      • to date or null

        Last day under this name, null for the current name

    • status string

      One of activedelistedsuspended

    • symbol string

      The symbol as sent

  • errors array of objects
    Show 3 fields
    • code string

      One of invalid_symbolinstrument_not_foundnot_supporteddata_unavailabledata_pendingsource_failed

    • message string
    • symbol string
  • meta object
    Show 2 fields
    • credits integer

      Credits this call cost

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Find instruments

GET /v1/search

1 credit per call 2 credits with fresh=true Operation ID reference.search

Instruments whose name, ticker, ISIN or contract address matches q, ordered by symbol. Each page costs the same.

Query parameters

  • q string Required

    A name, ticker, ISIN or contract address

    Up to 100 characters

  • type string

    Only instruments of this type

    One of equityetffundindexfxcryptotokenratefuturecommoditybond

  • exchange string

    Only instruments listed here, as a MIC or an alias like ASX

    Up to 16 characters

  • country string

    Only instruments from this ISO country

    Matches ^[A-Z]{2}$

  • cursor string

    From meta.nextCursor of the previous page

    Up to 512 characters

  • limit integer

    Page size

    From 1 to 1000. Defaults to 100

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 7 fields
    • country string or null
    • currency string or null
    • id string
    • mic string or null
    • name string
    • symbol string
    • type string

      One of equityetffundindexfxcryptotokenratefuturecommoditybond

  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.

Sector and industry taxonomy

GET /v1/sectors

Free Operation ID reference.sectors

Our sectors and the industries in each. Profiles, listings and the screener use these ids.

Query parameters

  • fresh boolean

    Skip our cache and fetch from sources. Items fetched fresh cost double

  • format string

    Response format

    One of jsoncsv

    Defaults to json

Response

  • data array of objects
    Show 3 fields
    • id string
    • industries array of objects
      Show 2 fields
      • id string
      • name string
    • name string
  • meta object
    Show 3 fields
    • credits integer

      Credits this call cost

    • nextCursor string or null

      Pass as cursor to get the next page, null on the last page

    • requestId string

Errors

400 Bad Request401 Unauthorized402 Payment Required403 Forbidden422 Unprocessable Entity429 Too Many Requests500 Internal Server Error503 Service Unavailable

Every error body is problem+json with a stable code. See errors.