gavindiaz/PolymarketDocumentation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync Polymarket docs - 2026-04-14

Browse Source
This commit is contained in:
Etherdrake
2026-04-14 21:53:47 +02:00
parent 814cdc00c9
commit d8e396519a
263 changed files with 1118 additions and 21257 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/advanced/neg-risk.md
+7 -5
View File
@@ -1,3 +1,7 @@
> ## 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.
# Negative Risk Markets
> Capital-efficient trading for multi-outcome events
@@ -37,7 +41,7 @@ This is capital-efficient because betting against one outcome is economically eq
The Gamma API includes a `negRisk` boolean on events and markets:
```json theme={null}
```json theme={null}
{
"id": "123",
"title": "Who will win the 2024 Presidential Election?",
@@ -48,7 +52,7 @@ The Gamma API includes a `negRisk` boolean on events and markets:
When placing orders on neg risk markets, you must specify this in your order options:
```typescript theme={null}
```typescript theme={null}
const response = await client.createAndPostOrder(
{
tokenID: "TOKEN_ID",
@@ -102,7 +106,7 @@ Standard negative risk requires the complete set of outcomes to be known at mark
An event is augmented neg risk when both flags are true:
```json theme={null}
```json theme={null}
{
"enableNegRisk": true,
"negRiskAugmented": true
@@ -139,5 +143,3 @@ The conversion operation is atomic and happens through the Neg Risk Adapter:
Learn about token operations like split, merge, and redeem.
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/authentication.md
+15 -13
View File
@@ -1,3 +1,7 @@
> ## 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.
# Authentication
> How to authenticate requests to the CLOB API
@@ -57,7 +61,7 @@ Before making authenticated requests, you need to obtain API credentials using L
<Tabs>
<Tab title="TypeScript">
```typescript theme={null}
```typescript theme={null}
import { ClobClient } from "@polymarket/clob-client";
import { Wallet } from "ethers"; // v5.8.0
@@ -80,7 +84,7 @@ Before making authenticated requests, you need to obtain API credentials using L
</Tab>
<Tab title="Python">
```python theme={null}
```python theme={null}
from py_clob_client.client import ClobClient
import os
@@ -103,7 +107,7 @@ Before making authenticated requests, you need to obtain API credentials using L
</Tab>
<Tab title="Rust">
```rust theme={null}
```rust theme={null}
use std::str::FromStr;
use polymarket_client_sdk::POLYGON;
use polymarket_client_sdk::auth::{LocalSigner, Signer};
@@ -137,13 +141,13 @@ While we highly recommend using our provided clients to handle signing and authe
**Create API Credentials**
```bash theme={null}
```bash theme={null}
POST https://clob.polymarket.com/auth/api-key
```
**Derive API Credentials**
```bash theme={null}
```bash theme={null}
GET https://clob.polymarket.com/auth/derive-api-key
```
@@ -221,7 +225,7 @@ Reference implementations:
Response:
```json theme={null}
```json theme={null}
{
"apiKey": "550e8400-e29b-41d4-a716-446655440000",
"secret": "base64EncodedSecretString",
@@ -251,7 +255,7 @@ The `POLY_SIGNATURE` for L2 is an HMAC-SHA256 signature created using the user's
<Tabs>
<Tab title="TypeScript">
```typescript theme={null}
```typescript theme={null}
import { ClobClient } from "@polymarket/clob-client";
import { Wallet } from "ethers"; // v5.8.0
@@ -273,7 +277,7 @@ The `POLY_SIGNATURE` for L2 is an HMAC-SHA256 signature created using the user's
</Tab>
<Tab title="Python">
```python theme={null}
```python theme={null}
from py_clob_client.client import ClobClient
import os
@@ -295,7 +299,7 @@ The `POLY_SIGNATURE` for L2 is an HMAC-SHA256 signature created using the user's
</Tab>
<Tab title="Rust">
```rust theme={null}
```rust theme={null}
use polymarket_client_sdk::clob::types::{Side, SignatureType};
use polymarket_client_sdk::types::dec;
@@ -351,7 +355,7 @@ When initializing the L2 client, you must specify your wallet **signatureType**
<Accordion title="Never expose private keys">
Store private keys in environment variables or secure key management systems. Never commit them to version control.
```bash theme={null}
```bash theme={null}
# .env (never commit this file)
PRIVATE_KEY=0x...
```
@@ -397,7 +401,7 @@ When initializing the L2 client, you must specify your wallet **signatureType**
<Accordion title="Lost both credentials and nonce">
Unfortunately, there's no way to recover lost API credentials without the nonce. You'll need to create new credentials:
```typescript theme={null}
```typescript theme={null}
// Create fresh credentials with a new nonce
const newCreds = await client.createApiKey();
// Save the nonce this time!
@@ -418,5 +422,3 @@ When initializing the L2 client, you must specify your wallet **signatureType**
Check trading availability by region.
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/bridge/create-deposit-addresses.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Create deposit addresses
## OpenAPI
````yaml /api-spec/bridge-openapi.yaml post /deposit
@@ -100,6 +106,4 @@ components:
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x56687bf447db6ffa42ffe2204a05edaa20f55839'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/bridge/create-withdrawal-addresses.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Create withdrawal addresses
## OpenAPI
````yaml /api-spec/bridge-openapi.yaml post /withdraw
@@ -126,6 +132,4 @@ components:
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x56687bf447db6ffa42ffe2204a05edaa20f55839'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/bridge/get-a-quote.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get a quote
## OpenAPI
````yaml /api-spec/bridge-openapi.yaml post /quote
@@ -215,6 +221,4 @@ components:
description: Impact cost of the transaction
example: 0
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/bridge/get-supported-assets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get supported assets
## OpenAPI
````yaml /api-spec/bridge-openapi.yaml get /supported-assets
@@ -90,6 +96,4 @@ components:
description: Token decimals
example: 6
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/bridge/get-transaction-status.md
+12 -4
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get transaction status
## OpenAPI
````yaml /api-spec/bridge-openapi.yaml get /status/{address}
@@ -120,7 +126,11 @@ components:
example: '0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174'
status:
type: string
description: Current status of the transaction
description: >
Current status of the transaction. If a transaction fails, remains
stuck, or funds are held due to a compliance check, direct users to
our Bridge API provider's support
(https://intercom.help/funxyz/en/articles/10732578-contact-us).
enum:
- DEPOSIT_DETECTED
- PROCESSING
@@ -141,6 +151,4 @@ components:
when status is DEPOSIT_DETECTED)
example: 1757531217339
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/builders/get-aggregated-builder-leaderboard.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get aggregated builder leaderboard
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /v1/builders/leaderboard
@@ -107,6 +113,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/builders/get-daily-builder-volume-time-series.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get daily builder volume time-series
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /v1/builders/volume
@@ -96,6 +102,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/clients-sdks.md
+4 -2
View File
@@ -1,3 +1,7 @@
> ## 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.
# Clients & SDKs
> Official open-source libraries for interacting with Polymarket
@@ -102,5 +106,3 @@ For [gasless transactions](/trading/gasless) using proxy wallets, the relayer cl
Understand L1/L2 auth and API credentials.
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/comments/get-comments-by-comment-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get comments by comment id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /comments/{id}
@@ -203,6 +209,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/comments/get-comments-by-user-address.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get comments by user address
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /comments/user_address/{user_address}
@@ -228,6 +234,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/comments/list-comments.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List comments
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /comments
@@ -242,6 +248,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-closed-positions-for-a-user.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get closed positions for a user
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /closed-positions
@@ -185,6 +191,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-current-positions-for-a-user.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get current positions for a user
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /positions
@@ -212,6 +218,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-positions-for-a-market.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get positions for a market
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /v1/market-positions
@@ -184,6 +190,4 @@ components:
outcomeIndex:
type: integer
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-top-holders-for-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get top holders for markets
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /holders
@@ -131,6 +137,4 @@ components:
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x56687bf447db6ffa42ffe2204a05edaa20f55839'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-total-value-of-a-users-positions.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get total value of a user's positions
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /value
@@ -88,6 +94,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-trader-leaderboard-rankings.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get trader leaderboard rankings
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /v1/leaderboard
@@ -152,6 +158,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-trades-for-a-user-or-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get trades for a user or markets
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /trades
@@ -184,6 +190,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/core/get-user-activity.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get user activity
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /activity
@@ -223,6 +229,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/data-api-status/data-api-health-check.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/data/get-midpoint-price.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get midpoint price
> Retrieves the midpoint price for a specific token ID.
The midpoint is calculated as the average of the best bid and best ask prices.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /midpoint
@@ -95,6 +102,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/data/get-server-time.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get server time
> Returns the current Unix timestamp of the server.
This can be used to synchronize client time with server time.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /time
@@ -71,6 +78,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/events/get-event-by-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get event by id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /events/{id}
@@ -1204,6 +1210,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/events/get-event-by-slug.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get event by slug
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /events/slug/{slug}
@@ -1204,6 +1210,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/events/get-event-tags.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get event tags
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /events/{id}/tags
@@ -99,6 +105,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/events/list-events.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List events
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /events
@@ -1314,6 +1320,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/gamma-status/gamma-api-health-check.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/geoblock.md
+9 -7
View File
@@ -1,3 +1,7 @@
> ## 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.
# Geographic Restrictions
> Check geographic restrictions before placing orders on the Polymarket API
@@ -16,7 +20,7 @@ Polymarket restricts order placement from certain geographic locations due to re
Check the geographic eligibility of the requesting IP address:
```bash theme={null}
```bash theme={null}
GET https://polymarket.com/api/geoblock
```
@@ -24,7 +28,7 @@ GET https://polymarket.com/api/geoblock
### Response
```json theme={null}
```json theme={null}
{
"blocked": true,
"ip": "203.0.113.42",
@@ -118,7 +122,7 @@ The geoblocking system includes:
<Tabs>
<Tab title="TypeScript">
```typescript theme={null}
```typescript theme={null}
interface GeoblockResponse {
blocked: boolean;
ip: string;
@@ -143,7 +147,7 @@ The geoblocking system includes:
</Tab>
<Tab title="Python">
```python theme={null}
```python theme={null}
import requests
def check_geoblock() -> dict:
@@ -161,7 +165,7 @@ The geoblocking system includes:
</Tab>
<Tab title="Rust">
```rust theme={null}
```rust theme={null}
use polymarket_client_sdk::clob::Client;
let client = Client::default();
@@ -203,5 +207,3 @@ If you believe you are incorrectly restricted or have questions about geographic
Start placing orders (from eligible regions).
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/introduction.md
+4 -2
View File
@@ -1,3 +1,7 @@
> ## 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.
# Introduction
> Overview of the Polymarket APIs
@@ -53,5 +57,3 @@ The CLOB API has both public endpoints (orderbook, prices) and authenticated end
Official TypeScript, Python, and Rust libraries.
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/market-data/get-fee-rate-by-path-parameter.md
+8 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get fee rate by path parameter
> Retrieves the base fee rate for a specific token ID using the token ID as a path parameter.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /fee-rate/{token_id}
@@ -105,6 +112,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-fee-rate.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get fee rate
> Retrieves the base fee rate for a specific token ID.
The fee rate can be provided either as a query parameter or as a path parameter.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /fee-rate
@@ -108,6 +115,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-last-trade-price.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get last trade price
> Retrieves the last trade price and side for a specific token ID.
Returns default values of "0.5" for price and empty string for side if no trades found.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /last-trade-price
@@ -104,6 +111,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-last-trade-prices-query-parameters.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get last trade prices (query parameters)
> Retrieves last trade prices for multiple token IDs using query parameters.
Maximum 500 token IDs can be requested per call.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /last-trades-prices
@@ -124,6 +131,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-last-trade-prices-request-body.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get last trade prices (request body)
> Retrieves last trade prices for multiple token IDs using a request body.
Maximum 500 token IDs can be requested per call.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /last-trades-prices
@@ -141,6 +148,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-market-price.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get market price
> Retrieves the best market price for a specific token ID and side (bid or ask).
Returns the best bid price for BUY side or best ask price for SELL side.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /price
@@ -123,6 +130,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-market-prices-query-parameters.md
+8 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get market prices (query parameters)
> Retrieves market prices for multiple token IDs and sides using query parameters.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /prices
@@ -120,6 +127,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-market-prices-request-body.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get market prices (request body)
> Retrieves market prices for multiple token IDs and sides using a request body.
Each request must include both token_id and side.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /prices
@@ -135,6 +142,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-midpoint-prices-query-parameters.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get midpoint prices (query parameters)
> Retrieves midpoint prices for multiple token IDs using query parameters.
The midpoint is calculated as the average of the best bid and best ask prices.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /midpoints
@@ -94,6 +101,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-midpoint-prices-request-body.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get midpoint prices (request body)
> Retrieves midpoint prices for multiple token IDs using a request body.
The midpoint is calculated as the average of the best bid and best ask prices.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /midpoints
@@ -113,6 +120,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-order-book.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get order book
> Retrieves the order book summary for a specific token ID.
Includes bids, asks, market details, and last trade price.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /book
@@ -183,6 +190,4 @@ components:
description: Order size
example: '100'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-order-books-request-body.md
+8 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get order books (request body)
> Retrieves order book summaries for multiple token IDs using a request body.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /books
@@ -183,6 +190,4 @@ components:
description: Order size
example: '100'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-spread.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get spread
> Retrieves the spread for a specific token ID.
The spread is the difference between the best ask and best bid prices.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /spread
@@ -93,6 +100,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-spreads.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get spreads
> Retrieves spreads for multiple token IDs.
The spread is the difference between the best ask and best bid prices.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /spreads
@@ -111,6 +118,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-tick-size-by-path-parameter.md
+8 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get tick size by path parameter
> Retrieves the minimum tick size (price increment) for a specific token ID using the token ID as a path parameter.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /tick-size/{token_id}
@@ -105,6 +112,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/market-data/get-tick-size.md
+8 -3
View File
@@ -1,8 +1,15 @@
> ## 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.
# Get tick size
> Retrieves the minimum tick size (price increment) for a specific token ID.
The tick size can be provided either as a query parameter or as a path parameter.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /tick-size
@@ -109,6 +116,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-batch-prices-history.md
+7 -3
View File
@@ -1,7 +1,13 @@
> ## 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.
# Get batch prices history
> Retrieve historical price data for multiple markets in a single request.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml post /batch-prices-history
@@ -129,6 +135,4 @@ components:
type: number
format: float
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-market-by-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get market by id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /markets/{id}
@@ -1200,6 +1206,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-market-by-slug.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get market by slug
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /markets/slug/{slug}
@@ -1200,6 +1206,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-market-tags-by-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get market tags by id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /markets/{id}/tags
@@ -99,6 +105,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-prices-history.md
+7 -3
View File
@@ -1,7 +1,13 @@
> ## 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.
# Get prices history
> Retrieve historical price data for a market.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /prices-history
@@ -128,6 +134,4 @@ components:
type: number
format: float
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-sampling-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get sampling markets
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /sampling-markets
@@ -174,6 +180,4 @@ components:
winner:
type: boolean
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-sampling-simplified-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get sampling simplified markets
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /sampling-simplified-markets
@@ -121,6 +127,4 @@ components:
winner:
type: boolean
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/get-simplified-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get simplified markets
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /simplified-markets
@@ -121,6 +127,4 @@ components:
winner:
type: boolean
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/markets/list-markets.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List markets
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /markets
@@ -1327,6 +1333,4 @@ components:
type: string
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/misc/download-an-accounting-snapshot-zip-of-csvs.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Download an accounting snapshot (ZIP of CSVs)
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /v1/accounting/snapshot
@@ -68,6 +74,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/misc/get-live-volume-for-an-event.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get live volume for an event
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /live-volume
@@ -85,6 +91,4 @@ components:
pattern: ^0x[a-fA-F0-9]{64}$
example: '0xdd22472e552920b8438158ea7238bfadfa4f736aa4cee91a6b86c39ead110917'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/misc/get-open-interest.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get open interest
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /oi
@@ -78,6 +84,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/misc/get-total-markets-a-user-has-traded.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get total markets a user has traded
## OpenAPI
````yaml /api-spec/data-openapi.yaml get /traded
@@ -79,6 +85,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/orderbook/get-multiple-order-books-summaries-by-request.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/orderbook/get-order-book-summary.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/pricing/get-market-price.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/pricing/get-midpoint-price.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/pricing/get-multiple-market-prices-by-request.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/pricing/get-multiple-market-prices.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/pricing/get-price-history-for-a-traded-token.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/profiles/get-public-profile-by-wallet-address.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get public profile by wallet address
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /public-profile
@@ -145,6 +151,4 @@ components:
type: boolean
description: Whether the user is a moderator
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rate-limits.md
+4 -2
View File
@@ -1,3 +1,7 @@
> ## 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.
# Rate Limits
> API rate limits for all Polymarket endpoints
@@ -120,5 +124,3 @@ Trading endpoints have both **burst** limits (short spikes allowed) and **sustai
Official TypeScript, Python, and Rust libraries.
</Card>
</CardGroup>
Built with [Mintlify](https://mintlify.com).
docs/api-reference/rebates/get-current-rebated-fees-for-a-maker.md
+10 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get current rebated fees for a maker
> Returns the current rebated fees for a maker address on a given date.
@@ -6,6 +10,9 @@ Each entry includes the condition ID, asset address, and the USDC amount rebated
This endpoint does not require authentication.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rebates/current
@@ -45,9 +52,11 @@ paths:
description: >
Returns the current rebated fees for a maker address on a given date.
Each entry includes the condition ID, asset address, and the USDC amount
rebated.
This endpoint does not require authentication.
operationId: getCurrentRebatedFees
parameters:
@@ -146,6 +155,4 @@ components:
type: string
description: Error message
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer-api-keys/get-all-relayer-api-keys.md
+10 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get all relayer API keys
> Returns all relayer API keys for the authenticated address. Auth allowed: Gamma auth or Relayer API key auth (`RELAYER_API_KEY` + `RELAYER_API_KEY_ADDRESS`).
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /relayer/api/keys
@@ -25,12 +32,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/relayer/api/keys:
@@ -127,6 +136,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/check-if-a-safe-is-deployed.md
+10 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Check if a safe is deployed
> Returns a payload that determines if a safe is deployed. Takes in the user's Polymarket proxy address.
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /deployed
@@ -25,12 +32,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/deployed:
@@ -94,6 +103,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/get-a-transaction-by-id.md
+10 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get a transaction by ID
> Gets a transaction submitted to the Relayer. Takes in a required transaction ID as a query parameter.
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /transaction
@@ -25,12 +32,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/transaction:
@@ -189,6 +198,4 @@ components:
pattern: ^0x[a-fA-F0-9]{40}$
example: '0x6e0c80c90ea6c15917308F820Eac91Ce2724B5b5'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/get-current-nonce-for-a-user.md
+10 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get current nonce for a user
> Gets the current Proxy or Safe nonce for a user. Takes in the user's signer address and the type of nonce to retrieve.
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /nonce
@@ -25,12 +32,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/nonce:
@@ -109,6 +118,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/get-recent-transactions-for-a-user.md
+12 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get recent transactions for a user
> Gets the most recent transactions submitted to the Relayer, owned by a specific user. Authenticated using Builder API Keys or Relayer API Keys.
@@ -12,6 +16,9 @@
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /transactions
@@ -35,12 +42,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/transactions:
@@ -52,6 +61,7 @@ paths:
Gets the most recent transactions submitted to the Relayer, owned by a
specific user. Authenticated using Builder API Keys or Relayer API Keys.
**Builder API Key auth headers:**
- `POLY_BUILDER_API_KEY`
@@ -62,6 +72,7 @@ paths:
- `POLY_BUILDER_SIGNATURE`
**Relayer API Key auth headers:**
- `RELAYER_API_KEY`
@@ -255,6 +266,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/get-relayer-address-and-nonce.md
+10 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Get relayer address and nonce
> Fetches the relayer address and nonce for a specific user. Takes in the user's signer address and the type of nonce to retrieve.
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml get /relay-payload
@@ -25,12 +32,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/relay-payload:
@@ -114,6 +123,4 @@ components:
required:
- error
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/relayer/submit-a-transaction.md
+12 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Submit a transaction
> Submit a transaction request to the Relayer. Authenticated using Builder API Keys or Relayer API Keys.
@@ -12,6 +16,9 @@
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
## OpenAPI
````yaml /api-spec/relayer-openapi.yaml post /submit
@@ -35,12 +42,14 @@ tags:
However, Relayer API keys can only be created using Gamma auth. Every
address can create a maximum of 100 keys.
The API key auth headers are:
- `RELAYER_API_KEY`
- `RELAYER_API_KEY_ADDRESS`
`RELAYER_API_KEY_ADDRESS` must match the address that owns the key.
paths:
/submit:
@@ -52,6 +61,7 @@ paths:
Submit a transaction request to the Relayer. Authenticated using Builder
API Keys or Relayer API Keys.
**Builder API Key auth headers:**
- `POLY_BUILDER_API_KEY`
@@ -62,6 +72,7 @@ paths:
- `POLY_BUILDER_SIGNATURE`
**Relayer API Key auth headers:**
- `RELAYER_API_KEY`
@@ -279,6 +290,4 @@ components:
description: Refund receiver address
example: '0x0000000000000000000000000000000000000000'
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-current-active-rewards-configurations.md
+10 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get current active rewards configurations
> Returns all current active rewards configurations grouped by market.
@@ -7,6 +11,9 @@ When `sponsored=true`, returns sponsored reward configurations instead.
Results are paginated (500 items per page). Use next_cursor to fetch subsequent pages.
A next_cursor value of "LTE=" indicates the last page.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/markets/current
@@ -46,8 +53,10 @@ paths:
description: >
Returns all current active rewards configurations grouped by market.
When `sponsored=true`, returns sponsored reward configurations instead.
Results are paginated (500 items per page). Use next_cursor to fetch
subsequent pages.
@@ -215,6 +224,4 @@ components:
- start_date
- rate_per_day
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-earnings-for-user-by-date.md
+10 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get earnings for user by date
> Returns an array of user earnings per market for a provided day.
@@ -7,6 +11,9 @@ Requires CLOB L2 Auth headers.
Results are paginated (100 items per page). Use next_cursor to fetch subsequent pages.
A next_cursor value of "LTE=" indicates the last page.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/user
@@ -46,8 +53,10 @@ paths:
description: >
Returns an array of user earnings per market for a provided day.
Requires CLOB L2 Auth headers.
Results are paginated (100 items per page). Use next_cursor to fetch
subsequent pages.
@@ -246,6 +255,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-multiple-markets-with-rewards.md
+9 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get multiple markets with rewards
> Returns a list of active markets with their reward configurations.
@@ -6,6 +10,9 @@ Supports text search, tag filtering, numeric filters, and sorting.
Results are paginated (100 items per page by default). Use next_cursor to fetch subsequent pages.
A next_cursor value of "LTE=" indicates the last page.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/markets/multi
@@ -47,6 +54,7 @@ paths:
Supports text search, tag filtering, numeric filters, and sorting.
Results are paginated (100 items per page by default). Use next_cursor
to fetch subsequent pages.
@@ -396,6 +404,4 @@ components:
- start_date
- rate_per_day
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-raw-rewards-for-a-specific-market.md
+10 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get raw rewards for a specific market
> Returns an array of present and future rewards configured on a market.
@@ -8,6 +12,9 @@ When `sponsored=true`, sponsored daily rates are folded into each config's
Results are paginated (100 items per page). Use next_cursor to fetch subsequent pages.
A next_cursor value of "LTE=" indicates the last page.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/markets/{condition_id}
@@ -47,11 +54,13 @@ paths:
description: >
Returns an array of present and future rewards configured on a market.
When `sponsored=true`, sponsored daily rates are folded into each
config's
`rate_per_day` .
Results are paginated (100 items per page). Use next_cursor to fetch
subsequent pages.
@@ -275,6 +284,4 @@ components:
- start_date
- rate_per_day
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-reward-percentages-for-user.md
+10 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get reward percentages for user
> Returns the real-time percentages of rewards that a user is earning per market.
@@ -7,6 +11,9 @@ the user is currently earning in that market.
Requires CLOB L2 Auth headers.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/user/percentages
@@ -47,10 +54,12 @@ paths:
Returns the real-time percentages of rewards that a user is earning per
market.
The response is a map of condition_id to the percentage of total rewards
the user is currently earning in that market.
Requires CLOB L2 Auth headers.
operationId: getRewardPercentagesForUser
parameters:
@@ -163,6 +172,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-total-earnings-for-user-by-date.md
+8 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get total earnings for user by date
> Returns the summed total rewards earnings for a user on a provided day,
@@ -5,6 +9,9 @@ grouped by asset address.
Requires CLOB L2 Auth headers.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/user/total
@@ -210,6 +217,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/rewards/get-user-earnings-and-markets-configuration.md
+11 -3
View File
@@ -1,3 +1,7 @@
> ## 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.
# Get user earnings and markets configuration
> Returns an array of current rewards including user earnings and live percentages
@@ -14,6 +18,9 @@ Optional features:
- Filter by favorite markets using `favorite_markets=true`
- Sort by various fields using `order_by` and `position` parameters
## OpenAPI
````yaml /api-spec/clob-openapi.yaml get /rewards/user/markets
@@ -56,13 +63,16 @@ paths:
per market for a provided day.
Results are paginated (100 items per page by default, max 500). Use
next_cursor to fetch subsequent pages.
A next_cursor value of "LTE=" indicates the last page.
Requires CLOB L2 Auth headers.
Optional features:
- Search by question/description using the `q` parameter
@@ -484,6 +494,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/search/search-markets-events-and-profiles.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Search markets, events, and profiles
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /public-search
@@ -1358,6 +1364,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/series/get-series-by-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get series by id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /series/{id}
@@ -1200,6 +1206,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/series/list-series.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List series
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /series
@@ -1250,6 +1256,4 @@ components:
type: number
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/sports/get-sports-metadata-information.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get sports metadata information
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /sports
@@ -81,6 +87,4 @@ components:
Series identifier linking the sport to a specific tournament or
season series
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/sports/get-valid-sports-market-types.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get valid sports market types
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /sports/market-types
@@ -56,6 +62,4 @@ components:
items:
type: string
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/sports/list-teams.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List teams
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /teams
@@ -128,6 +134,4 @@ components:
format: date-time
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/spreads/get-bid-ask-spreads.md
+1 -1
View File
@@ -1 +1 @@
null
null
docs/api-reference/tags/get-related-tags-relationships-by-tag-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get related tags (relationships) by tag id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/{id}/related-tags
@@ -85,6 +91,4 @@ components:
type: integer
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/get-related-tags-relationships-by-tag-slug.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get related tags (relationships) by tag slug
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/slug/{slug}/related-tags
@@ -85,6 +91,4 @@ components:
type: integer
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/get-tag-by-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get tag by id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/{id}
@@ -100,6 +106,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/get-tag-by-slug.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get tag by slug
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/slug/{slug}
@@ -100,6 +106,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/get-tags-related-to-a-tag-id.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get tags related to a tag id
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/{id}/related-tags/tags
@@ -108,6 +114,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/get-tags-related-to-a-tag-slug.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# Get tags related to a tag slug
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags/slug/{slug}/related-tags/tags
@@ -108,6 +114,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/tags/list-tags.md
+7 -3
View File
@@ -1,5 +1,11 @@
> ## 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.
# List tags
## OpenAPI
````yaml /api-spec/gamma-openapi.yaml get /tags
@@ -124,6 +130,4 @@ components:
type: boolean
nullable: true
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/trade/cancel-all-orders.md
+8 -3
View File
@@ -1,7 +1,14 @@
> ## 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.
# Cancel all orders
> Cancels all open orders for the authenticated user. Works even in cancel-only mode.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml delete /cancel-all
@@ -160,6 +167,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````
docs/api-reference/trade/cancel-multiple-orders.md
+8 -3
View File
@@ -1,9 +1,16 @@
> ## 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.
# Cancel multiple orders
> Cancels multiple orders by their IDs. Maximum 3000 orders per request.
Duplicate order IDs in the request are automatically ignored.
Works even in cancel-only mode.
## OpenAPI
````yaml /api-spec/clob-openapi.yaml delete /orders
@@ -200,6 +207,4 @@ components:
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
Built with [Mintlify](https://mintlify.com).
````

Some files were not shown because too many files have changed in this diff Show More