Get Orderbook

Retrieves the current order book for a specific trading symbol, including bid and ask depth levels.

This endpoint returns real-time orderbook data for the specified trading pair (symbol).

The response includes arrays of bid and ask prices with corresponding quantities, allowing clients to visualize market depth and liquidity.

It is primarily used for building trading interfaces, monitoring market movements, or executing orderbook–based strategies.

Optional parameters such as limit can be used to control the number of depth levels returned.

Authentication with a valid API key and read permission scope is required.

Get Orderbook

get

Required scopes

This endpoint requires the following scopes:

Authorizations

thirdPartyApiKeyAuth

api-keystringRequired

For third party retail API users

Query parameters

symbolstringRequired

Trading symbol

Example: BTCUSDT.PERPPattern: ^[A-Z0-9]+(\.[A-Z0-9]+)?$

Responses

200

OK

application/json

get

/api/v1/market/orderbook

HTTPcURLJavaScriptPython

GET /api/v1/market/orderbook?symbol=BTCUSDT.PERP HTTP/1.1
Host: trading-api.flipster.io
api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "symbol": "BTCUSDT.PERP",
  "bids": [
    [
      "###.###",
      "###.###"
    ]
  ],
  "asks": [
    [
      "###.###",
      "###.###"
    ]
  ]
}