docs: sync Polymarket docs update 2026-05-22
This commit is contained in:
Etherdrake
@@ -1 +1,189 @@
|
||||
null
|
||||
> ## 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 CLOB market info
|
||||
|
||||
> Returns all CLOB-level parameters for a market in a single call —
|
||||
tokens, tick size, base fees, rewards, RFQ status, and fee details.
|
||||
|
||||
|
||||
|
||||
|
||||
## OpenAPI
|
||||
|
||||
````yaml /api-spec/clob-openapi.yaml get /clob-markets/{condition_id}
|
||||
openapi: 3.1.0
|
||||
info:
|
||||
title: Polymarket CLOB API
|
||||
description: Polymarket CLOB API Reference
|
||||
license:
|
||||
name: MIT
|
||||
identifier: MIT
|
||||
version: 1.0.0
|
||||
servers:
|
||||
- url: https://clob.polymarket.com
|
||||
description: Production CLOB API
|
||||
- url: https://clob-staging.polymarket.com
|
||||
description: Staging CLOB API
|
||||
security: []
|
||||
tags:
|
||||
- name: Trade
|
||||
description: Trade endpoints
|
||||
- name: Markets
|
||||
description: Market data endpoints
|
||||
- name: Account
|
||||
description: Account and authentication endpoints
|
||||
- name: Notifications
|
||||
description: User notification endpoints
|
||||
- name: Rewards
|
||||
description: Rewards and earnings endpoints
|
||||
- name: Rebates
|
||||
description: Maker rebate endpoints
|
||||
paths:
|
||||
/clob-markets/{condition_id}:
|
||||
get:
|
||||
tags:
|
||||
- Markets
|
||||
summary: Get CLOB market info
|
||||
description: |
|
||||
Returns all CLOB-level parameters for a market in a single call —
|
||||
tokens, tick size, base fees, rewards, RFQ status, and fee details.
|
||||
operationId: getClobMarketInfo
|
||||
parameters:
|
||||
- name: condition_id
|
||||
in: path
|
||||
required: true
|
||||
description: The condition ID of the market
|
||||
schema:
|
||||
type: string
|
||||
example: '0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af'
|
||||
responses:
|
||||
'200':
|
||||
description: Successfully retrieved CLOB market info
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ClobMarketDetails'
|
||||
'400':
|
||||
description: Bad request - Invalid condition ID
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
'500':
|
||||
description: Internal server error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
components:
|
||||
schemas:
|
||||
ClobMarketDetails:
|
||||
type: object
|
||||
description: >-
|
||||
CLOB-level parameters for a market — tokens, tick size, base fees,
|
||||
rewards, RFQ status, and fee details.
|
||||
properties:
|
||||
gst:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
description: >-
|
||||
Game start time (used for sports markets), ISO 8601 timestamp or
|
||||
null
|
||||
r:
|
||||
$ref: '#/components/schemas/ClobRewards'
|
||||
t:
|
||||
type: array
|
||||
description: Tokens for this market
|
||||
items:
|
||||
$ref: '#/components/schemas/ClobToken'
|
||||
mos:
|
||||
type: number
|
||||
format: float
|
||||
description: Minimum order size
|
||||
example: 5
|
||||
mts:
|
||||
type: number
|
||||
format: float
|
||||
description: Minimum tick size (price increment)
|
||||
example: 0.01
|
||||
mbf:
|
||||
type: integer
|
||||
format: int64
|
||||
description: Maker base fee in basis points
|
||||
example: 0
|
||||
tbf:
|
||||
type: integer
|
||||
format: int64
|
||||
description: Taker base fee in basis points
|
||||
example: 0
|
||||
rfqe:
|
||||
type: boolean
|
||||
description: Whether RFQ (Request for Quote) is enabled for this market
|
||||
itode:
|
||||
type: boolean
|
||||
description: Whether taker order delay is enabled
|
||||
ibce:
|
||||
type: boolean
|
||||
description: Whether Blockaid check is enabled
|
||||
fd:
|
||||
$ref: '#/components/schemas/FeeDetails'
|
||||
oas:
|
||||
type: integer
|
||||
description: Minimum order age in seconds
|
||||
ErrorResponse:
|
||||
type: object
|
||||
required:
|
||||
- error
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
description: Error message
|
||||
code:
|
||||
type: string
|
||||
description: Machine-readable error code, when provided
|
||||
retry_after_seconds:
|
||||
type: integer
|
||||
description: Number of seconds to wait before retrying, when provided
|
||||
ClobRewards:
|
||||
type: object
|
||||
description: Rewards configuration for a market.
|
||||
additionalProperties: true
|
||||
ClobToken:
|
||||
type: object
|
||||
description: A token in a CLOB market with its ID and outcome label.
|
||||
properties:
|
||||
t:
|
||||
type: string
|
||||
description: The token ID
|
||||
example: >-
|
||||
71321045679252212594626385532706912750332728571942532289631379312455583992563
|
||||
o:
|
||||
type: string
|
||||
description: Outcome label for the token (e.g. "Yes", "No")
|
||||
example: 'Yes'
|
||||
FeeDetails:
|
||||
type: object
|
||||
description: Fee curve parameters for a market.
|
||||
properties:
|
||||
r:
|
||||
type: number
|
||||
format: float
|
||||
nullable: true
|
||||
description: Fee rate
|
||||
example: 0.02
|
||||
e:
|
||||
type: number
|
||||
format: float
|
||||
nullable: true
|
||||
description: Fee curve exponent
|
||||
example: 2
|
||||
to:
|
||||
type: boolean
|
||||
nullable: true
|
||||
description: Whether fees apply to takers only
|
||||
example: true
|
||||
|
||||
````
|
||||
@@ -0,0 +1,137 @@
|
||||
> ## 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 wallet is deployed
|
||||
|
||||
> Returns whether the wallet at the given address is deployed onchain.
|
||||
|
||||
Use the `type` query parameter to choose which wallet type to check:
|
||||
|
||||
- Pass user's Polymarket `SAFE` address (default): Gnosis Safe (SignatureType `2`).
|
||||
- Pass user's Polymarket `WALLET` Deposit Wallet address: Deposit Wallet (signatureType `3`). See the [Deposit Wallet Guide](/trading/deposit-wallets) for setup.
|
||||
|
||||
Omitting `type` is equivalent to `type=SAFE`.
|
||||
|
||||
|
||||
|
||||
|
||||
## OpenAPI
|
||||
|
||||
````yaml /api-spec/relayer-openapi.yaml get /deployed
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Polymarket Relayer API
|
||||
version: 1.0.0
|
||||
description: HTTP API for the Polymarket Relayer. Submit and track gasless transactions.
|
||||
servers:
|
||||
- url: https://relayer-v2.polymarket.com
|
||||
description: Polymarket Relayer API
|
||||
security: []
|
||||
tags:
|
||||
- name: Relayer
|
||||
description: Relayer transaction operations
|
||||
- name: Relayer API Keys
|
||||
description: >
|
||||
Relayer API keys let a user authenticate requests to relayer endpoints
|
||||
without Gamma auth.
|
||||
|
||||
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:
|
||||
get:
|
||||
tags:
|
||||
- Relayer
|
||||
summary: Check if a wallet is deployed
|
||||
description: >
|
||||
Returns whether the wallet at the given address is deployed onchain.
|
||||
|
||||
|
||||
Use the `type` query parameter to choose which wallet type to check:
|
||||
|
||||
|
||||
- Pass user's Polymarket `SAFE` address (default): Gnosis Safe
|
||||
(SignatureType `2`).
|
||||
|
||||
- Pass user's Polymarket `WALLET` Deposit Wallet address: Deposit Wallet
|
||||
(signatureType `3`). See the [Deposit Wallet
|
||||
Guide](/trading/deposit-wallets) for setup.
|
||||
|
||||
|
||||
Omitting `type` is equivalent to `type=SAFE`.
|
||||
parameters:
|
||||
- name: address
|
||||
in: query
|
||||
required: true
|
||||
description: Address of the wallet to check
|
||||
schema:
|
||||
$ref: '#/components/schemas/Address'
|
||||
example: '0x6d8c4e9aDF5748Af82Dabe2C6225207770d6B4fa'
|
||||
- name: type
|
||||
in: query
|
||||
required: false
|
||||
description: Wallet type to check. Defaults to `SAFE` when omitted.
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- SAFE
|
||||
- WALLET
|
||||
default: SAFE
|
||||
example: WALLET
|
||||
responses:
|
||||
'200':
|
||||
description: Deployment status retrieved successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DeployedResponse'
|
||||
example:
|
||||
deployed: true
|
||||
'400':
|
||||
description: Bad Request - Missing or invalid address
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
example:
|
||||
error: invalid address
|
||||
'500':
|
||||
description: Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
components:
|
||||
schemas:
|
||||
Address:
|
||||
type: string
|
||||
description: Ethereum address (0x-prefixed, 40 hex chars)
|
||||
pattern: ^0x[a-fA-F0-9]{40}$
|
||||
example: '0x6e0c80c90ea6c15917308F820Eac91Ce2724B5b5'
|
||||
DeployedResponse:
|
||||
type: object
|
||||
properties:
|
||||
deployed:
|
||||
type: boolean
|
||||
description: Whether the wallet is deployed
|
||||
example: true
|
||||
ErrorResponse:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
required:
|
||||
- error
|
||||
|
||||
````
|
||||
@@ -0,0 +1,137 @@
|
||||
> ## 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 wallet is deployed
|
||||
|
||||
> Returns whether the wallet at the given address is deployed onchain.
|
||||
|
||||
Use the `type` query parameter to choose which wallet type to check:
|
||||
|
||||
- Pass user's Polymarket `SAFE` address (default): Gnosis Safe (SignatureType `2`).
|
||||
- Pass user's Polymarket `WALLET` Deposit Wallet address: Deposit Wallet (signatureType `3`). See the [Deposit Wallet Guide](/trading/deposit-wallets) for setup.
|
||||
|
||||
Omitting `type` is equivalent to `type=SAFE`.
|
||||
|
||||
|
||||
|
||||
|
||||
## OpenAPI
|
||||
|
||||
````yaml /api-spec/relayer-openapi.yaml get /deployed
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: Polymarket Relayer API
|
||||
version: 1.0.0
|
||||
description: HTTP API for the Polymarket Relayer. Submit and track gasless transactions.
|
||||
servers:
|
||||
- url: https://relayer-v2.polymarket.com
|
||||
description: Polymarket Relayer API
|
||||
security: []
|
||||
tags:
|
||||
- name: Relayer
|
||||
description: Relayer transaction operations
|
||||
- name: Relayer API Keys
|
||||
description: >
|
||||
Relayer API keys let a user authenticate requests to relayer endpoints
|
||||
without Gamma auth.
|
||||
|
||||
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:
|
||||
get:
|
||||
tags:
|
||||
- Relayer
|
||||
summary: Check if a wallet is deployed
|
||||
description: >
|
||||
Returns whether the wallet at the given address is deployed onchain.
|
||||
|
||||
|
||||
Use the `type` query parameter to choose which wallet type to check:
|
||||
|
||||
|
||||
- Pass user's Polymarket `SAFE` address (default): Gnosis Safe
|
||||
(SignatureType `2`).
|
||||
|
||||
- Pass user's Polymarket `WALLET` Deposit Wallet address: Deposit Wallet
|
||||
(signatureType `3`). See the [Deposit Wallet
|
||||
Guide](/trading/deposit-wallets) for setup.
|
||||
|
||||
|
||||
Omitting `type` is equivalent to `type=SAFE`.
|
||||
parameters:
|
||||
- name: address
|
||||
in: query
|
||||
required: true
|
||||
description: Address of the wallet to check
|
||||
schema:
|
||||
$ref: '#/components/schemas/Address'
|
||||
example: '0x6d8c4e9aDF5748Af82Dabe2C6225207770d6B4fa'
|
||||
- name: type
|
||||
in: query
|
||||
required: false
|
||||
description: Wallet type to check. Defaults to `SAFE` when omitted.
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- SAFE
|
||||
- WALLET
|
||||
default: SAFE
|
||||
example: WALLET
|
||||
responses:
|
||||
'200':
|
||||
description: Deployment status retrieved successfully
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/DeployedResponse'
|
||||
example:
|
||||
deployed: true
|
||||
'400':
|
||||
description: Bad Request - Missing or invalid address
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
example:
|
||||
error: invalid address
|
||||
'500':
|
||||
description: Server Error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ErrorResponse'
|
||||
components:
|
||||
schemas:
|
||||
Address:
|
||||
type: string
|
||||
description: Ethereum address (0x-prefixed, 40 hex chars)
|
||||
pattern: ^0x[a-fA-F0-9]{40}$
|
||||
example: '0x6e0c80c90ea6c15917308F820Eac91Ce2724B5b5'
|
||||
DeployedResponse:
|
||||
type: object
|
||||
properties:
|
||||
deployed:
|
||||
type: boolean
|
||||
description: Whether the wallet is deployed
|
||||
example: true
|
||||
ErrorResponse:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
required:
|
||||
- error
|
||||
|
||||
````
|
||||
Reference in New Issue
Block a user