Files

T

GLaDOS a1d6a46f74 docs: refresh all documentation - fill 98 empty files and update changelog

Date: 2026-06-19

Changes:
- Fixed 98 empty .md files that had failed to scrape
- Updated changelog with latest entries (Jun 15, 2026: CLOB DELETE /orders limit reduced to 1000)
- Refreshed FAQ, Polymarket Learn, Developers, and other sections

Notable updates:
- Jun 15, 2026: CLOB DELETE /orders maximum batch size reduced to 1000
- Jun 1, 2026: Increased CLOB order rate limits
- May 18, 2026: builderCode added to builders endpoints
- May 14, 2026: GET /markets/keyset limit reduced to 100

2026-06-19 14:09:52 +02:00

18 KiB

Raw Permalink Blame History

Documentation Index

Fetch the complete documentation index at: https://docs.polymarket.com/llms.txt Use this file to discover all available pages before exploring further.

Public Methods

These methods can be called without a signer or user credentials. Use these for reading market data, prices, and order books.

Client Initialization

Public methods require the client to initialize with the host URL and Polygon chain ID.

```typescript theme={null} import { ClobClient } from "@polymarket/clob-client-v2";

const client = new ClobClient({
  host: "https://clob.polymarket.com",
  chain: 137,
});

// Ready to call public methods
const markets = await client.getMarkets();
```

```python theme={null} from py_clob_client_v2 import ClobClient

client = ClobClient(
    host="https://clob.polymarket.com",
    chain_id=137
)

# Ready to call public methods
markets = client.get_markets()
```

Health Check

getOk

Health check endpoint to verify the CLOB service is operational.

async getOk(): Promise<any>

Markets

getMarket

Get details for a single market by condition ID.

async getMarket(conditionId: string): Promise<Market>

Timestamp from which the market started accepting orders, or null if not set. Whether the market is currently accepting orders. Whether the market is active. Whether the market has been archived. Whether the market is closed. The unique condition ID for the market. Human-readable description of the market. Whether the order book is enabled for this market. ISO 8601 end date of the market. Address of the Fixed Product Market Maker contract. Start time of the underlying game or event. URL of the market icon image. URL of the market image. Whether the market has equal 50/50 outcomes. Base fee charged to makers in basis points. URL-friendly slug identifier for the market. Minimum order size allowed in this market. Minimum price increment allowed in this market. Whether the market uses negative risk (binary complementary tokens). Negative risk market identifier, if applicable. Negative risk request identifier, if applicable. Whether notifications are enabled for this market. The market question text. Unique identifier for the market question. Object containing reward config: `max_spread` (number), `min_size` (number), `rates` (any) Delay in seconds before orders are processed. List of tags associated with the market. Base fee charged to takers in basis points. Array of market tokens, each containing `outcome` (string), `price` (number), `token_id` (string), and `winner` (boolean).

getMarkets

Get details for multiple markets paginated.

async getMarkets(): Promise<PaginationPayload>

Maximum number of results per page. Total number of markets returned. Array of Market objects. See `getMarket()` for the full Market structure.

getSimplifiedMarkets

Get simplified market data paginated for faster loading.

async getSimplifiedMarkets(): Promise<PaginationPayload>

Maximum number of results per page. Total number of markets returned. Array of simplified market objects, each containing `accepting_orders` (boolean), `active` (boolean), `archived` (boolean), `closed` (boolean), `condition_id` (string), `rewards` (object with `rates`, `min_size`, `max_spread`), and `tokens` (SimplifiedToken\[]) with `outcome` (string), `price` (number), `token_id` (string).

getSamplingMarkets

Get markets eligible for sampling/liquidity rewards.

async getSamplingMarkets(): Promise<PaginationPayload>

getSamplingSimplifiedMarkets

Get simplified market data for markets eligible for sampling/liquidity rewards.

async getSamplingSimplifiedMarkets(): Promise<PaginationPayload>

Order Books and Prices

calculateMarketPrice

Calculate the estimated price for a market order of a given size.

async calculateMarketPrice(
  tokenID: string,
  side: Side,
  amount: number,
  orderType: OrderType = OrderType.FOK
): Promise<number>

The token ID to calculate the market price for. The side of the order. One of: `BUY`, `SELL` The size of the order to calculate price for. The order type. One of: `GTC` (Good Till Cancelled), `FOK` (Fill or Kill), `GTD` (Good Till Date), `FAK` (Fill and Kill). Defaults to `FOK`. The calculated estimated market price for the given order size.

getOrderBook

Get the order book for a specific token ID.

async getOrderBook(tokenID: string): Promise<OrderBookSummary>

The market condition ID. The token/asset ID for this order book. Timestamp of the order book snapshot. Array of bid entries, each with `price` (string) and `size` (string). Array of ask entries, each with `price` (string) and `size` (string). Minimum order size for this market. Minimum price increment for this market. Whether the market uses negative risk. Hash of the order book state.

getOrderBooks

Get order books for multiple token IDs.

