REST API›Trade›Order Book

GET

Get Level1 Order Book

Gets a snapshot of the level1 order book for product.

Requires access token scope: trade_view

Path Params

  • accountId string required
    The ID of the account
  • product string required
    The name of the product

Responses

200
A Level1OrderBookSnapshot

Response Body

object

  • time string date-time required
    The timestamp when the order book snapshot was generated
  • product string required
    Product name
  • bidPrice string decimal required
    Highest bid price for base asset in quote currency
  • bidSize string decimal required
    Quantity of base asset at highest bid price
  • askPrice string decimal required
    Lowest ask price for base asset in quote currency
  • askSize string decimal required
    Quantity of base asset at lowest ask price
default
unexpected error

Response Body

object

  • error string required
  • errorName string required
  • reqId string required
  • context object
    Optional structured metadata for REST validation failures. The schema is fixed for client contract stability.
    context object
    • errorName string required
      Same value as the top-level errorName.
    • field string
      Request field associated with the validation failure.
    • message string
      Human-readable field-level validation message.