Markets

Get market interactive orderbook

Changed on

Returns orderbook including RPI

get/orderbook/{market}/interactive

Request

  • Base URL
    https://api.prod.paradex.trade/v1
  • URL
    https://api.prod.paradex.trade/v1/orderbook/{market}/interactive
  • Auth
    none declared

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

  • f33feb7333eaRevision changes
    • warning

      added the new ADDRESS_BOOK_NOT_PARADEX_ACCOUNT enum value to the //// response property for the response status

    • warning

      added the new ADDRESS_BOOK_REPEATED_IN_IMPORT enum value to the //// response property for the response status

    • warning

      added the new STARKNET_PARENT_ONBOARDING_DISABLED enum value to the //// response property for the response status

  • 72c125c93c2bRevision changes
    • warning

      added the new SESSION_EXPIRED enum value to the //// response property for the response status

    • warning

      added the new SESSION_REVOKED enum value to the //// response property for the response status