Amberdata Market Data API

Spot, futures, and options market data — exchanges reference, tickers, trades, OHLCV, order-book snapshots and events, funding rates, open interest, and liquidations.

OpenAPI Specification

amberdata-market-openapi.yaml Raw ↑
openapi: 3.1.0
info:
  title: market-api
  version: '2'
servers:
  - url: https://api.amberdata.com/markets
security:
  - ApiKeyAuth: []
paths:
  /spot/exchanges/information:
    get:
      summary: Instruments
      description: >-
        Provides detailed metadata for available trading pairs on supported Spot
        market exchanges, including exchange names, trading instruments, and
        available data types (OHLCV, Order Book Snapshots, Order Book Events,
        Ticker, and Trades) with respective data availability periods.
      operationId: get-market-exchanges
      parameters:
        - name: exchange
          in: query
          description: only return data for the given exchanges (comma separated)
          schema:
            type: string
        - name: instrument
          in: query
          description: Only return data for the given pair.
          schema:
            type: string
        - name: timeFormat
          in: query
          description: >-
            **[Optional]** Time format of the timestamps in the return payload.
            **[Defaults]** `milliseconds | ms* | iso | iso8601 | hr |
            human_readable`
          schema:
            type: string
        - name: includeInactive
          in: query
          description: >-
            **[Optional]** If true, endpoint returns all instruments, including
            delisted ones.  **[Defaults]** True | False*.
          schema:
            type: boolean
        - name: Accept-Encoding
          in: header
          required: true
          description: ''
          schema:
            type: string
            default: gzip, deflate, br
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Success:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      metadata:
                        next: >-
                          https://api.amberdata.com/markets/spot/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcWATnEgDTjTzICqEAznAA4sD2JWSCAogB5QAFuggBzJIyIAzdDEaUQOALZIAYp2XosREMrAwYYBVHYQEUqtM3bdAK0ZmQVFuglEAjFUZgAXgUIAVgAGYIBfIA
                        api-version: '2023-09-30'
                      data:
                        - exchange: binance
                          instrument: 1000cat_bnb
                          active: true
                          ohlcv:
                            startDate: 1734393600000
                            endDate: 1739750400000
                          orderBookSnapshot:
                            startDate: 1734427800000
                            endDate: 1739895780000
                          orderBookEvent:
                            startDate: 1734426029092
                            endDate: 1739895599692
                          ticker:
                            startDate: 1734426147738
                            endDate: 1739895595115
                          trade:
                            startDate: 1734426214300
                            endDate: 1739894107524
                        - exchange: binance
                          instrument: 1000cat_fdusd
                          active: true
                          ohlcv:
                            startDate: 1734393600000
                            endDate: 1739750400000
                          orderBookSnapshot:
                            startDate: 1734427800000
                            endDate: 1739895780000
                          orderBookEvent:
                            startDate: 1734426029293
                            endDate: 1739895599593
                          ticker:
                            startDate: 1734426145880
                            endDate: 1739895592405
                          trade:
                            startDate: 1734426221718
                            endDate: 1739895250067
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 200
                    default: 0
                  title:
                    type: string
                    example: OK
                  description:
                    type: string
                    example: Successful request
                  payload:
                    type: object
                    properties:
                      metadata:
                        type: object
                        properties:
                          next: {}
                      data:
                        type: object
                        properties:
                          gdax:
                            type: object
                            properties:
                              00_usd:
                                type: object
                                properties:
                                  ohlc:
                                    type: object
                                    properties:
                                      startDate:
                                        type: integer
                                        example: 1665508560000
                                        default: 0
                                      endDate:
                                        type: integer
                                        example: 1722369180000
                                        default: 0
                                  order_book_update:
                                    type: object
                                    properties:
                                      startDate:
                                        type: integer
                                        example: 1665507779045
                                        default: 0
                                      endDate:
                                        type: integer
                                        example: 1722368954000
                                        default: 0
                                  order_book:
                                    type: object
                                    properties:
                                      startDate:
                                        type: integer
                                        example: 1665510000000
                                        default: 0
                                      endDate:
                                        type: integer
                                        example: 1722369300000
                                        default: 0
                                  ticker:
                                    type: object
                                    properties:
                                      startDate:
                                        type: integer
                                        example: 1665508608000
                                        default: 0
                                      endDate:
                                        type: integer
                                        example: 1722366995000
                                        default: 0
                                  trade:
                                    type: object
                                    properties:
                                      startDate:
                                        type: integer
                                        example: 1665508608000
                                        default: 0
                                      endDate:
                                        type: integer
                                        example: 1722366995000
                                        default: 0
      deprecated: false
      security:
        - ApiKeyAuth: []
  /spot/exchanges/reference:
    get:
      summary: Reference
      description: >-
        Returns essential reference details for Spot market trading pairs on
        supported exchanges, including symbols, market status, price and volume
        limits, cost and leverage constraints, precision requirements, and
        listing metadata.
      operationId: spot-exchanges-reference
      parameters:
        - name: exchange
          in: query
          description: >-
            **[Optional]** Only return data for the given exchange(s) (comma
            separated)
          schema:
            type: string
        - name: instrument
          in: query
          description: Only return data for the given pair.
          schema:
            type: string
        - name: includeInactive
          in: query
          description: >-
            **[Optional]** If true, endpoint returns all pairs, including
            delisted ones. **[Defaults]** `True | False*`.
          schema:
            type: boolean
        - name: includeOriginalReference
          in: query
          description: >-
            **[Optional]** If true, endpoint returns originalReference.
            **[Defaults]** `True | False*`.
          schema:
            type: boolean
        - name: Accept-Encoding
          in: header
          required: true
          description: ''
          schema:
            type: string
            default: gzip, deflate, br
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Success:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      metadata:
                        next: >-
                          https://api.amberdata.com/markets/spot/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA
                        api-version: '2023-09-30'
                      data:
                        - exchange: arkham
                          instrument: ada_usdt
                          baseSymbol: ada
                          quoteSymbol: usdt
                          market: spot
                          exchangeEnabled: true
                          limitsPriceMin: 0.0001
                          limitsPriceMax: 1000
                          limitsVolumeMin: 0.1
                          limitsVolumeMax: 900000
                          limitsMarketMin: null
                          limitsMarketMax: null
                          limitsLeverageMin: null
                          limitsLeverageMax: 0
                          limitsLeverageSuperMax: null
                          limitsCostMin: 5
                          limitsCostMax: null
                          precisionPrice: 0.0001
                          precisionVolume: 0.1
                          precisionBase: null
                          precisionQuote: null
                          listingTimestamp: null
              schema:
                oneOf:
                  - title: Success
                    type: object
                    properties:
                      status:
                        type: integer
                        example: 200
                      title:
                        type: string
                        example: OK
                      description:
                        type: string
                        example: Successful request
                      payload:
                        type: object
                        properties:
                          metadata:
                            type: object
                            properties:
                              next:
                                type: string
                                example: >-
                                  https://api.amberdata.com/markets/spot/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA
                              api-version:
                                type: string
                                example: '2023-09-30'
                          data:
                            type: array
                            items:
                              type: object
                              properties:
                                exchange:
                                  type: string
                                  example: arkham
                                instrument:
                                  type: string
                                  example: ada_usdt
                                baseSymbol:
                                  type: string
                                  example: ada
                                quoteSymbol:
                                  type: string
                                  example: usdt
                                market:
                                  type: string
                                  example: spot
                                exchangeEnabled:
                                  type: boolean
                                  example: true
                                limitsPriceMin:
                                  type: number
                                  example: 0.0001
                                limitsPriceMax:
                                  type: number
                                  example: 1000
                                limitsVolumeMin:
                                  type: number
                                  example: 0.1
                                limitsVolumeMax:
                                  type: number
                                  example: 900000
                                limitsMarketMin:
                                  type: number
                                  nullable: true
                                  example: null
                                limitsMarketMax:
                                  type: number
                                  nullable: true
                                  example: null
                                limitsLeverageMin:
                                  type: number
                                  nullable: true
                                  example: null
                                limitsLeverageMax:
                                  type: number
                                  example: 0
                                limitsLeverageSuperMax:
                                  type: number
                                  nullable: true
                                  example: null
                                limitsCostMin:
                                  type: number
                                  example: 5
                                limitsCostMax:
                                  type: number
                                  nullable: true
                                  example: null
                                precisionPrice:
                                  type: number
                                  example: 0.0001
                                precisionVolume:
                                  type: number
                                  example: 0.1
                                precisionBase:
                                  type: number
                                  nullable: true
                                  example: null
                                precisionQuote:
                                  type: number
                                  nullable: true
                                  example: null
                                listingTimestamp:
                                  type: string
                                  nullable: true
                                  example: null
      deprecated: false
  /spot/order-book-snapshots/information:
    get:
      summary: Information
      description: >-
        Provides availability details for Spot market order book snapshots
        across supported exchanges, including trading pairs, data coverage start
        and end times, and exchange-specific information.
      operationId: spot-order-book-information
      parameters:
        - name: exchange
          in: query
          description: >-
            The exchange(s) for which to retrieve spot order book data. Example:
            exchange=bitfinex,bitstamp
          schema:
            type: string
            default: bitfinex
        - name: instrument
          in: query
          description: Only return data for the given pair.
          schema:
            type: string
        - name: includeInactive
          in: query
          description: >-
            **[Optional]** If `true`, endpoint returns all instruments,
            including delisted ones.
          schema:
            type: boolean
            default: false
        - name: timeFormat
          in: query
          description: '**[Optional]** Time format of the timestamps in the return payload.'
          schema:
            type: string
            enum:
              - milliseconds
              - ms*
              - iso
              - iso8601
              - hr
              - human_readable
            default: hr
        - name: Accept-Encoding
          in: header
          required: true
          description: ''
          schema:
            type: string
            default: gzip, deflate, br
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      metadata:
                        next: >-
                          https://api.amberdata.com/markets/spot/order-book-snapshots/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA
                        api-version: '2023-09-30'
                      data:
                        - address: '0x111111111117dc0aa78b770fa6a738034120c302'
                          exchange: binance
                          instrument: 1inch_btc
                          startDate: 1608872640000
                          endDate: 1717599240000
                        - address: '0x111111111117dc0aa78b770fa6a738034120c302'
                          exchange: binance
                          instrument: 1inch_usdt
                          startDate: 1608872640000
                          endDate: 1717598940000
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  title:
                    type: string
                  description:
                    type: string
                  payload:
                    type: object
                    properties:
                      metadata:
                        type: object
                        properties:
                          next:
                            type: string
                          api-version:
                            type: string
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            address:
                              type: string
                            exchange:
                              type: string
                            instrument:
                              type: string
                            startDate:
                              type: integer
                            endDate:
                              type: integer
      deprecated: false
      security:
        - ApiKeyAuth: []
  /spot/order-book-snapshots/{instrument}:
    get:
      summary: Snapshots Historical
      description: >-
        Delivers historical order book snapshots for specified Spot market
        trading pairs, including detailed bid and ask levels, volume, and order
        count per price level, along with timestamps to track market depth over
        time.
      operationId: spot-order-book-snapshots
      parameters:
        - name: instrument
          in: path
          description: The spot instrument for which data will be retrieved.
          schema:
            type: string
            default: eth_usd
          required: true
        - name: exchange
          in: query
          description: >-
            The exchange for which data should be retrieved. Only **1** exchange
            is allowed.
          required: true
          schema:
            type: string
            default: bitfinex
        - name: startDate
          in: query
          description: >-
            **[Optional]** Payload only includes data after this date
            (inclusive).  **[Formats]** `seconds | milliseconds | iso8601`
            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
        - name: endDate
          in: query
          description: >-
            **[Optional]** Payload only includes data before this date
            (exclusive).  **[Formats]** `seconds | milliseconds | iso8601`
            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
        - name: maxLevel
          in: query
          description: >-
            The number of order book levels that should be returned. By default,
            returns max available levels.
          schema:
            type: integer
            format: int32
        - name: timestamp
          in: query
          description: >-
            Filter for order book data that is less or equal to this specified
            timestamp.
          schema:
            type: string
        - name: timeFormat
          in: query
          description: '**[Optional]** Time format of the timestamps in the response.'
          schema:
            type: string
            enum:
              - milliseconds
              - ms*
              - iso
              - iso8601
              - hr
              - human_readable
            default: hr
        - name: sortDirection
          in: query
          description: >-
            **[Optional]** Specifies the direction in which the data is sorted
            (by timestamp).   **[Defaults]** asc (ascending order).   **[Usage
            Conditions]** This parameter can only be used if the `startDate` and
            `endDate` timeframe is within the most recent 24 hours, or if the
            `startDate` and `endDate` parameters are not used at all.  
            **[Examples]** ascending | descending | asc | desc
          schema:
            type: string
        - name: Accept-Encoding
          in: header
          required: true
          description: ''
          schema:
            type: string
            default: gzip, deflate, br
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      metadata:
                        requestedStartDate: 1717513062160
                        requestedEndDate: 1717599462160
                        returnedStartDate: 1717513080000
                        returnedEndDate: 1717515360000
                        next: >-
                          https://api.amberdata.com/markets/spot/order-book-snapshots/eth_usd?cursor=N4IgxgrgTgzg9lEAuAdhANugNCGAXAQyjwBEC8BTZARgHY6BWahgZgDYAGLjnClAEzKUa9WgwCc4gCxsATNU448ASwC2FAGIJV5ZCFXLMymBTBwBMEErUUAkikpQAbgXTJQKAur0BPCkUscGABHdAA5LyokED8iK1xQiPUABXRoV19-KHQfeP4KADMCDDxkAA42KW4uHB0AD2Q2FlkpKTLqnhB0ODgAawAjAjBe5IooZTh%2BZDRMAF8cAu1daIAreBR4ijqwAAsCFABzKJB%2B5TwC5RQt%2BJV1fC8AB2mMbH0COoAZCicKN1QXoIIPAAaQouWidEYzHY1QA%2BhxYadzpctvDYXgoBAKLCKHgdrCIDAprMgA
                        api-version: '2023-09-30'
                      data:
                        - exchange: bitfinex
                          instrument: eth_usd
                          timestamp: 1717513080000
                          sequence: null
                          ask:
                            - price: 3780.7
                              volume: 7.33
                              numOrders: 1
                            - price: 3780.8
                              volume: 11.60410568
                              numOrders: 1
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  title:
                    type: string
                  description:
                    type: string
                  payload:
                    type: object
                    properties:
                      metadata:
                        type: object
                        properties:
                          requestedStartDate:
                            type: integer
                          requestedEndDate:
                            type: integer
                          returnedStartDate:
                            type: integer
                          returnedEndDate:
                            type: integer
                          next:
                            type: string
                          api-version:
                            type: string
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            exchange:
                              type: string
                            instrument:
                              type: string
                            timestamp:
                              type: integer
                            sequence:
                              type: string
                            ask:
                              type: array
                              items:
                                type: object
                                properties:
                                  price:
                                    type: number
                                  volume:
                                    type: number
                                  numOrders:
                                    type: integer
      deprecated: false
      security:
        - ApiKeyAuth: []
  /spot/order-book-events/{instrument}:
    get:
      summary: Events/Updates Historical
      description: >-
        Provides historical updates to Spot market order books, capturing
        real-time changes in bid and ask levels, volumes, and order counts for
        specified trading pairs, with precise timestamps for event sequencing
        and tracking market activity.
      operationId: spot-order-book-events
      parameters:
        - name: instrument
          in: path
          description: The spot instrument for which data will be retrieved.
          schema:
            type: string
            default: btc_usd
          required: true
        - name: exchange
          in: query
          description: >-
            The exchange for which data should be retrieved. Only **1** exchange
            is allowed.
          required: true
          schema:
            type: string
            default: gdax
        - name: startDate
          in: query
          description: >-
            **[Optional]** Payload only includes data after this date
            (inclusive).  **[Formats]** `seconds | milliseconds | iso8601`
            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
            format: date-time
            default: '2024-03-01T00:00:00'
        - name: endDate
          in: query
          description: >-
            **[Optional]** Payload only includes data before this date
            (exclusive).  **[Formats]** `seconds | milliseconds | iso8601`
            **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00`
          schema:
            type: string
            format: date-time
            default: '2024-03-01T01:00:00'
        - name: timeFormat
          in: query
          description: '**[Optional]** Time format of the timestamps in the response.'
          schema:
            type: string
            enum:
              - milliseconds
              - ms*
              - iso
              - iso8601
              - hr
              - human_readable
            default: hr
        - name: sortDirection
          in: query
          description: >-
            **[Optional]** Specifies the direction in which the data is sorted
            (by timestamp).   **[Defaults]** asc (ascending order).   **[Usage
            Conditions]** This parameter can only be used if the `startDate` and
            `endDate` timeframe is within the most recent 24 hours, or if the
            `startDate` and `endDate` parameters are not used at all.  
            **[Examples]** ascending | descending | asc | desc
          schema:
            type: string
        - name: Accept-Encoding
          in: header
          required: true
          description: ''
          schema:
            type: string
            default: gzip, deflate, br
        - name: api-version
          in: header
          schema:
            type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    status: 200
                    title: OK
                    description: Successful request
                    payload:
                      metadata:
                        requestedStartDate: 2024-03-01 00:00:00 000
                        returnedStartDate: 2024-03-01 00:00:00 005
                        returnedEndDate: 2024-03-01 00:00:42 218
                        next: >-
                          https://api.amberdata.com/markets/spot/order-book-events/btc_usd?cursor=N4IgxgrgTgzg9lEAuAdhANugNCGAXAQyjwBEC8BTZARgHYAGATgCYBWa5gFmeeoA4cFFABMylGgxatOfenLk48ASwC2FAGIIV5ZCAAWEbSgBKFAsIIAjdFUWqKASRSUoANwLpkoFATW6AnmawIDgwAI7oAHK%2BVEgggUQhuBHRagAK6NAeAUHo-knCFABmBBh4yHwAbJzyCiDaAB7IlQDMXDK19DjocHAA1pYEYH1pFFBKcMLIaJgAvjhFWjpxAFbwKEkUDWB6BCgA5rEg%2BxZNOEooYJmFAKooMBAADo8IlMIAotu7BxQwyCXoGAUUKEYjRFBwIFgOAiP5IRjyboEfAAcSgcCeXhAF3wUEMQnKcUseDAAH0IDApoIvntDroTgQziAtjtaRQACr2fC%2BR66Zj0LgAWnoLWF1AABHIkFLuOLeHxNjSfpy1NyVI9wZCKNDYcgEXUgWEIEIwEdOLQ%2BMxKsxaC1aPLLYwksi%2BsgANqgR7jU3NDjURgAOk4rBwrjgmT80pwaBUAHkoIVgqgMOhZgBdHCWJRTJButOzWZAA
                        api-version: '2023-09-30'
                      data:
                        - instrument: btc_usd
                          exchange: gdax
                          exchangeTimestamp: 2024-03-01 00:00:00 005
                          exchangeTimestampNanoseconds: 174000
                          sequence: '478262695005780'
                          ask: []
                          bid:
                            - price: 61141.86
                              volume: 0
                              numOrders: null
                        - instrument: btc_usd
                          exchange: gdax
                          exchangeTimestamp: 2024-03-01 00:00:00 005
                          exchangeTimestampNanoseconds: 174000
                          sequence: '478262695005781'
                          ask: []
                          bid:
                            - price: 61099.03
                              volume: 0
                              numOr

# --- truncated at 32 KB (339 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amberdata/refs/heads/main/openapi/amberdata-market-openapi.yaml