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 numOrders: null schema: type: object properties: status: type: integer title: type: string description: type: string payload: type: object properties: metadata: type: object properties: requestedStartDate: type: string returnedStartDate: type: string returnedEndDate: type: string next: type: string api-version: type: string data: type: array items: type: object properties: instrument: type: string exchange: type: string exchangeTimestamp: type: string exchangeTimestampNanoseconds: type: integer sequence: type: string ask: type: array items: {} bid: type: array items: type: object properties: price: type: number volume: type: integer numOrders: type: string deprecated: false security: - ApiKeyAuth: [] /spot/tickers/information: get: summary: Information description: >- Provides availability details for Spot market ticker data across supported exchanges, including trading pairs, data coverage start and end times, and exchange-specific information. operationId: spot-tickers-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. schema: type: boolean default: false - 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: 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/tickers/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - address: null exchange: binance instrument: 1000sats_fdusd startDate: 1702385053515 endDate: 1717601626948 - address: null exchange: binance instrument: 1000sats_try startDate: 1702385044487 endDate: 1717601697342 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/tickers/{instrument}: get: summary: Historical description: >- Delivers historical ticker data for Spot market trading pairs, providing bid, ask, mid, and last prices, along with respective volumes, timestamps, and sequencing for tracking market price changes over time. operationId: spot-tickers-historical parameters: - name: instrument in: path description: The spot instrument for which data will be retrieved. schema: type: string default: eth_usdt 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: binance - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - 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: 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: next: >- https://api.amberdata.com/markets/spot/tickers/eth_usdt?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKyCxYgMwAOAJwAWWcTAIAJr37oRIgGwAGQfIBMJ6YeK4ojUurABVBJVIAHV7X7qAotHjIwSnQAMzhGSjBiNmwAWzAAMVoYvnQQGOxmbAioag0g4mCklIwAKxoEEFZPAGkwAE9U3WEJKTklWQB9QVlBA0VpDpw8BAIO6WkReVFBQz0OsDYYDtJKdTYQAF8gA api-version: '2023-09-30' data: - instrument: eth_usdt exchange: binance exchangeTimestamp: 1717515522361 exchangeTimestampNanoseconds: 21307 bid: 3797.2 ask: 3797.21 mid: 3797.205 last: null bidVolume: 38.2898 askVolume: 13.422 sequence: '33179708313' askTimestamp: null bidTimestamp: null askTimestampNanoseconds: null bidTimestampNanoseconds: null - instrument: eth_usdt exchange: binance exchangeTimestamp: 1717515522361 exchangeTimestampNanoseconds: 169012 bid: 3797.2 ask: 3797.21 mid: 3797.205 last: null bidVolume: 38.2898 askVolume: 11.8419 sequence: '33179708314' askTimestamp: null bidTimestamp: null askTimestampNanoseconds: null bidTimestampNanoseconds: null 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer bid: type: number ask: type: number mid: type: number last: type: string bidVolume: type: number askVolume: type: number sequence: type: string askTimestamp: type: number bidTimestamp: type: number askTimestampNanoseconds: type: number bidTimestampNanoseconds: type: number deprecated: false security: - ApiKeyAuth: [] /spot/trades/information: get: summary: Information description: >- Provides availability details for Spot market trade data across supported exchanges, including trading pairs, data coverage start and end times, and exchange-specific information. operationId: spot-trades-information 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: includeInactive in: query description: >- **[Optional]** If true, endpoint returns all instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - 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: 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/trades/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - address: null exchange: binance instrument: 1000sats_fdusd startDate: 1702382541331 endDate: 1717601579073 - address: null exchange: binance instrument: 1000sats_try startDate: 1702382540945 endDate: 1717601690698 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/trades/{instrument}: get: summary: Historical description: >- Provides historical trade data for Spot market trading pairs, detailing individual trade prices, volumes, buy/sell indicators, and timestamps to track transaction activity over time on supported exchanges. operationId: spot-trades-historical parameters: - 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: '2023-01-20T00: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: '2023-01-20T00:10:00' - name: instrument in: path description: The spot instrument for which data will be retrieved. schema: type: string default: eth_usd required: true - 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: 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: next: null api-version: '2023-09-30' data: - instrument: eth_usd exchange: gdax exchangeTimestamp: 1674172800137 exchangeTimestampNanoseconds: 927000 isBuySide: true price: 1550.96 volume: 0.19342803 tradeId: '414516225' sequence: null quoteVolume: null - instrument: eth_usd exchange: gdax exchangeTimestamp: 1674172800137 exchangeTimestampNanoseconds: 927000 isBuySide: true price: 1550.96 volume: 0.2347599 tradeId: '414516226' sequence: null quoteVolume: null 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer isBuySide: type: boolean price: type: number volume: type: number tradeId: type: string sequence: type: string quoteVolume: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /spot/ohlcv/information: get: summary: Information description: >- Provides availability details for Spot market OHLCV (Open, High, Low, Close, Volume) data across supported exchanges, including trading pairs and data coverage periods. operationId: get-market-ohlc-information parameters: - name: exchange in: query description: >- **[Optional]** Only return data for the specified 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxplJAAxbkzw%2ByU-GDBKKA4IBFMQYn70QZAAK3JJwNZ0KSIoszAALwJCAFZU9qA api-version: '2023-09-30' data: - address: null exchange: binance instrument: 1000sats_fdusd startDate: 1702339200000 endDate: 1721520000000 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/spot/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxplJAAxbkzw%2ByU-GDBKKA4IBFMQYn70QZAAK3JJwNZ0KSIoszAALwJCAFZU9qA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: address: {} exchange: type: string example: binance instrument: type: string example: 1000sats_fdusd startDate: type: integer example: 1702339200000 default: 0 endDate: type: integer example: 1721520000000 default: 0 deprecated: false /spot/ohlcv/{instrument}: get: summary: Historical description: >- Provides historical OHLCV (Open, High, Low, Close, Volume) data for Spot market trading pairs, enabling analysis of price movements and trading volumes over time across supported exchanges. operationId: get-historical-ohlc parameters: - name: instrument in: path description: The market pair for which to retrieve open-high-low-close. schema: type: string default: eth_usd required: true - name: exchange in: query description: >- The exchange(s) for which to retrieve OHLCV. Example: exchange=bitfinex,bitstamp 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 format: date-time - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: >- https://api.amberdata.com/markets/spot/ohlcv/btc_usd?cursor=N4IgpgHgxgFghgOwOZhALhEgJnCIA0IUArgE4DOA9qegsQDb2HkAucpLAInC6mgIwA2AJwB2ABwAWQZIAM8%2BYTAIs3Xun6iATJoCss0dq37CLAJYBbMAEkEvUgDc49dKARwr6EDgCe5AiDkAI70AHIefN5wPgHBYREACvRkzl44ZvQxhFhgAGZwDCzoAMxCWlpyCrKEFrjogsUVkuJV1SD0lJQA1gBGcFBdCWCkZpRY6FqyAL6EZghQyTkAqgjkxAAO69S8WACi0PDIYP5o%2BfTkYKaWYABi1LVFGBYZ9GYXUJQq-oS59zxeACsqAgAvQ4KwAOKkSgbVyYHB4NCgcxWVgedYaEQSaSVBRXVFsCzrcIISjvT5YE5tOY5RHTKZTIA api-version: '2023-09-30' data: - instrument: btc_usd exchange: gdax exchangeTimestamp: 1690156800000 open: 30081.61 high: 30099.99 low: 28850 close: 29176.98 volume: 14484.27543962 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/spot/ohlcv/btc_usd?cursor=N4IgpgHgxgFghgOwOZhALhEgJnCIA0IUArgE4DOA9qegsQDb2HkAucpLAInC6mgIwA2AJwB2ABwAWQZIAM8%2BYTAIs3Xun6iATJoCss0dq37CLAJYBbMAEkEvUgDc49dKARwr6EDgCe5AiDkAI70AHIefN5wPgHBYREACvRkzl44ZvQxhFhgAGZwDCzoAMxCWlpyCrKEFrjogsUVkuJV1SD0lJQA1gBGcFBdCWCkZpRY6FqyAL6EZghQyTkAqgjkxAAO69S8WACi0PDIYP5o%2BfTkYKaWYABi1LVFGBYZ9GYXUJQq-oS59zxeACsqAgAvQ4KwAOKkSgbVyYHB4NCgcxWVgedYaEQSaSVBRXVFsCzrcIISjvT5YE5tOY5RHTKZTIA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: btc_usd exchange: type: string example: gdax exchangeTimestamp: type: integer example: 1690156800000 default: 0 open: type: number example: 30081.61 default: 0 high: type: number example: 30099.99 default: 0 low: type: integer example: 28850 default: 0 close: type: number example: 29176.98 default: 0 volume: type: number example: 14484.27543962 default: 0 deprecated: false /spot/batch-ohlcv/{exchange}: get: summary: Batch Historical description: >- Delivers historical OHLCV (Open, High, Low, Close, Volume) data in batch format for multiple Spot market trading pairs, providing comprehensive price and volume history over specified time ranges for efficient analysis across multiple assets. operationId: batch-historical-ond parameters: - name: exchange in: path description: The exchange for which to retrieve OHLCV schema: type: string default: binance required: true - name: instruments in: query description: >- **[Required]** The pair(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 pairs required: true schema: type: string default: btc_usdt,eth_usdt - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: btc_usdt exchangeTimestamp: 1735948800000 open: 98174.17 high: 98778.43 low: 97514.79 close: 98220.5 volume: 8990.05651 - instrument: eth_usdt exchangeTimestamp: 1735948800000 open: 3609 high: 3671.6 low: 3572.42 close: 3656.88 volume: 229266.3133 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: instrument: type: string exchangeTimestamp: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: number deprecated: false security: - ApiKeyAuth: [] /spot/reference-rates/{assetId}: get: summary: Hourly & Daily Reference Rates description: >- Retrieve the historical (time series) hourly and daily reference rates for a specific asset. operationId: spot-reference-rates-historical parameters: - name: assetId in: path description: The id of the asset for which reference rates are needed. schema: type: string enum: - btc - eth default: btc required: true - 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 - 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 - 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: timeInterval in: query description: Specify the granularity of the desired reference rate. schema: type: string enum: - hours - days default: hours - name: dailyTime in: query description: >- Use with `timeInterval=days`. Filter for the asset's daily reference rate at 16:00 hours for a specific timezone. **[Examples]** `dailyTime=T16:00+08:00` is 16:00 Singapore & Hong Kong schema: type: string enum: - T16:00-05:00 - T16:00-04:00 - T16:00+00:00 - T16:00+01:00 - T16:00+04:00 - T16:00+08:00 - T16:00+09:00 - name: direction in: query description: >- The order in which to return the results (ascending or descending). By default, records are returned in descending order, so the most recent records are returned first. schema: type: string enum: - desc - asc - 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: timeInterval: hours api-version: '2023-09-30' data: assetARCID: eth assetSymbol: eth assetName: Ether currency: usd referenceRates: - timestamp: 2023-11-05 18:00:00 000 unitPrice: 1896.2722539256226 - timestamp: 2023-11-05 19:00:00 000 unitPrice: 1892.070741279808 - timestamp: 2023-11-05 20:00:00 000 unitPrice: 1888.6184732343843 - timestamp: 2023-11-05 21:00:00 000 unitPrice: 1870.1300714429476 - timestamp: 2023-11-05 22:00:00 000 unitPrice: 1881.8808731384033 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: timeInterval: type: string example: hours api-version: type: string example: '2023-09-30' data: type: object properties: assetARCID: type: string example: eth assetSymbol: type: string example: eth assetName: type: string example: Ether currency: type: string example: usd referenceRates: type: array items: type: object properties: timestamp: type: string example: 2023-11-05 18:00:00 000 unitPrice: type: number example: 1896.2722539256226 default: 0 deprecated: false security: - ApiKeyAuth: [] /options/exchanges/information: get: summary: Instruments description: >- Provides metadata for available options contracts on supported exchanges, including exchange names, contract symbols, and data types (Order Book Events, Ticker, Trades, etc.) with associated data coverage periods. operationId: options-exchanges-pairs parameters: - name: exchange in: query description: >- **[Optional]** Only return data for the given exchange(s) (comma separated) schema: type: string default: deribit - 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. **[Defaults]** `True | False*`. schema: type: boolean - 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: size in: query description: >- **[Optional]** The number of records per page (only available when `includeInactive=true`). schema: type: integer format: int32 - 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/options/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-16AUG24-50000-C openInterest: startDate: 1721895646123 endDate: 1722297559023 orderBookSnapshot: startDate: 1721895180679 endDate: 1722370735780 orderBookEvent: startDate: 1721899231080 endDate: 1721946070781 ticker: startDate: 1721895381123 endDate: 1722370799223 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: bybit instrument: type: string example: BTC-16AUG24-50000-C openInterest: type: object properties: startDate: type: integer example: 1721895646123 default: 0 endDate: type: integer example: 1722297559023 default: 0 orderBookSnapshot: type: object properties: startDate: type: integer example: 1721895180679 default: 0 endDate: type: integer example: 1722370735780 default: 0 orderBookEvent: type: object properties: startDate: type: integer example: 1721899231080 default: 0 endDate: type: integer example: 1721946070781 default: 0 ticker: type: object properties: startDate: type: integer example: 1721895381123 default: 0 endDate: type: integer example: 1722370799223 default: 0 deprecated: false /options/exchanges/reference: get: summary: Reference description: >- Provides essential reference details for options contracts on supported exchanges, including contract symbols, underlying assets, strike prices, expiration dates, settlement types, price and volume limits, and precision requirements. operationId: options-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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - name: size in: query description: >- **[Optional]** The number of records per page (only available when `includeInactive=true`). schema: type: integer format: int32 - name: startDate in: query description: >- **[Optional]** Payload only includes instruments which have expiration after this date (inclusive). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes instruments which have expiration before this date (exclusive). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: includeOriginalReference in: query description: >- **[Optional]** If true, endpoint returns originalReference. **[Defaults]** `True | False*`. schema: type: boolean - 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: 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/options/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-16AUG24-50000-C baseSymbol: BTC quoteSymbol: USDC market: options exchangeEnabled: true limitsPriceMin: 5 limitsPriceMax: 10000000 limitsVolumeMin: null limitsVolumeMax: null limitsMarketMin: 0.01 limitsMarketMax: 500 limitsLeverageMin: null limitsLeverageMax: null limitsLeverageSuperMax: null limitsCostMin: null limitsCostMax: null precisionPrice: 5 precisionVolume: 0.01 precisionBase: null precisionQuote: null listingTimestamp: 1721894400000 contractUnderlying: BTC contractExpirationTimestamp: 1723795200000 contractPeriod: weekly contractSize: null contractSettleType: option contractSettleSymbol: USDC optionType: call optionStrikePrice: 50000 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: bybit instrument: type: string example: BTC-16AUG24-50000-C baseSymbol: type: string example: BTC quoteSymbol: type: string example: USDC market: type: string example: options exchangeEnabled: type: boolean example: true default: true limitsPriceMin: type: integer example: 5 default: 0 limitsPriceMax: type: integer example: 10000000 default: 0 limitsVolumeMin: {} limitsVolumeMax: {} limitsMarketMin: type: number example: 0.01 default: 0 limitsMarketMax: type: integer example: 500 default: 0 limitsLeverageMin: {} limitsLeverageMax: {} limitsLeverageSuperMax: {} limitsCostMin: {} limitsCostMax: {} precisionPrice: type: integer example: 5 default: 0 precisionVolume: type: number example: 0.01 default: 0 precisionBase: {} precisionQuote: {} listingTimestamp: type: integer example: 1721894400000 default: 0 contractUnderlying: type: string example: BTC contractExpirationTimestamp: type: integer example: 1723795200000 default: 0 contractPeriod: type: string example: weekly contractSize: {} contractSettleType: type: string example: option contractSettleSymbol: type: string example: USDC optionType: type: string example: call optionStrikePrice: type: integer example: 50000 default: 0 deprecated: false /options/liquidations/information: get: summary: Information description: >- Provides availability details for options contract liquidation data across supported exchanges, including contract symbols, underlying assets, and data coverage periods for tracking liquidation events. operationId: options-liquidations-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `false* | true` schema: type: boolean - 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: 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/options/liquidations/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: deribit instrument: BTC-10JUL24-55500-P underlying: BTC startDate: 1720581871000 endDate: 1720581871000 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/liquidations/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: deribit instrument: type: string example: BTC-10JUL24-55500-P underlying: type: string example: BTC startDate: type: integer example: 1720581871000 default: 0 endDate: type: integer example: 1720581871000 default: 0 deprecated: false /options/liquidations/{instrument}: get: summary: Historical description: >- Provides historical liquidation data for options contracts, detailing liquidation actions, prices, volumes, mark and index prices, and buy/sell sides to track liquidation events over time across supported exchanges. operationId: options-liquidations-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- The exchange(s) for which to retrieve the requested data (comma separated). **[Defaults]** All available exchanges. required: true schema: type: string default: deribit - 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: '1691321498000' - 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 - 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: null api-version: '2023-09-30' data: - instrument: BTC-29DEC23-30000-C exchange: deribit exchangeTimestamp: 1691321498000 exchangeTimestampNanoseconds: 0 action: null orderId: '262149185' side: BUY status: null timeInForce: null type: null price: 0.0935 volume: 2 unit: base_asset tickDirection: 2 markPrice: 0.09432956 indexPrice: 29033.78 schema: oneOf: - title: Success 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: {} api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-29DEC23-30000-C exchange: type: string example: deribit exchangeTimestamp: type: integer example: 1691321498000 default: 0 exchangeTimestampNanoseconds: type: integer example: 0 default: 0 action: {} orderId: type: string example: '262149185' side: type: string example: BUY status: {} timeInForce: {} type: {} price: type: number example: 0.0935 default: 0 volume: type: integer example: 2 default: 0 unit: type: string example: base_asset tickDirection: type: integer example: 2 default: 0 markPrice: type: number example: 0.09432956 default: 0 indexPrice: type: number example: 29033.78 default: 0 deprecated: false /options/ohlcv/information: get: summary: Information description: >- Provides availability details for OHLCV (Open, High, Low, Close, Volume) data on options contracts across supported exchanges, including contract symbols, underlying assets, and data coverage periods. operationId: options-ohlcv-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes* | hours | days` 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: 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/options/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxokYXokKw4IABUvZBaSMkoaZSQAMW5M8PslPxgwSigBhFMQYnn0RZAAK3IBwNZ0KSIoszAALwJCAFZU9qA api-version: '2023-09-30' data: - exchange: deribit instrument: BTC-24JUL24-59000-C underlying: BTC startDate: null endDate: null schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxokYXokKw4IABUvZBaSMkoaZSQAMW5M8PslPxgwSigBhFMQYnn0RZAAK3IBwNZ0KSIoszAALwJCAFZU9qA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: deribit instrument: type: string example: BTC-24JUL24-59000-C underlying: type: string example: BTC startDate: {} endDate: {} deprecated: false /options/ohlcv/{instrument}: get: summary: Historical description: >- Provides historical OHLCV (Open, High, Low, Close, Volume) data for options contracts, enabling analysis of price movements and trading volumes over time for specific contracts across supported exchanges. operationId: options-ohlcv-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: '**[Default]** All available exchanges.' required: true schema: type: string default: deribit - 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 - 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 - name: timeInterval in: query description: >- Time interval to return the historical data in ("days" | "hours" | "minutes") 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: >- https://api.amberdata.com/markets/options/ohlcv/BTC-29DEC23-30000-C?cursor=N4IgpgHgxgFghgOwOZhALhAEzAJwJYBGeALiADQhQCuOAzgPY7oJUA2rFtxcOxAInGKo0ARgBsATgDsADikBWAEwAGVaopgEmAUPQipi-fIAsYmTMNiKxPAFswASQRCcANzit0oBHHvoscACetOQgtACOrAByvsIBgaER0bEACqw0Hv6YcHisCRTYAGZwbKRoAMziiorGauogtnAQ6GLlNcYydcoUrPT0ANYEcFD9Kbh49JjoKgC%2BFHgIUOnYAKoItFQADpuMQpgAotDwyGAhaMWstGDWdmAAYoyNZQ25rHhXUPRaIRSFj4L%2BABWDAQoVYcC4AHEcPQtl4sOMiGVQDZ7FxfJs9JJZAoVHUbmjuLZNjEEPQPl9MGduiAFthmmhlDNmUA api-version: '2023-09-30' data: - instrument: BTC-29DEC23-30000-C exchange: deribit exchangeTimestamp: 1690185600000 open: 0.128 high: 0.128 low: 0.1145 close: 0.1155 volume: 28.5 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/ohlcv/BTC-29DEC23-30000-C?cursor=N4IgpgHgxgFghgOwOZhALhAEzAJwJYBGeALiADQhQCuOAzgPY7oJUA2rFtxcOxAInGKo0ARgBsATgDsADikBWAEwAGVaopgEmAUPQipi-fIAsYmTMNiKxPAFswASQRCcANzit0oBHHvoscACetOQgtACOrAByvsIBgaER0bEACqw0Hv6YcHisCRTYAGZwbKRoAMziiorGauogtnAQ6GLlNcYydcoUrPT0ANYEcFD9Kbh49JjoKgC%2BFHgIUOnYAKoItFQADpuMQpgAotDwyGAhaMWstGDWdmAAYoyNZQ25rHhXUPRaIRSFj4L%2BABWDAQoVYcC4AHEcPQtl4sOMiGVQDZ7FxfJs9JJZAoVHUbmjuLZNjEEPQPl9MGduiAFthmmhlDNmUA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-29DEC23-30000-C exchange: type: string example: deribit exchangeTimestamp: type: integer example: 1690185600000 default: 0 open: type: number example: 0.128 default: 0 high: type: number example: 0.128 default: 0 low: type: number example: 0.1145 default: 0 close: type: number example: 0.1155 default: 0 volume: type: number example: 28.5 default: 0 deprecated: false /options/batch-ohlcv/{exchange}: get: summary: Batch Historical description: >- Delivers historical OHLCV (Open, High, Low, Close, Volume) data in batch format for multiple Options market contracts, providing comprehensive price and volume history over specified time ranges for efficient analysis across multiple instruments. operationId: batch-historical-ond-1 parameters: - name: exchange in: path description: The exchange for which to retrieve the most current data. schema: type: string default: deribit required: true - name: instruments in: query description: >- **[Required]** The instrument(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 instruments required: true schema: type: string default: BTC-29DEC23-30000-C - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: BTC-14MAR25-105000-C exchangeTimestamp: 1740009600000 open: 0.019 high: 0.022 low: 0.0185 close: 0.02 volume: 40.3 - instrument: BTC-14MAR25-105000-C exchangeTimestamp: 1740096000000 open: 0.019 high: 0.022 low: 0.0115 close: 0.014 volume: 25.5 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: instrument: type: string exchangeTimestamp: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /options/open-interest/information: get: summary: Information description: >- Provides availability details for open interest data on options contracts, including contract symbols, underlying assets, and data coverage periods across supported exchanges. operationId: options-open-interest-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - 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: 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/options/open-interest/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-24JUL24-62000-C underlying: BTC startDate: 1721550049114 endDate: 1721722822415 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/open-interest/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: bybit instrument: type: string example: BTC-24JUL24-62000-C underlying: type: string example: BTC startDate: type: integer example: 1721550049114 default: 0 endDate: type: integer example: 1721722822415 default: 0 deprecated: false /options/open-interest/{instrument}: get: summary: Historical description: >- Provides historical open interest data for options contracts, detailing the total number of outstanding contracts at specific timestamps to help assess market interest over time across supported exchanges. operationId: options-open-interest-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the requested data (comma separated). **[Defaults]** All available exchanges. required: true schema: type: string default: deribit - 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: '1690156800000' - 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: '1690160400000' - 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: null api-version: '2023-09-30' data: - instrument: BTC-29DEC23-30000-C exchange: deribit exchangeTimestamp: 1690156800895 exchangeTimestampNanoseconds: 0 value: 2603.5 type: null schema: oneOf: - title: Success 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: {} api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-29DEC23-30000-C exchange: type: string example: deribit exchangeTimestamp: type: integer example: 1690156800895 default: 0 exchangeTimestampNanoseconds: type: integer example: 0 default: 0 value: type: number example: 2603.5 default: 0 type: {} deprecated: false /options/batch-open-interest/{exchange}: get: summary: Batch Historical description: >- Delivers batch historical open interest data for multiple options contracts, providing timestamped values that reflect the total number of outstanding contracts over specified time ranges across supported exchanges. operationId: batch-historical-ent-2 parameters: - name: exchange in: path description: The exchange for which to retrieve the most current data. schema: type: string default: deribit required: true - name: instruments in: query description: >- **[Required]** The instrument(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 instruments required: true schema: type: string default: BTC-29DEC23-30000-C - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `ticks | minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: BTC-14MAR25-100000-C exchangeTimestamp: 1740009600000 value: 4.7 type: null - instrument: BTC-14MAR25-100000-C exchangeTimestamp: 1740096000000 value: 7.9 type: null 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: instrument: type: string exchangeTimestamp: type: integer value: type: number type: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /options/order-book-events/information: get: summary: Events Information description: >- Provides availability details for options order book events, including contract symbols, underlying assets, and data coverage periods across supported exchanges to track order book activity over time. operationId: options-order-book-events-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `false* | true` schema: type: boolean - 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: 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/options/order-book-events/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-18SEP24-53000-C underlying: BTC startDate: 1726446949183 endDate: 1726611867867 - exchange: bybit instrument: BTC-18SEP24-53000-P underlying: BTC startDate: 1726446941517 endDate: 1726611898406 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: exchange: type: string instrument: type: string underlying: type: string startDate: type: integer endDate: type: integer deprecated: false security: - ApiKeyAuth: [] /options/order-book-events/{instrument}: get: summary: Events Historical description: >- Provides historical order book events for options contracts, detailing bid and ask levels, volumes, and order counts at specific timestamps to track market depth and activity over time across supported exchanges. operationId: options-order-book-events-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- The exchange(s) for which to retrieve the requested data (comma separated). **[Default]** All available exchanges. required: true schema: type: string - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). schema: type: string format: date-time - 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: >- https://api.amberdata.com/markets/options/order-book-events/BTC-18SEP24-60000-C?cursor=N4IgpgHgxgFghgOwOZhALhAIwJ6YJYAuIANCFAK4BOAzgPaXoLkA2zp1BclBAInAajQBGAOwAmAGwBWAMySAnEPnyppMAgAmfAelGSJQsVIAcU%2BTIAspPAijNyGsAFUE1cgAd39ARoCi0eGQwanQAMzhmajBSAjwAWzAAMXo4-nQQOLxWPCioWk0Q0lCUtIwAKzoEEhA6bgBpMGx0vWk5CUVlKQB9AAYunHwCLoV5CzF5CRl5MS6AIQAVAGEAWiFjAGVfAAUxC2WJHsOe5cWusDAJOGMZUNCQAF8gA api-version: '2023-09-30' data: - instrument: BTC-18SEP24-60000-C exchange: bybit exchangeTimestamp: 1726526186266 exchangeTimestampNanoseconds: 0 sequence: '26992247584' ask: - price: 95 volume: 3.92 numOrders: null - price: 100 volume: 26.97 numOrders: null bid: [] schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /options/order-book-snapshots/information: get: summary: Snapshots Information description: >- Provides availability details for options order book snapshots, including contract symbols, underlying assets, and data coverage periods across supported exchanges to support historical market depth analysis. operationId: options-order-book-snapshots-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - 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: 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/market/options/order-book-snapshots/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0IOAtkgGID2ATnelkSHWDDGEpRmEBORA1ibDl0IgAVuRESQAB3QBzAoQCMNcmABe2nQAZzAXyA data: - exchange: deribit instrument: BTC-10MAR23-12000-C startDate: 1676593260000 endDate: 1677742980000 underlying: BTC-10MAR23 - exchange: deribit instrument: BTC-10MAR23-12000-P startDate: 1676593260000 endDate: 1677742980000 underlying: BTC-10MAR23 schema: type: object properties: status: type: integer title: type: string description: type: string payload: type: object properties: metadata: type: object properties: next: type: string data: type: array items: type: object properties: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer underlying: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /options/order-book-snapshots/{instrument}: get: summary: Snapshots Historical description: >- Provides detailed historical snapshots of options order books, including bid and ask levels, underlying prices, market statistics, open interest, and Greeks, enabling in-depth analysis of market depth and options pricing over time across supported exchanges. operationId: options-order-book-snapshots-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- **[Required]** The exchange(s) for which to retrieve the requested data (comma separated). **[Default]** All available exchanges. required: true schema: type: string default: deribit - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current minute (max time range is 1 hour). schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** Ten minutes after the beginning of the current hour (max time range is 1 hour). schema: type: string format: date-time - name: timestamp in: query description: >- **[Optional]** The timestamp at which to return the order book information (closest match, lower or equal to the timestamp specified). 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: 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: maxLevel in: query description: The number of order book levels that should be returned. schema: type: integer format: int32 - 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/options/order-book-snapshots/BTC-13FEB26-100000-C?cursor=N4IgpgHgxgFghgOwOZhALhAEzAJwJYBGeALiADQhQCuOAzgPY7oJUA2rFxeAtmLcXG4AHZmw4h%2BcHMQAicYqjQBGAOwA2AJwqAHAFY1AJgAMugCwqKYBJjkL0qzTv1mDaoxTwIorKtgCqCLRUQkKMCpgAotDwyHzoAGZwrLRgFNxwEAAyYABuYKyi7Jw8YABijOmkGNx47HgpUPTWtOQg8RXy6CAAVgwIrQzSANJgAJ5dDlp6hkazRgD62PhExPNKAMwqukqa2toGugbzAEIAKgDCALQbpRHHrtdzs5fnIAC%2BQA api-version: 2023-09-30T00:00:00.000Z data: - timestamp: 1769699280000 instrument: BTC-13FEB26-100000-C exchange: deribit exchangeTimestamp: 1769699279646 exchangeTimestampNanoseconds: 0 sequence: 137341145308 underlyingPrice: 86308.1667 underlyingIndex: SYN.BTC-13FEB26 low: 0.0012 high: 0.0031 volume: 112.6 volumeUSD: 16365.05 priceChange: -58.6207 openInterest: 1392.8 minPrice: 0.0001 maxPrice: 0.016 markPrice: 0.0012 markIv: 40.59 lastPrice: 0.0012 interestRate: 0 indexPrice: 86149.28 estimatedDeliveryPrice: 0 rho: 1.30112 vega: 14.51698 delta: 0.03865 gamma: 0.00001 theta: -20.04074 bidIv: 40.42 askIv: 42.12 bestBidPrice: 0.0012 bestAskPrice: 0.0015 bestBidVolume: 3.7 bestAskVolume: 69.2 state: open ask: - price: 0.0295 volume: 69.2 numOrders: null - price: 0.0295 volume: 69.2 numOrders: null - price: 0.0295 volume: 69.2 numOrders: null bid: - price: 0.0012 volume: 3.7 numOrders: null - price: 0.0011 volume: 16.9 numOrders: null - price: 0.001 volume: 42 numOrders: null schema: type: object properties: status: type: integer title: type: string description: type: string payload: type: object properties: metadata: type: object properties: next: type: string description: Cursor for pagination api-version: type: string description: API version used data: type: array items: type: object properties: timestamp: type: integer format: int64 instrument: type: string exchange: type: string exchangeTimestamp: type: integer format: int64 exchangeTimestampNanoseconds: type: integer sequence: type: string underlyingPrice: type: number underlyingIndex: type: string low: type: number high: type: number volume: type: number volumeUSD: type: number priceChange: type: number openInterest: type: number minPrice: type: number maxPrice: type: number markPrice: type: number markIv: type: number lastPrice: type: number interestRate: type: number indexPrice: type: number estimatedDeliveryPrice: type: number rho: type: number vega: type: number delta: type: number gamma: type: number theta: type: number bidIv: type: number askIv: type: number bestBidPrice: type: number bestAskPrice: type: number bestBidVolume: type: number bestAskVolume: type: number state: type: string ask: type: array items: type: object properties: price: type: number volume: type: number numOrders: type: integer nullable: true bid: type: array items: type: object properties: price: type: number volume: type: number numOrders: type: integer nullable: true '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /options/tickers/information: get: summary: Information description: >- Provides details about available options tickers on various exchanges, including essential information about each options contract's underlying asset, trading period, and contract type. operationId: options-tickers-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `false* | true` schema: type: boolean - name: includeDates in: query description: >- **[Optional]** Include date ranges for each record. **[Defaults]** `false* | true` schema: type: boolean - 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: 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/options/tickers/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-16AUG24-50000-C underlying: BTC startDate: 1721895381123 endDate: 1722346199223 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/tickers/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: bybit instrument: type: string example: BTC-16AUG24-50000-C underlying: type: string example: BTC startDate: type: integer example: 1721895381123 default: 0 endDate: type: integer example: 1722346199223 default: 0 deprecated: false security: - ApiKeyAuth: [] /options/tickers/{instrument}: get: summary: Historical description: >- Provides detailed historical data for options tickers, including price metrics, trading volumes, Greeks, and implied volatility. This endpoint is particularly useful for analyzing past market conditions for specific options on various exchanges. operationId: options-tickers-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- The exchange(s) for which to retrieve the requested data (comma separated). **[Default]** All available exchanges. required: true schema: type: string default: bybit - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). **[Formats]** `ms* | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: >- https://api.amberdata.com/markets/options/tickers/BTC-16AUG24-50000-C?cursor=N4IgpgHgxgFghgOwOZhALhAIwJ6YJYAuIANCFAK4BOAzgPaXoLkA2zp1BclBAInAajQBGAOwAmCQDYAzNICscgAxjppMAgAmfAelETpAFnGSAnAA5ZpPAijNyGsAFUE1cgAc39ARoCi0eMhg1OgAZnDM1GCkBHgAtmAAYvSx-OggsXiseJFQtJrBpCHJqRgAVnQIJCB03ADSYNhpelKyCsrSAPqKHTj4BF0dAEIAKgDCALRCkgCCjgDiYgbjSoqr46MgAL5AA api-version: '2023-09-30' data: - instrument: BTC-16AUG24-50000-C exchange: bybit exchangeTimestamp: 1722260870023 exchangeTimestampNanoseconds: 0 bid: 0 mid: 0 ask: 0 last: 0 bidVolume: 0 askVolume: 0 lastVolume: null baseVolume: null quoteVolume: null sequence: null underlyingPrice: 69793.36 underlyingIndex: null settlementPrice: null markPrice: 19806.40225084 low: 0 high: 0 volume: 0 volumeUSD: null priceChange: 0 openInterest: 0 minPrice: null maxPrice: null markIv: 0.5997 interestRate: null indexPrice: 69398.4 rho: null vega: 2.16053057 delta: 0.99516469 gamma: 0.00000152 theta: -3.64786985 bidIv: 0 askIv: 0 estimatedDeliveryPrice: null state: null askTimestamp: null bidTimestamp: null askTimestampNanoseconds: null bidTimestampNanoseconds: null schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/tickers/BTC-16AUG24-50000-C?cursor=N4IgpgHgxgFghgOwOZhALhAIwJ6YJYAuIANCFAK4BOAzgPaXoLkA2zp1BclBAInAajQBGAOwAmCQDYAzNICscgAxjppMAgAmfAelETpAFnGSAnAA5ZpPAijNyGsAFUE1cgAc39ARoCi0eMhg1OgAZnDM1GCkBHgAtmAAYvSx-OggsXiseJFQtJrBpCHJqRgAVnQIJCB03ADSYNhpelKyCsrSAPqKHTj4BF0dAEIAKgDCALRCkgCCjgDiYgbjSoqr46MgAL5AA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-16AUG24-50000-C exchange: type: string example: bybit exchangeTimestamp: type: integer example: 1722260870023 default: 0 exchangeTimestampNanoseconds: type: integer example: 0 default: 0 bid: type: integer example: 0 default: 0 mid: type: integer example: 0 default: 0 ask: type: integer example: 0 default: 0 last: type: integer example: 0 default: 0 bidVolume: type: integer example: 0 default: 0 askVolume: type: integer example: 0 default: 0 lastVolume: {} baseVolume: {} quoteVolume: {} sequence: {} underlyingPrice: type: number example: 69793.36 default: 0 underlyingIndex: {} settlementPrice: {} markPrice: type: number example: 19806.40225084 default: 0 low: type: integer example: 0 default: 0 high: type: integer example: 0 default: 0 volume: type: integer example: 0 default: 0 volumeUSD: {} priceChange: type: integer example: 0 default: 0 openInterest: type: integer example: 0 default: 0 minPrice: {} maxPrice: {} markIv: type: number example: 0.5997 default: 0 interestRate: {} indexPrice: type: number example: 69398.4 default: 0 rho: {} vega: type: number example: 2.16053057 default: 0 delta: type: number example: 0.99516469 default: 0 gamma: type: number example: 0.00000152 default: 0 theta: type: number example: -3.64786985 default: 0 bidIv: type: integer example: 0 default: 0 askIv: type: integer example: 0 default: 0 estimatedDeliveryPrice: {} state: {} askTimestamp: {} bidTimestamp: {} askTimestampNanoseconds: {} bidTimestampNanoseconds: {} deprecated: false /options/trades/information: get: summary: Information description: >- Povides metadata on available options trades across various exchanges. This includes information on instruments (specific options contracts) such as their exchange, underlying asset, and the time period during which the trade data is available. operationId: options-trades-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `false* | true` schema: type: boolean - 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: 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/options/trades/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: bybit instrument: BTC-16AUG24-50000-P underlying: BTC startDate: 1721916316594 endDate: 1722412049804 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/options/trades/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: bybit instrument: type: string example: BTC-16AUG24-50000-P underlying: type: string example: BTC startDate: type: integer example: 1721916316594 default: 0 endDate: type: integer example: 1722412049804 default: 0 deprecated: false /options/trades/{instrument}: get: summary: Historical description: >- Provides detailed historical trade data for a specific options instrument, including the trade's timestamp, side (buy or sell), price, volume, and other relevant metrics like the index price, mark price, and implied volatility (IV) at the time of the trade. operationId: options-trades-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTC-27DEC24-100000-C required: true - name: exchange in: query description: >- **[Required]** The exchange(s) for which to retrieve the requested data (comma separated). **[Default]** All available exchanges. required: true schema: type: string default: deribit - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: null api-version: '2023-09-30' data: - instrument: BTC-16AUG24-50000-P exchange: bybit exchangeTimestamp: 1722412049804 exchangeTimestampNanoseconds: 0 isBuySide: true price: 25 volume: 0.1 tradeId: 8212ab1b-88f9-5c3b-a55d-2bf79a805e11 quoteVolume: null sequence: null tickDirection: null indexPrice: 66292.12 markPrice: 39.59685034 underlyingIndex: null underlyingPrice: 66607.93 iv: 0.6291 schema: oneOf: - title: Success 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: {} api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-16AUG24-50000-P exchange: type: string example: bybit exchangeTimestamp: type: integer example: 1722412049804 default: 0 exchangeTimestampNanoseconds: type: integer example: 0 default: 0 isBuySide: type: boolean example: true default: true price: type: integer example: 25 default: 0 volume: type: number example: 0.1 default: 0 tradeId: type: string example: 8212ab1b-88f9-5c3b-a55d-2bf79a805e11 quoteVolume: type: number sequence: {} tickDirection: {} indexPrice: type: number example: 66292.12 default: 0 markPrice: type: number example: 39.59685034 default: 0 underlyingIndex: {} underlyingPrice: type: number example: 66607.93 default: 0 iv: type: number example: 0.6291 default: 0 deprecated: false /futures/exchanges/information: get: summary: Instruments description: >- Provides detailed metadata and trading activity timelines for futures instruments across exchanges, including funding rates, liquidations, long/short ratios, OHLCV, open interest, order book snapshots and events, ticker updates, and trade history. operationId: futures-exchanges-pairs 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - 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: size in: query description: >- **[Optional]** The number of records per page (only available when `includeInactive=true`). schema: type: integer format: int32 - 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/futures/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC fundingRate: startDate: 1714521600000 endDate: 1722369601000 liquidation: startDate: 1714639265467 endDate: 1722370187666 longShortRatio: startDate: 1714636800000 endDate: 1722369600000 ohlcv: startDate: 1714608000000 endDate: 1722211200000 openInterest: startDate: 1714635667663 endDate: 1722373127413 orderBookSnapshot: startDate: 1714635300000 endDate: 1722373440667 orderBookEvent: startDate: 1714635333956 endDate: 1722373199545 ticker: startDate: 1714635454117 endDate: 1722373199496 trade: startDate: 1714635667663 endDate: 1722373188111 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/futures/exchanges/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: binance instrument: type: string example: 1000BONKUSDC fundingRate: type: object properties: startDate: type: integer example: 1714521600000 default: 0 endDate: type: integer example: 1722369601000 default: 0 liquidation: type: object properties: startDate: type: integer example: 1714639265467 default: 0 endDate: type: integer example: 1722370187666 default: 0 longShortRatio: type: object properties: startDate: type: integer example: 1714636800000 default: 0 endDate: type: integer example: 1722369600000 default: 0 ohlcv: type: object properties: startDate: type: integer example: 1714608000000 default: 0 endDate: type: integer example: 1722211200000 default: 0 openInterest: type: object properties: startDate: type: integer example: 1714635667663 default: 0 endDate: type: integer example: 1722373127413 default: 0 orderBookSnapshot: type: object properties: startDate: type: integer example: 1714635300000 default: 0 endDate: type: integer example: 1722373440667 default: 0 orderBookEvent: type: object properties: startDate: type: integer example: 1714635333956 default: 0 endDate: type: integer example: 1722373199545 default: 0 ticker: type: object properties: startDate: type: integer example: 1714635454117 default: 0 endDate: type: integer example: 1722373199496 default: 0 trade: type: object properties: startDate: type: integer example: 1714635667663 default: 0 endDate: type: integer example: 1722373188111 default: 0 deprecated: false /futures/exchanges/reference: get: summary: Reference description: >- Provides comprehensive reference data for futures instruments across exchanges, including details on base and quote symbols, price and volume limits, precision, contract terms, and trading availability. operationId: futures-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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - name: size in: query description: >- **[Optional]** The number of records per page (only available when `includeInactive=true`). schema: type: integer format: int32 - name: startDate in: query description: >- **[Optional]** Payload only includes instruments which have expiration after this date (inclusive). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes instruments which have expiration before this date (exclusive). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: includeOriginalReference in: query description: >- **[Optional]** If true, endpoint returns originalReference. **[Defaults]** `True | False*`. schema: type: boolean - name: underlying in: query description: >- **[Optional]** Filter for instruments whose underlying matches the value given. **[Examples]** btc | ETH schema: type: string - name: expiration in: query description: >- **[Optional]** Filter for instruments that expire on the specified date. **[Example]** 2024-08-01 schema: type: string format: date-time - name: contractType in: query description: >- **[Optional]** Filter for instruments that match the contract type specified. **[Examples]** yearly | quarterly | monthly | weekly | daily | perpetual | prediction 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: 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/futures/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC baseSymbol: 1000BONK quoteSymbol: USDC market: futures exchangeEnabled: true limitsPriceMin: 0.000001 limitsPriceMax: 200 limitsVolumeMin: 1 limitsVolumeMax: 10000000 limitsMarketMin: 1 limitsMarketMax: 2000000 limitsLeverageMin: null limitsLeverageMax: null limitsLeverageSuperMax: null limitsCostMin: null limitsCostMax: null precisionPrice: 0.000001 precisionVolume: 1 precisionBase: 1.e-8 precisionQuote: 1.e-8 listingTimestamp: null contractUnderlying: 1000BONK contractExpirationTimestamp: null contractPeriod: perpetual contractSize: null contractSettleType: linear contractSettleSymbol: null schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/futures/exchanges/reference?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yA8gE5gDmkZASksUk0tAIkylGpFiIkAVQjk4AB3kB7JliQIAogA8oAC3QRWSckVIVqIHAFskAMRVX0WIiCtgYMMJShKICEzTEDk4uAFbkviA08uhGRACMNORgAF5CAKwADJkAvkA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: binance instrument: type: string example: 1000BONKUSDC baseSymbol: type: string example: 1000BONK quoteSymbol: type: string example: USDC market: type: string example: futures exchangeEnabled: type: boolean example: true default: true limitsPriceMin: type: number example: 0.000001 default: 0 limitsPriceMax: type: integer example: 200 default: 0 limitsVolumeMin: type: integer example: 1 default: 0 limitsVolumeMax: type: integer example: 10000000 default: 0 limitsMarketMin: type: integer example: 1 default: 0 limitsMarketMax: type: integer example: 2000000 default: 0 limitsLeverageMin: {} limitsLeverageMax: {} limitsLeverageSuperMax: {} limitsCostMin: {} limitsCostMax: {} precisionPrice: type: number example: 0.000001 default: 0 precisionVolume: type: integer example: 1 default: 0 precisionBase: type: number example: 1.e-8 default: 0 precisionQuote: type: number example: 1.e-8 default: 0 listingTimestamp: {} contractUnderlying: type: string example: 1000BONK contractExpirationTimestamp: {} contractPeriod: type: string example: perpetual contractSize: {} contractSettleType: type: string example: linear contractSettleSymbol: {} deprecated: false /futures/funding-rates/information: get: summary: Information description: >- Delivers information on funding rate periods for futures instruments across exchanges, including start and end dates for available funding data. operationId: futures-funding-rates-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 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/futures/funding-rates/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714521600000 endDate: 1717603201000 - exchange: binance instrument: 1000BONKUSDT startDate: 1700662262000 endDate: 1717603441001 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683388800000 endDate: 1717603441001 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/funding-rates/{instrument}: get: summary: Historical description: >- Provides historical funding rate data for futures instruments, including timestamps, actual and projected rates, and details on upcoming funding times across exchanges. operationId: futures-funding-rates-historical parameters: - name: exchange in: query description: >- The exchange for which data should be retrieved. Only **1** exchange is allowed. required: true schema: type: string default: binance - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSD_PERP required: true - 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 - 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 - 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: 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: rateType in: query description: >- **`applied`**: Returns only applied funding rates (historical, confirmed rates) **`predicted`**: Returns only predicted funding rates (future, expected rates) **`both`** (default): Returns both predicted and applied funding rates 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: next: null api-version: '2023-09-30' data: - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717545600000 exchangeTimestampNanoseconds: 0 fundingInterval: null fundingRate: 0.0001 nextFundingRate: null nextFundingTime: null isActualFundingRate: true - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717545601000 exchangeTimestampNanoseconds: 0 fundingInterval: null fundingRate: 0.0001 nextFundingRate: null nextFundingTime: 1717574400000 isActualFundingRate: false 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer fundingInterval: type: number fundingRate: type: number nextFundingRate: type: number nextFundingTime: type: number isActualFundingRate: type: boolean '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/batch-funding-rates/{exchange}: get: summary: Batch Historical description: >- Returns batched historical funding rate data for futures instruments within a specified date range, including timestamps, actual funding rates, and projected rates across exchanges. operationId: batch-historical-ent parameters: - name: exchange in: path description: The exchange for which to retrieve the most current data. schema: type: string default: binance required: true - name: instruments in: query description: >- **[Required]** The instrument(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 instruments required: true schema: type: string default: BTCUSDT,ETHUSDT - name: rateType in: query description: >- **`applied`** (default): Returns only applied funding rates (historical, confirmed rates) **`predicted`**: Returns only predicted funding rates (future, expected rates) required: true schema: type: string default: applied - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: BTCUSDT exchangeTimestamp: 1735948800000 fundingInterval: null fundingRate: 0.00000798 nextFundingRate: null nextFundingTime: null isActualFundingRate: true - instrument: ETHUSDT exchangeTimestamp: 1735948800000 fundingInterval: null fundingRate: 0.0001 nextFundingRate: null nextFundingTime: null isActualFundingRate: true 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: instrument: type: string exchangeTimestamp: type: integer fundingInterval: type: number fundingRate: type: number nextFundingRate: type: number nextFundingTime: type: number isActualFundingRate: type: boolean '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/insurance-fund/information: get: summary: Information description: >- Provides details on insurance fund data availability for futures instruments, including exchanges, underlying assets, and date ranges for historical coverage. operationId: futures-insurance-funds-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. schema: type: boolean default: false - 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: 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: null api-version: '2023-09-30' data: - exchange: bitmex instrument: USDt underlying: USDt startDate: 1636113600000 endDate: 1717588800000 - exchange: bitmex instrument: XBt underlying: XBt startDate: 1456660800000 endDate: 1717588800000 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: exchange: type: string instrument: type: string underlying: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/insurance-fund/{instrument}: get: summary: Historical description: >- Delivers historical data on insurance fund balances for futures instruments, including timestamps, fund amounts, and underlying assets across exchanges. operationId: futures-insurance-funds-historical parameters: - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTC-USDT 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: huobi - 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 - 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 - 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: 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: next: null api-version: '2023-09-30' data: - instrument: BTC-USDT exchange: huobi exchangeTimestamp: 1717574400000 exchangeTimestampNanoseconds: 0 fund: 242292335.5251998 underlying: BTC-USDT 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: {} api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: BTC-USDT exchange: type: string example: huobi exchangeTimestamp: type: integer example: 1717574400000 default: 0 exchangeTimestampNanoseconds: type: integer example: 0 default: 0 fund: type: number example: 242292335.5251998 default: 0 underlying: type: string example: BTC-USDT '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/liquidations/information: get: summary: Information description: >- Provides available date ranges for liquidation data on futures instruments across exchanges, including start and end timestamps for each instrument. operationId: futures-liquidations-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. schema: type: boolean default: false - 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: 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/futures/liquidations/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714639265467 endDate: 1717596728610 - exchange: binance instrument: 1000BONKUSDT startDate: 1700661767295 endDate: 1717603600409 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/liquidations/{instrument}: get: summary: Historical description: >- Provides historical liquidation data for futures instruments, including timestamps, order details, price, volume, and position type for each liquidation event across exchanges. operationId: futures-liquidations-historical parameters: - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSDT 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: binance - 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 - 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 - 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: 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: next: >- https://api.amberdata.com/markets/futures/liquidations/BTCUSDT?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKxiADAE5hADkEAmOcTAIAJr37oRIgGySALIKWHF04riiNS6sAFUElUgAcXtfuoCi0eMjCU6ABmcIyUYMRs2AC2YABitNF86CDR2MzY4VDUGoHEQYnJGABWNAggrB4A0mAAnim6whIy8kpyAPqS7Th4CATtAEIAKgDC9gDK3EPtogDMgmIAdAudi5JGIAC%2BQA api-version: '2023-09-30' data: - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1717517743430 exchangeTimestampNanoseconds: 0 action: null orderId: null side: BUY status: FILLED timeInForce: IOC type: LIMIT price: 70913.39 volume: 0.002 unit: base_asset positionType: SHORT - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1717517764608 exchangeTimestampNanoseconds: 0 action: null orderId: null side: BUY status: FILLED timeInForce: IOC type: LIMIT price: 70929.32 volume: 0.002 unit: base_asset positionType: SHORT 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer action: type: string orderId: type: string side: type: string status: type: string timeInForce: type: string type: type: string price: type: number volume: type: number unit: type: string positionType: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/long-short-ratio/information: get: summary: Information description: >- Provides available date ranges for long/short ratio data on futures instruments across exchanges, detailing the start and end dates for each instrument. operationId: futures-long-short-ratio-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 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/futures/long-short-ratio/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiBEc4XGTXIBHGADl0ewgaNcQZyzZUAFeFy33DxmACeziDIpHAwWEQATABsAOwAHAAsAAxpaTRK6ILR8cnpGSAwHBwA1gBGmKXuSFxgHAjRSQC%2BNMpIAGLcWZH2SmAwMGCUUBwQCKYgxN3ovSAAVuRjwazoUkQAjGZgAF4EhACsac1AA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714636800000 endDate: 1717603200000 - exchange: binance instrument: 1000BONKUSDT startDate: 1700665200000 endDate: 1717603200000 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683392400000 endDate: 1717603200000 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/long-short-ratio/{instrument}: get: summary: Historical description: >- Provides historical long/short ratio data for futures instruments, including timestamps, long and short account distributions, and ratio values across exchanges. operationId: futures-long-short-ratio-historical parameters: - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSDT 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: binance - 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 - 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 - 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: timeInterval in: query description: '**[Optional]** Time interval to aggregate the historical data to.' schema: type: string enum: - minutes - hours - days default: hours - name: metricType in: query description: > **[Optional]** Specifies the long/short ratio metric to retrieve. | Value | Description | |---|---| | `default` | Long/short ratio across **all** accounts on the exchange. Available for all supported exchanges. | | `topTraderPositions` | Long/short ratio by **position size** (dollar-weighted) among the top 20% of traders by margin balance. Reflects where the largest capital is allocated. | | `topTraderAccounts` | Long/short ratio by **account count** among top traders — each account counted once regardless of position size. Reflects how many large traders are bullish vs bearish. | **[Supported exchanges]** `topTraderPositions` and `topTraderAccounts` are only supported for `binance`. Requests using these values with other exchanges will return an empty response. schema: type: string enum: - default - topTraderPositions - topTraderAccounts default: default - 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: next: null api-version: '2023-09-30' data: - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1714928400000 exchangeTimestampNanoseconds: 0 period: 1 longAccount: 0.519 shortAccount: 0.481 ratio: 1.079 - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1714932000000 exchangeTimestampNanoseconds: 0 period: 1 longAccount: 0.5179 shortAccount: 0.4821 ratio: 1.0743 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer period: type: integer description: > The number of `timeInterval` units per data point. **Example:** - `timeInterval=minutes`, `period=5` → 5-minute buckets - `timeInterval=hours`, `period=1` → 1-hour buckets - `timeInterval=days`, `period=1` → 1-day buckets longAccount: type: number shortAccount: type: number ratio: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/ohlcv/information: get: summary: Information description: >- Provides available date ranges for OHLCV (Open, High, Low, Close, Volume) data on futures instruments across exchanges, including start and end dates for each instrument. operationId: futures-ohlcv-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. **[Defaults]** `True | False*`. schema: type: boolean - 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: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes* | hours | days` 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: >- https://api.amberdata.com/markets/futures/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxplJAAxbkzw%2ByU-GDBKKA4IBFMQYn70QZAAK3JJwNZ0KSIoszAALwJCAFZU9qA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714608000000 endDate: 1722297600000 schema: oneOf: - title: Success 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: type: string example: >- https://api.amberdata.com/markets/futures/ohlcv/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAW1QReXXGSKgMKoiAToAnjJrkAjjABy6PYQPGQZyzZUAFeFy33DYGEacDJFI4GCwiAGYARgA2ACY4gBYABlTUmiV0QSIYiKTEgA409JAYDg4AawAjTAq3JC4wDgQiOOSAXxplJAAxbkzw%2ByU-GDBKKA4IBFMQYn70QZAAK3JJwNZ0KSIoszAALwJCAFZU9qA api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: exchange: type: string example: binance instrument: type: string example: 1000BONKUSDC startDate: type: integer example: 1714608000000 default: 0 endDate: type: integer example: 1722297600000 default: 0 deprecated: false security: - ApiKeyAuth: [] /futures/ohlcv/{instrument}: get: summary: Historical description: >- Delivers historical OHLCV (Open, High, Low, Close, Volume) data for futures instruments, including timestamps, price levels, and trading volume across exchanges. operationId: futures-ohlcv-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTCUSD_PERP required: true - name: exchange in: query description: '**[Default]** All available exchanges.' required: true schema: type: string default: binance - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: Success: value: status: 200 title: OK description: Successful request payload: metadata: next: null api-version: '2023-09-30' data: - instrument: 1000BONKUSDC exchange: binance exchangeTimestamp: 1714608000000 open: 0.023 high: 0.026 low: 0.022392 close: 0.02531 volume: 210710456 schema: oneOf: - title: Success 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: {} api-version: type: string example: '2023-09-30' data: type: array items: type: object properties: instrument: type: string example: 1000BONKUSDC exchange: type: string example: binance exchangeTimestamp: type: integer example: 1714608000000 default: 0 open: type: number example: 0.023 default: 0 high: type: number example: 0.026 default: 0 low: type: number example: 0.022392 default: 0 close: type: number example: 0.02531 default: 0 volume: type: integer example: 210710456 default: 0 deprecated: false security: - ApiKeyAuth: [] /futures/batch-ohlcv/{exchange}: get: summary: Batch Historical description: >- Provides batched historical OHLCV (Open, High, Low, Close, Volume) data for multiple futures instruments within a specified date range, including timestamps, price levels, and trading volumes across exchanges. operationId: ohlcv-ond parameters: - name: exchange in: path description: The exchange for which to retrieve the most current data. schema: type: string default: binance required: true - name: instruments in: query description: >- **[Required]** The instrument(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 instruments required: true schema: type: string default: BTCUSDT,ETHUSDT - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: BTCUSDT exchangeTimestamp: 1735948800000 open: 98145.7 high: 98760.9 low: 97438.2 close: 98173.2 volume: 71914.634 - instrument: ETHUSDT exchangeTimestamp: 1735948800000 open: 3607.9 high: 3670 low: 3570.66 close: 3655.99 volume: 1729182.603 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: instrument: type: string exchangeTimestamp: type: integer open: type: number high: type: number low: type: number close: type: number volume: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/open-interest/information: get: summary: Information description: >- Provides available date ranges for open interest data on futures instruments across exchanges, including start and end dates for each instrument. operationId: futures-open-interest-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 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/futures/open-interest/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714635667663 endDate: 1717604023595 - exchange: binance instrument: 1000BONKUSDT startDate: 1700661777079 endDate: 1717604038239 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683391318193 endDate: 1717604038880 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/open-interest/{instrument}: get: summary: Historical description: >- Provides historical open interest data for futures instruments, including timestamps, open interest values, and contract types across exchanges. operationId: futures-open-interest-historical parameters: - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSD_PERP 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: binance - 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 - 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 - 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: 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: next: >- https://api.amberdata.com/markets/futures/open-interest/BTCUSD_PERP?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKwAWABwAGCQCYAzMLHEwCACa9%2B6ESIBscidJmDFxXFEakNYAKoJKpAA7Pa-DQFFo8ZGEroAGZwjJRgxGzYALZgAGK0UXzoIFHYzNhhUNSaAcSBCUkYAFY0CCCs7gDSYACeyXoqJgrKYgD6Mq04eAgErQBCACoAwnYAytytAAqeAEqTIAC%2BQA api-version: '2023-09-30' data: - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717518065771 exchangeTimestampNanoseconds: 0 value: 16862174 type: PERPETUAL - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717518157220 exchangeTimestampNanoseconds: 0 value: 16865368 type: PERPETUAL - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717518218262 exchangeTimestampNanoseconds: 0 value: 16866686 type: PERPETUAL 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer value: type: integer type: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/batch-open-interest/{exchange}: get: summary: Batch Historical description: >- Provides batched historical open interest data for multiple futures instruments within a specified date range, including timestamps, open interest values, and contract types across exchanges. operationId: batch-historical-ent-1 parameters: - name: exchange in: path description: The exchange for which to retrieve the most current data. schema: type: string default: binance required: true - name: instruments in: query description: >- **[Required]** The instrument(s) for which to retrieve the most current data (comma separated). **[Maximum]** 50 instruments required: true schema: type: string default: BTCUSDT,ETHUSDT - 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 - 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 - name: timeInterval in: query description: >- **[Optional]** Time interval. **[Defaults]** `minutes | hours | days*` 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: 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: null api-version: '2023-09-30' data: - instrument: BTCUSDT exchangeTimestamp: 1735948800000 value: 87453.638 type: null - instrument: ETHUSDT exchangeTimestamp: 1735948800000 value: 1631146.816 type: null 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: instrument: type: string exchangeTimestamp: type: integer value: type: number type: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/order-book-snapshots/information: get: summary: Information description: >- Provides available date ranges for order book snapshot data on futures instruments across exchanges, including start and end timestamps for each instrument. operationId: futures-order-books-information parameters: - name: exchange in: query description: >- The exchange(s) for which to retrieve futures order book data. Example: exchange=bitfinex,bitstamp 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 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/futures/order-book-snapshots/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714635300000 endDate: 1717604340194 - exchange: binance instrument: 1000BONKUSDT startDate: 1700662020000 endDate: 1717604340185 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683390900000 endDate: 1717604340574 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/order-book-events/{instrument}: get: summary: Events/Updates Historical description: >- Provides historical event updates for futures order books, including bid and ask price levels, volumes, and sequence information for each update across exchanges. operationId: futures-order-books-events-historical parameters: - name: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSD_PERP 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: binance - 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 - 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 - 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-06-04 16:22:24 224 requestedEndDate: 2024-06-05 16:22:24 224 returnedStartDate: 2024-06-04 16:22:24 231 returnedEndDate: 2024-06-04 16:23:12 414 next: >- https://api.amberdata.com/markets/futures/order-book-events/BTCUSD_PERP?cursor=N4IgxgrgTgzg9lEAuAdhANugNCGAXAQyjwBEC8BTZARgHY6BWagDmoE4AmAFmq5wpQATMpRr1aANgAMXBly4duOPAEsAthQBiCNeWQgAFhF0oAShQKCCAI3RVl6igEkUlKADcC6ZKBQEN%2BgCeFrAgODAAjugAcv5USCDBRGG4UbEaAAro0F5BIeiBKYIUAGYEGHjIzBJcUnV1OLoAHsgSAMzcXMz1DSDocHAA1tYEYIMZFFAqcILIaJgAvjglOnoJAFbwKCkUTWAGBCgA5vEg1ip%2BKGD2IBdg2cUAqigwEAAObwiUggCiewfHCgwZBldAwCjhL4AaQohQSdEYLHY3F4AH0pKjzpdrqi2NIOExmN02gw2Ki8FAIBRUQAhAAqAGFHgBlEiojI-UwZEALIA api-version: '2023-09-30' data: - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 2024-06-04 16:23:12 414 exchangeTimestampNanoseconds: 0 sequence: '960251880359' ask: - price: 70960.6 volume: 75 numOrders: null - price: 70973.5 volume: 137 numOrders: null - price: 70975.4 volume: 7914 numOrders: null - price: 70976 volume: 0 numOrders: null - price: 70976.6 volume: 20 numOrders: null bid: - price: 70907 volume: 51 numOrders: null - price: 70914 volume: 50 numOrders: null - price: 70928.5 volume: 25 numOrders: null schema: type: object properties: status: type: integer title: type: string description: type: string payload: type: object properties: metadata: type: object properties: requestedStartDate: type: string requestedEndDate: type: string returnedStartDate: type: string returnedEndDate: type: string next: type: string api-version: type: string data: type: array items: type: object properties: instrument: type: string exchange: type: string exchangeTimestamp: type: string exchangeTimestampNanoseconds: type: integer sequence: type: string ask: type: array items: type: object properties: price: type: number volume: type: integer numOrders: type: string bid: type: array items: type: object properties: price: type: integer volume: type: integer numOrders: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/order-book-snapshots/{instrument}: get: summary: Snapshots Historical description: >- Provides historical snapshots of futures order books, capturing bid and ask price levels, volumes, and sequence details at specific timestamps across exchanges. operationId: futures-order-book-snapshots-historical parameters: - name: instrument in: path description: The instrument for which to retrieve the requested data. schema: type: string default: BTCUSD_PERP 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: binance - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current minute (max time range is 10 minutes). schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** Ten minutes after the beginning of the current hour (max time range is 10 minutes). schema: type: string format: date-time - name: timestamp in: query description: >- **[Optional]** The timestamp at which to return the order book information (closest match, lower or equal to the timestamp specified). 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: 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: maxLevel in: query description: The number of order book levels that should be returned. schema: type: integer format: int32 - 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: 1717518243690 requestedEndDate: 1717604643690 returnedStartDate: 1717518300000 returnedEndDate: 1717521900000 next: >- https://api.amberdata.com/markets/futures/order-book-snapshots/BTCUSD_PERP?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKwAmQQE4ADPPnEwCACa9%2B6ESIBssgCza9AZm1zibbAFswAMVqW%2B6EJezNslMFGqrKIc1bAASQR%2BcgA3OEZ0UDxrJwBPME5fVgBHRgA5ODiMRM4-EEp0rOsABUYKSISk8kZ4gpUwADM4JjZ0AA5DBUVnOAh0bSMJPT0OntliRmpqAGtMOChZ0rBybGoVeiZGAF9iJvtHDAArGgQCi2t2bIAHLeZiBwgAGTAwsCi0BgeQXCgKxoAVQQlFINxutH4KgAotB4MgwL40C1GB5WJCANJgeoYLTCSQyCYAfVkRJweAQBCJ0l0RlkUiM0mE2jERLY5FIYCJACEACoAYUBAGVuETStCAEqlEA7IA api-version: '2023-09-30' data: - exchange: binance instrument: BTCUSD_PERP timestamp: 1717518300000 exchangeTimestamp: 1717518300711 exchangeTimestampNanoseconds: 0 sequence: '960253327911' currentFunding: null ask: - price: 70895.9 volume: 7086 numOrders: null - price: 70896 volume: 48 numOrders: null bid: - price: 70895.8 volume: 2097 numOrders: null - price: 70895 volume: 1 numOrders: null 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 exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer sequence: type: string currentFunding: type: string ask: type: array items: type: object properties: price: type: number volume: type: integer numOrders: type: string bid: type: array items: type: object properties: price: type: number volume: type: integer numOrders: type: string '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/tickers/information: get: summary: Information description: >- Provides available date ranges for ticker data on futures instruments across exchanges, including start and end timestamps for each instrument. operationId: futures-tickers-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. 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 instruments, including delisted ones. schema: type: boolean default: false - 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: 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/futures/tickers/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714635454117 endDate: 1717604699662 - exchange: binance instrument: 1000BONKUSDT startDate: 1700662147849 endDate: 1717604699631 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683391092423 endDate: 1717604699817 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/tickers/{instrument}: get: summary: Historical description: >- Provides historical ticker data for futures instruments, including bid, ask, mid prices, volumes, mark and index prices, and sequence information across exchanges. operationId: futures-tickers-historical parameters: - name: exchange in: query description: >- The exchange for which data should be retrieved. Only **1** exchange is allowed. required: true schema: type: string default: binance - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - 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: instrument in: path description: The futures instrument for which data will be retrieved. schema: type: string default: BTCUSDT required: true - 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: next: >- https://api.amberdata.com/markets/futures/tickers/BTCUSDT?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKyCAHABZhY6ZMnEwCACa9%2B6ESIBsABgXCAzGJnFcURqVVgAqgkqkADk9r9VAUWjxkYSugAzOEZKMGI2bABbMAAxWki%2BdBBI7GZsUKhqNX9iAPjEjAArGgQQVjcAaTAATyTtOSlZeUUAfT0WnDwEAhbZIyM5MQAmAz0BloAhABUAYVsAZW4pkABfIA api-version: '2023-09-30' data: - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1717518473606 exchangeTimestampNanoseconds: 0 bid: 70836.3 ask: 70836.4 mid: 70836.35 last: null bidVolume: 2.016 askVolume: 6.463 lastVolume: null baseVolume: null quoteVolume: null sequence: '4733755080561' markPrice: 70829.9 indexPrice: 70781.87276596 askTimestamp: null bidTimestamp: null askTimestampNanoseconds: null bidTimestampNanoseconds: null - instrument: BTCUSDT exchange: binance exchangeTimestamp: 1717518473608 exchangeTimestampNanoseconds: 0 bid: 70836.3 ask: 70836.4 mid: 70836.35 last: null bidVolume: 1.766 askVolume: 6.463 lastVolume: null baseVolume: null quoteVolume: null sequence: '4733755080681' markPrice: 70829.9 indexPrice: 70781.87276596 askTimestamp: null bidTimestamp: null askTimestampNanoseconds: null bidTimestampNanoseconds: null 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer bid: type: number ask: type: number mid: type: number last: type: string bidVolume: type: number askVolume: type: number lastVolume: type: string baseVolume: type: string quoteVolume: type: string sequence: type: string markPrice: type: number indexPrice: type: number askTimestamp: type: number bidTimestamp: type: number askTimestampNanoseconds: type: number bidTimestampNanoseconds: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/trades/information: get: summary: Information description: >- Provides available date ranges for trade data on futures instruments across exchanges, including start and end timestamps for each instrument. operationId: futures-trades-information parameters: - name: exchange in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. schema: type: string - name: instrument in: query description: Only return data for the given pair. schema: type: string - name: includeInactive in: query description: >- **[Optional]** The exchange(s) for which to retrieve the most current data (comma separated). **[Default]** All available exchanges. schema: type: boolean default: false - 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: 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/futures/trades/information?cursor=N4IglgdgxgNgrgEwKYEkIEMoBcwDckgBcAZujAM5IA0408yAqhOXAA6sD2ATlkggKIAPKAAt0EAOZJyRUhWogcAWyQAxbkvRYiIJWBgwwlKBwgIZNYhq06AVuVMgardFKIBGGuTAAvAoQBWAAYggF8gA api-version: '2023-09-30' data: - exchange: binance instrument: 1000BONKUSDC startDate: 1714635667663 endDate: 1717604699630 - exchange: binance instrument: 1000BONKUSDT startDate: 1700662212045 endDate: 1717604697934 - exchange: binance instrument: 1000FLOKIUSDT startDate: 1683391154190 endDate: 1717604699756 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: exchange: type: string instrument: type: string startDate: type: integer endDate: type: integer '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] /futures/trades/{instrument}: get: summary: Historical description: >- Provides historical trade data for futures instruments, including timestamps, trade prices, volumes, buy/sell side information, and trade identifiers across exchanges. operationId: futures-trades-historical parameters: - name: instrument in: path schema: type: string default: BTCUSD_PERP 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: binance - name: startDate in: query description: >- **[Optional]** Payload only includes data after this date (inclusive). **[Defaults]** Beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - name: endDate in: query description: >- **[Optional]** Payload only includes data before this date (exclusive). **[Defaults]** One hour after the beginning of the current hour (max time range is 1 hour). **[Formats]** `seconds | milliseconds | iso8601` **[Examples]** `1578531600 | 1578531600000 | 2020-09-01T01:00:00` schema: type: string format: date-time - 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: next: >- https://api.amberdata.com/markets/futures/trades/BTCUSD_PERP?cursor=N4IgpgHgxgFghgOwOZhALhAIwJYMVVAGhCgFcAnAZwHtz0FSAbR4ygFznLYBE43U0ARgDsIgKyCAHAE5hAZgBMwycTAIAJr37oRIgGwAGMUcEK5KkLiiNS6sAFUElUgAcXtfuoCi0eMjCU6ABmcIyUYMRs2AC2YABitNF86CDR2MzY4VDUGoHEQYnJGABWNAggrB4A0mAAnim6whIy8kqSAPoG7Th4CATtkoLSkpJGI%2B0AQgAqAML2AMrc7QAKXgBKyyAAvkA api-version: '2023-09-30' data: - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717518651671 exchangeTimestampNanoseconds: 0 isBuySide: false price: 70845.5 volume: 21 tradeId: '819875589' quoteVolume: null sequence: null - instrument: BTCUSD_PERP exchange: binance exchangeTimestamp: 1717518651671 exchangeTimestampNanoseconds: 0 isBuySide: false price: 70845.5 volume: 64 tradeId: '819875590' quoteVolume: null sequence: null 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: instrument: type: string exchange: type: string exchangeTimestamp: type: integer exchangeTimestampNanoseconds: type: integer isBuySide: type: boolean price: type: number volume: type: integer tradeId: type: string quoteVolume: type: number sequence: type: number '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false security: - ApiKeyAuth: [] components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key x-readme: headers: [] explorer-enabled: true proxy-enabled: true x-readme-fauxas: true