From e8350d88c7c78f40bb2e94333f0bd9ba6a60be91 Mon Sep 17 00:00:00 2001 From: Etherdrake Date: Sat, 30 May 2026 18:29:50 +0200 Subject: [PATCH] docs: sync 2026-05-30 - add 2 new pages, update TARGET.md with 13 new URLs from llms.txt --- TARGET.md | 17 +++ .../bridge/create-bridge-addresses.md | 109 +++++++++++++++ docs/market-data/websocket/user-channel.md | 124 ++++++++++++++++++ 3 files changed, 250 insertions(+) create mode 100644 docs/api-reference/bridge/create-bridge-addresses.md create mode 100644 docs/market-data/websocket/user-channel.md diff --git a/TARGET.md b/TARGET.md index e400b53..f86992c 100644 --- a/TARGET.md +++ b/TARGET.md @@ -129,6 +129,7 @@ https://docs.polymarket.com/developers/CLOB/trades/trades.md ## Websocket https://docs.polymarket.com/market-data/websocket/overview.md https://docs.polymarket.com/market-data/websocket/market-channel.md +https://docs.polymarket.com/market-data/websocket/user-channel.md https://docs.polymarket.com/developers/CLOB/websocket/wss-overview.md https://docs.polymarket.com/quickstart/websocket/WSS-Quickstart.md https://docs.polymarket.com/developers/CLOB/websocket/wss-auth.md @@ -185,6 +186,8 @@ https://docs.polymarket.com/api-reference/markets/list-markets-keyset-pagination https://docs.polymarket.com/api-reference/markets/get-market-by-id.md https://docs.polymarket.com/api-reference/markets/get-market-tags-by-id.md https://docs.polymarket.com/api-reference/markets/get-market-by-slug.md +https://docs.polymarket.com/api-reference/markets/get-clob-market-info.md +https://docs.polymarket.com/api-reference/markets/get-market-by-token.md https://docs.polymarket.com/api-reference/markets/get-prices-history.md https://docs.polymarket.com/api-reference/markets/get-batch-prices-history.md https://docs.polymarket.com/api-reference/markets/get-sampling-markets.md @@ -239,6 +242,7 @@ https://docs.polymarket.com/api-reference/bridge/get-a-quote.md https://docs.polymarket.com/api-reference/bridge/create-deposit-addresses.md https://docs.polymarket.com/api-reference/bridge/create-withdrawal-addresses.md https://docs.polymarket.com/api-reference/bridge/get-transaction-status.md +https://docs.polymarket.com/api-reference/bridge/create-bridge-addresses.md https://docs.polymarket.com/trading/bridge/deposit.md https://docs.polymarket.com/trading/bridge/quote.md https://docs.polymarket.com/trading/bridge/status.md @@ -328,6 +332,7 @@ https://docs.polymarket.com/concepts/order-lifecycle.md https://docs.polymarket.com/concepts/positions-tokens.md https://docs.polymarket.com/concepts/prices-orderbook.md https://docs.polymarket.com/concepts/resolution.md +https://docs.polymarket.com/concepts/pusd.md ## Trading https://docs.polymarket.com/trading/fees.md @@ -337,11 +342,14 @@ https://docs.polymarket.com/trading/clients/public.md https://docs.polymarket.com/trading/clients/l1.md https://docs.polymarket.com/trading/clients/l2.md https://docs.polymarket.com/trading/clients/builder.md +https://docs.polymarket.com/trading/deposit-wallets.md +https://docs.polymarket.com/trading/taker-rebates.md ## Index & Resources https://docs.polymarket.com/index.md https://docs.polymarket.com/resources/contract-addresses.md https://docs.polymarket.com/resources/error-codes.md +https://docs.polymarket.com/resources/contracts.md ## NEW - API Reference - Rebates (2026-03-27) https://docs.polymarket.com/api-reference/rebates/get-current-rebated-fees-for-a-maker.md @@ -349,6 +357,7 @@ https://docs.polymarket.com/api-reference/rebates/get-current-rebated-fees-for-a ## NEW - API Reference - Relayer https://docs.polymarket.com/api-reference/relayer-api-keys/get-all-relayer-api-keys.md https://docs.polymarket.com/api-reference/relayer/check-if-a-safe-is-deployed.md +https://docs.polymarket.com/api-reference/relayer/check-if-a-wallet-is-deployed.md https://docs.polymarket.com/api-reference/relayer/get-a-transaction-by-id.md https://docs.polymarket.com/api-reference/relayer/get-current-nonce-for-a-user.md https://docs.polymarket.com/api-reference/relayer/get-recent-transactions-for-a-user.md @@ -370,3 +379,11 @@ https://docs.polymarket.com/resources/referral-program.md ## NEW - Trading https://docs.polymarket.com/trading/matching-engine.md + +## Dev Tooling +https://docs.polymarket.com/dev-tooling.md +https://docs.polymarket.com/dev-tooling/python.md +https://docs.polymarket.com/dev-tooling/typescript.md + +## NEW - Builders +https://docs.polymarket.com/builders/fees.md diff --git a/docs/api-reference/bridge/create-bridge-addresses.md b/docs/api-reference/bridge/create-bridge-addresses.md new file mode 100644 index 0000000..25b7f8a --- /dev/null +++ b/docs/api-reference/bridge/create-bridge-addresses.md @@ -0,0 +1,109 @@ +> ## 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 bridge addresses + + + +## OpenAPI + +````yaml /api-spec/bridge-openapi.yaml post /deposit +openapi: 3.0.3 +info: + title: Polymarket Bridge API + version: 1.0.0 + description: HTTP API for Polymarket bridge and swap operations. +servers: + - url: https://bridge.polymarket.com + description: Polymarket Bridge API +security: [] +tags: + - name: Bridge + description: Bridge and swap operations for Polymarket +paths: + /deposit: + post: + tags: + - Bridge + summary: Create bridge addresses + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DepositRequest' + example: + address: '0x56687bf447db6ffa42ffe2204a05edaa20f55839' + responses: + '201': + description: Bridge addresses created successfully + content: + application/json: + schema: + $ref: '#/components/schemas/DepositResponse' + '400': + description: Bad Request - Invalid address or request body + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' +components: + schemas: + DepositRequest: + type: object + required: + - address + properties: + address: + $ref: '#/components/schemas/Address' + description: >- + Your Polymarket wallet address where deposited funds will be + credited as pUSD + DepositResponse: + type: object + properties: + address: + type: object + description: Bridge addresses for different blockchain networks + properties: + evm: + type: string + description: >- + EVM-compatible bridge address (Ethereum, Polygon, Arbitrum, + Base, etc.) + example: '0x23566f8b2E82aDfCf01846E54899d110e97AC053' + svm: + type: string + description: Solana Virtual Machine bridge address + example: CrvTBvzryYxBHbWu2TiQpcqD5M7Le7iBKzVmEj3f36Jb + btc: + type: string + description: Bitcoin bridge address + example: bc1q8eau83qffxcj8ht4hsjdza3lha9r3egfqysj3g + note: + type: string + description: Additional information about the bridge addresses + example: >- + Only certain chains and tokens are supported. See /supported-assets + for details. + ErrorResponse: + type: object + properties: + error: + type: string + required: + - error + Address: + type: string + description: Ethereum address (0x-prefixed, 40 hex chars) + pattern: ^0x[a-fA-F0-9]{40}$ + example: '0x56687bf447db6ffa42ffe2204a05edaa20f55839' + +```` \ No newline at end of file diff --git a/docs/market-data/websocket/user-channel.md b/docs/market-data/websocket/user-channel.md new file mode 100644 index 0000000..42f1d5c --- /dev/null +++ b/docs/market-data/websocket/user-channel.md @@ -0,0 +1,124 @@ +> ## 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. + +# User Channel + +> Authenticated order and trade updates + +Authenticated channel for updates related to your orders and trades, filtered by API key. + +## Endpoint + +``` +wss://ws-subscriptions-clob.polymarket.com/ws/user +``` + +## Authentication + +Include API credentials in your subscription message: + +```json theme={null} +{ + "auth": { + "apiKey": "your-api-key", + "secret": "your-api-secret", + "passphrase": "your-passphrase" + }, + "markets": ["0x1234...condition_id"], + "type": "user" +} +``` + + + Never expose your API credentials in client-side code. Use the user channel + only from server environments. + + +## Message Types + +Each message includes a `type` field identifying the event. + +### trade + +Emitted when: + +* A market order is matched (`MATCHED`) +* A limit order for the user is included in a trade (`MATCHED`) +* Subsequent status changes for the trade (`MINED`, `CONFIRMED`, `RETRYING`, `FAILED`) + +```json theme={null} +{ + "asset_id": "52114319501245915516055106046884209969926127482827954674443846427813813222426", + "event_type": "trade", + "id": "28c4d2eb-bbea-40e7-a9f0-b2fdb56b2c2e", + "last_update": "1672290701", + "maker_orders": [ + { + "asset_id": "52114319501245915516055106046884209969926127482827954674443846427813813222426", + "matched_amount": "10", + "order_id": "0xff354cd7ca7539dfa9c28d90943ab5779a4eac34b9b37a757d7b32bdfb11790b", + "outcome": "YES", + "owner": "9180014b-33c8-9240-a14b-bdca11c0a465", + "price": "0.57" + } + ], + "market": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", + "matchtime": "1672290701", + "outcome": "YES", + "owner": "9180014b-33c8-9240-a14b-bdca11c0a465", + "price": "0.57", + "side": "BUY", + "size": "10", + "status": "MATCHED", + "taker_order_id": "0x06bc63e346ed4ceddce9efd6b3af37c8f8f440c92fe7da6b2d0f9e4ccbc50c42", + "timestamp": "1672290701", + "trade_owner": "9180014b-33c8-9240-a14b-bdca11c0a465", + "type": "TRADE" +} +``` + +#### Trade Statuses + +``` +MATCHED → MINED → CONFIRMED + ↓ ↑ +RETRYING ───┘ + ↓ + FAILED +``` + +| Status | Terminal | Description | +| ----------- | -------- | ----------------------------------------------------------------------------------------------- | +| `MATCHED` | No | Trade has been matched and sent to the executor service by the operator | +| `MINED` | No | Trade observed to be mined into the chain, no finality threshold established | +| `CONFIRMED` | Yes | Trade has achieved strong probabilistic finality and was successful | +| `RETRYING` | No | Trade transaction has failed (revert or reorg) and is being retried/resubmitted by the operator | +| `FAILED` | Yes | Trade has failed and is not being retried | + +### order + +Emitted when: + +* An order is placed (`PLACEMENT`) +* An order is updated — some of it is matched (`UPDATE`) +* An order is cancelled (`CANCELLATION`) + +```json theme={null} +{ + "asset_id": "52114319501245915516055106046884209969926127482827954674443846427813813222426", + "associate_trades": null, + "event_type": "order", + "id": "0xff354cd7ca7539dfa9c28d90943ab5779a4eac34b9b37a757d7b32bdfb11790b", + "market": "0xbd31dc8a20211944f6b70f31557f1001557b59905b7738480ca09bd4532f84af", + "order_owner": "9180014b-33c8-9240-a14b-bdca11c0a465", + "original_size": "10", + "outcome": "YES", + "owner": "9180014b-33c8-9240-a14b-bdca11c0a465", + "price": "0.57", + "side": "SELL", + "size_matched": "0", + "timestamp": "1672290687", + "type": "PLACEMENT" +} +```