Sign in
Markets

Get market interactive orderbook

Returns orderbook including RPI

get/orderbook/{market}/interactive

Path parameters

marketstring required

Market symbol - ex: BTC-USD-PERP

Query parameters

depthinteger

Depth

price_tickstring

Price tick for aggregation

Response

OK

best_ask_apistring[]

Size on the best ask from API (excluding RPI)

best_ask_interactivestring[]

Size on the best ask from UI

best_bid_apistring[]

Size on the best bid from API (excluding RPI)

best_bid_interactivestring[]

Size on the best bid from UI

last_updated_atinteger

Last update to the orderbook in milliseconds

marketstring

Market name

seq_nointeger

Sequence number of the orderbook

Example response

{
  "best_ask_api": [
    "10.5"
  ],
  "best_ask_interactive": [
    "10.5"
  ],
  "best_bid_api": [
    "10.5"
  ],
  "best_bid_interactive": [
    "10.5"
  ],
  "last_updated_at": 1681462770114,
  "market": "ETH-USD-PERP",
  "seq_no": 20784
}

Changes

Changed in 3 of the 50 revisions of this API.4

  • e0dd7ef9404f2See the full diff
    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 400

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bbc58975eff21See the full diff
    • ○

      added the new optional query request parameter price_tick

      new-optional-request-parameter

  • e99e6b97e6781See the full diff
    • ○

      endpoint added

      endpoint-added