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

docs: sync Polymarket documentation (2026-05-03)

Browse Source 
Updated 55 files with latest documentation changes
This commit is contained in:
Etherdrake
2026-05-03 14:55:37 +02:00
parent 3695c0249e
commit a54a713360
58 changed files with 799 additions and 637 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference/geoblock.md
+40 -39
View File
@@ -48,44 +48,45 @@ GET https://polymarket.com/api/geoblock
## Blocked Countries
The following countries are restricted from placing orders on Polymarket. Countries marked as **close-only** can close existing positions but cannot open new ones:
The following countries are restricted from placing orders on Polymarket. Countries marked as **close-only** can close existing positions but cannot open new ones. Countries marked as **frontend UI restricted** are blocked only on the Polymarket frontend; the API itself is not restricted:
| Country Code | Country Name | Status |
| ------------ | ------------------------------------ | ---------- |
| AU | Australia | Blocked |
| BE | Belgium | Blocked |
| BY | Belarus | Blocked |
| BI | Burundi | Blocked |
| CF | Central African Republic | Blocked |
| CD | Congo (Kinshasa) | Blocked |
| CU | Cuba | Blocked |
| DE | Germany | Blocked |
| ET | Ethiopia | Blocked |
| FR | France | Blocked |
| GB | United Kingdom | Blocked |
| IR | Iran | Blocked |
| IQ | Iraq | Blocked |
| IT | Italy | Blocked |
| KP | North Korea | Blocked |
| LB | Lebanon | Blocked |
| LY | Libya | Blocked |
| MM | Myanmar | Blocked |
| NI | Nicaragua | Blocked |
| NL | Netherlands | Blocked |
| PL | Poland | Close-only |
| RU | Russia | Blocked |
| SG | Singapore | Close-only |
| SO | Somalia | Blocked |
| SS | South Sudan | Blocked |
| SD | Sudan | Blocked |
| SY | Syria | Blocked |
| TH | Thailand | Close-only |
| TW | Taiwan | Close-only |
| UM | United States Minor Outlying Islands | Blocked |
| US | United States | Blocked |
| VE | Venezuela | Blocked |
| YE | Yemen | Blocked |
| ZW | Zimbabwe | Blocked |
| Country Code | Country Name | Status |
| ------------ | ------------------------------------ | ---------------------- |
| AU | Australia | Blocked |
| BE | Belgium | Blocked |
| BY | Belarus | Blocked |
| BI | Burundi | Blocked |
| CF | Central African Republic | Blocked |
| CD | Congo (Kinshasa) | Blocked |
| CU | Cuba | Blocked |
| DE | Germany | Blocked |
| ET | Ethiopia | Blocked |
| FR | France | Blocked |
| GB | United Kingdom | Blocked |
| IR | Iran | Blocked |
| IQ | Iraq | Blocked |
| IT | Italy | Blocked |
| JP | Japan | Frontend UI restricted |
| KP | North Korea | Blocked |
| LB | Lebanon | Blocked |
| LY | Libya | Blocked |
| MM | Myanmar | Blocked |
| NI | Nicaragua | Blocked |
| NL | Netherlands | Blocked |
| PL | Poland | Close-only |
| RU | Russia | Blocked |
| SG | Singapore | Close-only |
| SO | Somalia | Blocked |
| SS | South Sudan | Blocked |
| SD | Sudan | Blocked |
| SY | Syria | Blocked |
| TH | Thailand | Close-only |
| TW | Taiwan | Close-only |
| UM | United States Minor Outlying Islands | Blocked |
| US | United States | Blocked |
| VE | Venezuela | Blocked |
| YE | Yemen | Blocked |
| ZW | Zimbabwe | Blocked |
***
@@ -166,9 +167,9 @@ The geoblocking system includes:
<Tab title="Rust">
```rust theme={null}
use polymarket_client_sdk::clob::Client;
use polymarket_client_sdk_v2::clob::{Client, Config};
let client = Client::default();
let client = Client::new("https://clob.polymarket.com", Config::default())?;
let geo = client.check_geoblock().await?;
if geo.blocked {
docs/api-reference/trade/get-builder-trades.md
+15 -56
View File
@@ -4,8 +4,7 @@
# Get builder trades
> Retrieves originated trades for a given builder.
Builders can only see their own originated trades.
> Retrieves trades attributed to a builder code.
@@ -47,10 +46,17 @@ paths:
- Trade
summary: Get builder trades
description: |
Retrieves originated trades for a given builder.
Builders can only see their own originated trades.
Retrieves trades attributed to a builder code.
operationId: getBuilderTrades
parameters:
- name: builder_code
in: query
description: Builder code to fetch attributed trades for
required: true
schema:
type: string
pattern: ^0x[a-fA-F0-9]{64}$
example: '0x0000000000000000000000000000000000000000000000000000000000000001'
- name: id
in: query
description: Trade ID to filter by specific trade
@@ -58,15 +64,6 @@ paths:
schema:
type: string
example: trade-123
- name: builder
in: query
description: >-
Builder identifier (automatically set from authenticated builder, or
can be specified with admin token)
required: false
schema:
type: string
example: 0199bfa0-f4c1-7a98-9c2b-b29cc6d39e10
- name: market
in: query
description: Market (condition ID) to filter trades
@@ -124,7 +121,8 @@ paths:
- id: trade-123
tradeType: TAKER
takerOrderHash: '0xabcdef1234567890abcdef1234567890abcdef12'
builder: 0199bfa0-f4c1-7a98-9c2b-b29cc6d39e10
builder: >-
0x0000000000000000000000000000000000000000000000000000000000000001
market: >-
0x0000000000000000000000000000000000000000000000000000000000000001
assetId: >-
@@ -154,14 +152,6 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
example:
error: invalid builder trade params
'401':
description: Unauthorized - Invalid builder API key or authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Invalid API key
'500':
description: Internal server error
content:
@@ -170,12 +160,6 @@ paths:
$ref: '#/components/schemas/ErrorResponse'
example:
error: could not fetch builder trades
security:
- polyApiKey: []
polyAddress: []
polySignature: []
polyPassphrase: []
polyTimestamp: []
components:
schemas:
BuilderTradesResponse:
@@ -253,8 +237,9 @@ components:
example: '0xabcdef1234567890abcdef1234567890abcdef12'
builder:
type: string
description: Builder identifier
example: 0199bfa0-f4c1-7a98-9c2b-b29cc6d39e10
description: Builder code attributed to the trade
pattern: ^0x[a-fA-F0-9]{64}$
example: '0x0000000000000000000000000000000000000000000000000000000000000001'
market:
type: string
description: Market (condition ID)
@@ -342,31 +327,5 @@ components:
format: date-time
description: Last update timestamp
example: '2024-01-01T00:00:00Z'
securitySchemes:
polyApiKey:
type: apiKey
in: header
name: POLY_API_KEY
description: Your API key
polyAddress:
type: apiKey
in: header
name: POLY_ADDRESS
description: Ethereum address associated with the API key
polySignature:
type: apiKey
in: header
name: POLY_SIGNATURE
description: HMAC signature of the request
polyPassphrase:
type: apiKey
in: header
name: POLY_PASSPHRASE
description: API key passphrase
polyTimestamp:
type: apiKey
in: header
name: POLY_TIMESTAMP
description: Unix timestamp of the request
````
docs/api-reference/trade/post-a-new-order.md
+11 -1
View File
@@ -274,6 +274,14 @@ components:
description: Error message
Order:
type: object
description: >
Order payload submitted to the CLOB API. In CLOB V2, `expiration`
remains in
the POST /order wire body for GTD/order-expiry handling, but it is not
part
of the EIP-712 signed order struct.
required:
- maker
- signer
@@ -319,7 +327,9 @@ components:
example: BUY
expiration:
type: string
description: Unix timestamp when the order expires
description: >-
Unix timestamp when the order expires. Present in the API wire body;
not part of the CLOB V2 EIP-712 signed order struct.
example: '1735689600'
timestamp:
type: string
docs/api-reference/trade/post-multiple-orders.md
+11 -1
View File
@@ -297,6 +297,14 @@ components:
description: Error message
Order:
type: object
description: >
Order payload submitted to the CLOB API. In CLOB V2, `expiration`
remains in
the POST /order wire body for GTD/order-expiry handling, but it is not
part
of the EIP-712 signed order struct.
required:
- maker
- signer
@@ -342,7 +350,9 @@ components:
example: BUY
expiration:
type: string
description: Unix timestamp when the order expires
description: >-
Unix timestamp when the order expires. Present in the API wire body;
not part of the CLOB V2 EIP-712 signed order struct.
example: '1735689600'
timestamp:
type: string