Skip to main content
GET
/
v1
/
orderbook
/
{symbol}
Get order book
curl --request GET \
  --url https://api.polymarketexchange.com/v1/orderbook/{symbol}
{
  "symbol": "<string>",
  "bids": [
    {
      "px": "<string>",
      "qty": "<string>"
    }
  ],
  "offers": [
    {
      "px": "<string>",
      "qty": "<string>"
    }
  ],
  "state": "INSTRUMENT_STATE_OPEN",
  "stats": {
    "openPx": "<string>",
    "closePx": "<string>",
    "lowPx": "<string>",
    "highPx": "<string>",
    "lastTradePx": "<string>",
    "indicativeOpenPx": "<string>",
    "settlementPx": "<string>",
    "sharesTraded": "<string>",
    "notionalTraded": "<string>",
    "openInterest": "<string>"
  },
  "transactTime": "2023-11-07T05:31:56Z"
}

Path Parameters

​
symbol
string
required

Instrument symbol (e.g., "BTC-USD")

Query Parameters

​
depth
integer<int32>

Number of price levels to return (default 3, max 10)

Response

200 - application/json

A successful response.

Response containing the order book snapshot.

​
symbol
string
​
bids
Bid side of order book (sorted by price descending) · object[]
​
offers
Offer/ask side of order book (sorted by price ascending) · object[]
​
state
enum<string>

InstrumentState represents the state of an instrument.

Available options:
INSTRUMENT_STATE_OPEN,
INSTRUMENT_STATE_PREOPEN,
INSTRUMENT_STATE_SUSPENDED,
INSTRUMENT_STATE_EXPIRED,
INSTRUMENT_STATE_TERMINATED,
INSTRUMENT_STATE_HALTED,
INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION
​
stats
Market statistics (last trade, open/high/low/close, etc.) · object

InstrumentStats contains statistics about an instrument.

​
transactTime
string<date-time>