You are viewing documentation for Polymarket US πΊπΈ
curl --request GET \
--url https://api.prod.polymarketexchange.com/v1/orderbook/{symbol}/bbo{
"symbol": "<string>",
"bestBid": {
"px": "<string>",
"qty": "<string>"
},
"bestOffer": {
"px": "<string>",
"qty": "<string>"
},
"spread": "<string>",
"midPrice": "<string>",
"state": "INSTRUMENT_STATE_CLOSED",
"transactTime": "2023-11-07T05:31:56Z"
}Returns the top of book (best bid and offer) for a symbol
curl --request GET \
--url https://api.prod.polymarketexchange.com/v1/orderbook/{symbol}/bbo{
"symbol": "<string>",
"bestBid": {
"px": "<string>",
"qty": "<string>"
},
"bestOffer": {
"px": "<string>",
"qty": "<string>"
},
"spread": "<string>",
"midPrice": "<string>",
"state": "INSTRUMENT_STATE_CLOSED",
"transactTime": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://docs.polymarket.us/llms.txt
Use this file to discover all available pages before exploring further.
Instrument symbol (e.g., "BTC-USD")
A successful response.
Response containing the best bid and offer.
BookEntry lists a price and volume for a market data record.
Show child attributes
BookEntry lists a price and volume for a market data record.
Show child attributes
InstrumentState represents the state of an instrument.
INSTRUMENT_STATE_CLOSED, INSTRUMENT_STATE_OPEN, INSTRUMENT_STATE_PREOPEN, INSTRUMENT_STATE_SUSPENDED, INSTRUMENT_STATE_EXPIRED, INSTRUMENT_STATE_TERMINATED, INSTRUMENT_STATE_HALTED, INSTRUMENT_STATE_MATCH_AND_CLOSE_AUCTION, INSTRUMENT_STATE_PENDING