AMamberdata

Events/Updates Historical

Changed on

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.

get/spot/order-book-events/{instrument}

Request

  • Base URL
    https://api.amberdata.com/markets
  • URL
    https://api.amberdata.com/markets/spot/order-book-events/{instrument}
  • Auth
    API key in header x-api-key

Path parameters

instrumentstring required

The spot instrument for which data will be retrieved.

Query parameters

exchangestring required

The exchange for which data should be retrieved. Only 1 exchange is allowed.

startDatestring date-time

[Optional] Payload only includes data after this date (inclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

endDatestring date-time

[Optional] Payload only includes data before this date (exclusive). [Formats] seconds | milliseconds | iso8601 [Examples] 1578531600 | 1578531600000 | 2020-09-01T01:00:00

timeFormat'milliseconds' | 'ms*' | 'iso' | 'iso8601' | 'hr' | 'human_readable'

[Optional] Time format of the timestamps in the response.

sortDirectionstring

[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

Headers

Accept-Encodingstring required
api-versionstring

Response

200

statusinteger
titlestring
descriptionstring

Changes