async getOrderBooks(params: BookParams[]): Promise<OrderBookSummary[]>

The token ID to fetch the order book for. The side of the book to query. One of: `BUY`, `SELL` Array of OrderBookSummary objects. See `getOrderBook()` for the full structure.

getPrice

Get the current best price for buying or selling a token ID.

async getPrice(
  tokenID: string,
  side: "BUY" | "SELL"
): Promise<any>

The current best price for the requested side.

getPrices

Get the current best prices for multiple token IDs.

async getPrices(params: BookParams[]): Promise<PricesResponse>

A map of token IDs to their prices. Each entry contains an optional `BUY` (string) and/or `SELL` (string) price.

getMidpoint

Get the midpoint price (average of best bid and best ask) for a token ID.

async getMidpoint(tokenID: string): Promise<any>

The midpoint price, calculated as the average of best bid and best ask.

getMidpoints

Get the midpoint prices for multiple token IDs.

async getMidpoints(params: BookParams[]): Promise<any>

A map of token IDs to their midpoint price strings. Each key is a token ID and its value is the midpoint price as a string.

getSpread

Get the spread (difference between best ask and best bid) for a token ID.

async getSpread(tokenID: string): Promise<SpreadResponse>

The spread value, calculated as the difference between best ask and best bid.

getSpreads

Get the spreads for multiple token IDs.

async getSpreads(params: BookParams[]): Promise<SpreadsResponse>

A map of token IDs to their spread strings. Each key is a token ID and its value is the spread as a string.

getPricesHistory

Get historical price data for a token.

async getPricesHistory(params: PriceHistoryFilterParams): Promise<MarketPrice[]>

The token ID to fetch price history for. Optional start timestamp (Unix seconds) for the price history range. Optional end timestamp (Unix seconds) for the price history range. Optional fidelity/resolution of the price history data. Time interval for the price history. One of: `max`, `1w`, `1d`, `6h`, `1h` Unix timestamp of the price data point. Price value at the corresponding timestamp.

Trades

getLastTradePrice

Get the price of the most recent trade for a token.

async getLastTradePrice(tokenID: string): Promise<LastTradePrice>

The price of the most recent trade. The side of the most recent trade.

getLastTradesPrices

Get the most recent trade prices for multiple tokens.

async getLastTradesPrices(params: BookParams[]): Promise<LastTradePriceWithToken[]>

The price of the most recent trade for the token. The side of the most recent trade. The token ID this trade price corresponds to.

getMarketTradesEvents

Get recent trade events for a market.

async getMarketTradesEvents(conditionID: string): Promise<MarketTradeEvent[]>

The type of trade event. Object containing market info: `condition_id` (string), `asset_id` (string), `question` (string), `icon` (string), `slug` (string). Object containing user info: `address` (string), `username` (string), `profile_picture` (string), `optimized_profile_picture` (string), `pseudonym` (string). The side of the trade. One of: `BUY`, `SELL` The size of the trade. The fee rate in basis points for the trade. The price at which the trade was executed. The outcome label for the traded token. The index of the outcome in the market. The on-chain transaction hash for the trade. The timestamp of when the trade event occurred.

Market Parameters

getClobMarketInfo

Fetch all CLOB-level parameters for a market in a single call — tokens, tick size, base fees, rewards config, RFQ status, and fee details.

async getClobMarketInfo(conditionID: string): Promise<ClobMarketDetails>

The condition ID of the market.

Response (ClobMarketDetails)

Game start time (used for sports markets), ISO 8601 timestamp or `null`. Rewards configuration for the market. Tokens for this market. Each entry has:

t (string) — token ID
o (string) — outcome label (e.g. Yes, No)

Minimum order size. Minimum tick size (price increment). Maker base fee in basis points. Taker base fee in basis points. Whether RFQ (Request for Quote) is enabled for this market. Whether taker order delay is enabled. Whether Blockaid check is enabled. Fee curve parameters:

r (number) — fee rate
e (number) — fee curve exponent
to (boolean) — whether fees apply to takers only

Minimum order age in seconds.

getFeeRateBps

Get the fee rate in basis points for a token.

async getFeeRateBps(tokenID: string): Promise<number>

The fee rate in basis points for the specified token.

getFeeExponent

Get the fee curve exponent for a token. The exponent shapes the fee curve used by the protocol when calculating fees at match time.

async getFeeExponent(tokenID: string): Promise<number>

The fee curve exponent for the specified token's market.

getTickSize

Get the tick size (minimum price increment) for a market.

async getTickSize(tokenID: string): Promise<TickSize>

The tick size for the market. One of: `0.1`, `0.01`, `0.001`, `0.0001`

getNegRisk

Check if a market uses negative risk (binary complementary tokens).

async getNegRisk(tokenID: string): Promise<boolean>

Whether the market uses negative risk.

Time and Server Info

getServerTime

Get the current server timestamp.

async getServerTime(): Promise<number>

Unix timestamp in seconds representing the current server time.

18 KiB Raw Permalink Blame History

Documentation Index