---
title: "Get order book"
method: GET
path: "/v1/orderbook/{symbol}"
tags: ["Order Book"]
---

# Get order book

`GET /v1/orderbook/{symbol}`

Returns the current aggregated order book for a symbol

## Path parameters

- `symbol` string, required

## Query parameters

- `depth` integer

## Response `200`

A successful response.

- GetOrderBookResponse — Response containing the order book snapshot.
  - `symbol` string
  - `bids` BookEntry[]
    - `px` string, int64
    - `qty` string, int64
  - `offers` BookEntry[]
    - `px` string, int64
    - `qty` string, int64
  - `state` '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' — **PENDING**: Initial state for a newly created instrument which has not yet begun trading. **CLOSED**: No order entry, modification, cancellation, or matching. Day orders expired. **OPEN**: Continuous order entry and matching. **PREOPEN**: Orders accepted, no matching. Dutch Auction on transition to OPEN. **MATCH_AND_CLOSE_AUCTION**: Like PREOPEN, matches on transition out. **SUSPENDED**: Cancel only. No entry, modification, or matching. **HALTED**: Like SUSPENDED, no cancels allowed. **EXPIRED**: All resting orders expired, no new orders. **TERMINATED**: Order book removed, all orders and positions closed.
  - `stats` InstrumentStats — InstrumentStats contains statistics about an instrument.
    - `openPx` string, int64
    - `closePx` string, int64
    - `lowPx` string, int64
    - `highPx` string, int64
    - `lastTradePx` string, int64 — Last trade price.
    - `lastTradeQty` string, int64 — Quantity of the most recent trade. Populated after any trade executes on the instrument.
    - `indicativeOpenPx` string, int64
    - `settlementPx` string, int64
    - `settlementSetTime` string, date-time — Timestamp when the settlement price was set. Only populated when the instrument is in a settled state: CLOSED, TERMINATED, or EXPIRED.
    - `settlementPreliminary` boolean
    - `settlementPriceCalculationMethod` string
    - `settlementPriceCalculationText` string
    - `sharesTraded` string, int64
    - `notionalTraded` string, int64
    - `openInterest` string, int64
  - `transactTime` string, date-time

---

[API](https://skmtc.net/polymarket/apis/portfolio-api.md) · [All operations](https://skmtc.net/polymarket/apis/portfolio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polymarket/portfolio-api/revisions/150874842db1/schema)