predictionOutcomeOrderBooks

Prediction Market data is currently in beta. It is actively being worked on and improved, but may be unreliable. Polymarket and Kalshi data are live.At least for the time being, this endpoint requires a Growth or Enterprise plan. Learn more.

This endpoint requires a Growth or Enterprise plan. Learn more.

Returns

[PredictionOutcomeOrderBook]!

See PredictionOutcomeOrderBook

Show Properties

String!

The composite outcome ID.

PredictionProtocol!

The protocol that provides this market. See PredictionProtocol

String!

The venue-specific outcome / asset / token ID used by the venue’s CLOB.

[PredictionOrderBookLevel!]!

Bids ordered such that the last element is the best (highest) bid. Empty when no book is available. See PredictionOrderBookLevel

[PredictionOrderBookLevel!]!

Asks ordered such that the last element is the best (lowest) ask. Empty when no book is available. See PredictionOrderBookLevel

Int!

Venue-reported timestamp for the snapshot, in unix seconds. 0 when no book is available.

String

Total bid-side notional liquidity in USD across all bid levels in the venue’s CLOB. Null when no book is available.

String

Total bid-side notional liquidity in collateral token units across all bid levels in the venue’s CLOB. Null when no book is available.

Arguments

[String!]!

required

The composite outcome IDs to fetch order books for. One entry returned per requested ID, in input order; null when the outcome is unknown or the venue is unsupported.

Example

Test this query in the Explorer →

{
  predictionOutcomeOrderBooks(
    outcomeIds: ["111080671036126109659854287535401661966194360665829017654832975124868412594547:Polymarket:0xc5d563a36ae78145c45a50134d48a1215220f80a:137"]
  ) {
    outcomeId
    protocol
    timestamp
    bookLiquidityUsd
    bids {
      price
      size
    }
    asks {
      price
      size
    }
  }
}

Usage Guidelines

One entry is returned per requested outcomeId, in input order; entries are null when the outcome is unknown or the venue is unsupported
bids and asks are ordered so the last element is the best (highest) bid or best (lowest) ask; both arrays are empty when no book is available
timestamp is the venue-reported snapshot time in unix seconds, and is 0 when no book is available
Order books are fetched from the venue’s CLOB and cached for up to 10 seconds

⌘I

API Documentation

Queries

Mutations

Subscriptions

Types

predictionOutcomeOrderBooks

Returns

Arguments

Example

Usage Guidelines

​Returns

​Arguments

​Example

​Usage Guidelines

Returns

Arguments

Example

Usage Guidelines