---
title: "Get Market Book"
method: GET
path: "/v1/markets/{slug}/book"
tags: ["Markets"]
---

# Get Market Book

`GET /v1/markets/{slug}/book`

Retrieve current market data (order book, stats) for a specific market by its slug

## Path parameters

- `slug` string, required

## Response `200`

Market data including order book and stats

- GatewayMarketV1GetMarketBookResponse — Response containing market book data including order book and stats
  - `marketData` SharedMarketDataV1MarketData
    - `marketSlug` string
    - `bids` SharedMarketDataV1BookEntry[]
      - `px` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `qty` string
    - `offers` SharedMarketDataV1BookEntry[]
      - `px` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `qty` string
    - `state` 'MARKET_STATE_OPEN' | 'MARKET_STATE_PREOPEN' | 'MARKET_STATE_SUSPENDED' | 'MARKET_STATE_EXPIRED' | 'MARKET_STATE_TERMINATED' | 'MARKET_STATE_HALTED' | 'MARKET_STATE_MATCH_AND_CLOSE_AUCTION'
    - `stats` SharedMarketDataV1MarketStats — MarketStats are a collection of stats on an instrument.
      - `openPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `closePx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `lowPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `highPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `lastTradePx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `indicativeOpenPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `settlementPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `sharesTraded` string
      - `notionalTraded` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `lastTradeQty` string
      - `openInterest` string
      - `settlementPreliminaryFlag` boolean
      - `openSetTime` string, date-time
      - `closeSetTime` string, date-time
      - `highSetTime` string, date-time
      - `lowSetTime` string, date-time
      - `lastTradeSetTime` string, date-time
      - `indicativeOpenSetTime` string, date-time
      - `settlementSetTime` string, date-time
      - `openInterestSetTime` string, date-time
      - `notionalSetTime` string, date-time
      - `settlementPriceCalculationMethod` 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_1' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_1' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_2' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_3' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_4' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_1' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_2' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_3' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_4' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_OVERRIDE' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_5' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_6' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_7' | 'SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_8' — SettlementPriceCalculationMethod indicates the settlement price calculation method of the book. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_1: If using the VWAP Settlement Price Logic, indicates that there were enough trades to calculate the settlement price using Volume Weighted Average Price - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_1: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Bid / Best Ask / Last Trade existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_2: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Bid / Best Ask existing and Last Trade not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_3: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Bid / Last Trade existing and Best Ask not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_4: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Bid existing and Best Ask / Last Trade not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_1: Indicates that the settlement price was set as a result of "PerformResolution". In addition, settlement prices that have this calculation method are considered final and will no longer be updated by the Settlement Price Module. - SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_2: If using the EVENT Settlement Price Logic, indicates that the settlement price was set to the price of the trading day's latest trade for the Opposing Side = "As Defined" sub type - SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_3: If using the EVENT Settlement Price Logic, indicates that at the market close no trades for the Opposing Side = "As Defined" sub type during the trade day, and therefore the settlement price was set to the current settlement price - SETTLEMENT_PRICE_CALCULATION_METHOD_EVENT_TIER_4: If using the EVENT Settlement Price Logic, indicates that there were no trades for the Opposing Side = "As Defined" sub type during the trade day, nor current settlement price, and therefore the settlement price was set to 0 - SETTLEMENT_PRICE_CALCULATION_METHOD_OVERRIDE: Indicates the calculated settlement price was overridden by the exchange - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_5: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Ask / Last Trade existing and Best Bid not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_6: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Ask existing and Best Bid / Last Trade not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_7: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Last Trade existing and Best Bid / Best Ask not existing. - SETTLEMENT_PRICE_CALCULATION_METHOD_VWAP_TIER_2_RULE_8: If using the VWAP Settlement Price Logic, indicates that there weren't enough trades to calculate the settlement price using VWAP, and the Best Bid / Best Ask / Last Trade / Previous Settlement logic was used instead, with Best Bid / Best Ask / Last Trade not existing.
      - `tradingReferencePx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `tradingReferenceSetTime` string, date-time — Time at which the trading reference price was set.
      - `currentPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
        - `value` string, decimal, required — The amount as a decimal string.
        - `currency` string, required — The currency code
      - `lastPriceSample` SharedMarketDataV1PriceSample
        - `longPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
          - `value` string, decimal, required — The amount as a decimal string.
          - `currency` string, required — The currency code
        - `shortPx` GatewayTypesV1Amount — Represents a monetary amount with its currency.
          - `value` string, decimal, required — The amount as a decimal string.
          - `currency` string, required — The currency code
        - `ts` string, date-time
    - `transactTime` string, date-time

## Other responses

- `404` — Market not found
- `500` — Internal server error

---

[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)