> ## Documentation Index > Fetch the complete documentation index at: https://docs.predexon.com/llms.txt > Use this file to discover all available pages before exploring further. # Trades Playground > Real-time order fills and fee refunds. Set status filter to `all` or `pending` for mempool events (3-5s early). ## AsyncAPI ````yaml websocket/asyncapi.json trades id: trades title: Trades description: >- Real-time order fills and fee refunds. Set status filter to `all` or `pending` for mempool events (3-5s early). servers: - id: production protocol: wss host: wss.predexon.com bindings: [] variables: [] address: / parameters: [] bindings: [] operations: - &ref_1 id: sendSubscribeTrades title: Send subscribe trades type: receive messages: - &ref_7 id: SubscribeTrades payload: - name: Subscribe to Trades description: >- Subscribe to trade events. Use status filter for pending (mempool) events. type: object properties: - name: action type: string description: Must be 'subscribe' required: true - name: platform type: string description: Must be 'polymarket' required: true - name: version type: integer description: Must be 1 required: true - name: type type: string description: Must be 'orders' required: true - name: filters type: object description: Provide one filter key. Use ["*"] for wildcard (Pro only). required: true properties: - name: users type: array description: Wallet addresses required: false properties: - name: item type: string required: false - name: condition_ids type: array description: Market condition IDs required: false properties: - name: item type: string required: false - name: market_slugs type: array description: Market URL slugs required: false properties: - name: item type: string required: false - name: status type: string description: >- confirmed (default), pending (mempool, Dev+), or all (both, Dev+) enumValues: - confirmed - pending - all required: false headers: [] jsonPayloadSchema: type: object required: - action - platform - version - type - filters properties: action: type: string description: Must be 'subscribe' x-parser-schema-id: platform: type: string description: Must be 'polymarket' x-parser-schema-id: version: type: integer description: Must be 1 x-parser-schema-id: type: type: string description: Must be 'orders' x-parser-schema-id: filters: type: object description: Provide one filter key. Use ["*"] for wildcard (Pro only). properties: users: type: array description: Wallet addresses items: type: string x-parser-schema-id: x-parser-schema-id: condition_ids: type: array description: Market condition IDs items: type: string x-parser-schema-id: x-parser-schema-id: market_slugs: type: array description: Market URL slugs items: type: string x-parser-schema-id: x-parser-schema-id: status: type: string description: >- confirmed (default), pending (mempool, Dev+), or all (both, Dev+) enum: - confirmed - pending - all x-parser-schema-id: x-parser-schema-id: examples: - action: subscribe platform: polymarket version: 1 type: orders filters: users: - '0xe9cbb1c9b3f7f411dd4fdf2ea7afa780c8b4d096' status: all x-parser-schema-id: title: Subscribe to Trades description: >- Subscribe to trade events. Use status filter for pending (mempool) events. example: |- { "action": "subscribe", "platform": "polymarket", "version": 1, "type": "orders", "filters": { "users": [ "0xe9cbb1c9b3f7f411dd4fdf2ea7afa780c8b4d096" ], "status": "all" } } bindings: [] extensions: - id: x-parser-unique-object-id value: SubscribeTrades - id: x-parser-message-name value: SubscribeTrades bindings: [] extensions: &ref_0 - id: x-mint value: &ref_13 content: >- WebSocket requires a **Dev** or **Pro** API key. Free tier keys cannot connect. [Get your key →](https://dashboard.predexon.com) - id: x-parser-unique-object-id value: trades - &ref_2 id: sendUnsubscribeTrades title: Send unsubscribe trades type: receive messages: - &ref_8 id: Unsubscribe payload: - name: Unsubscribe description: Remove a subscription by ID. type: object properties: - name: action type: string description: Must be 'unsubscribe' required: true - name: subscription_id type: string description: Subscription ID from the ack response (e.g. sub_2f4b15b33798) required: true headers: [] jsonPayloadSchema: type: object required: - action - subscription_id properties: action: type: string description: Must be 'unsubscribe' x-parser-schema-id: subscription_id: type: string description: Subscription ID from the ack response (e.g. sub_2f4b15b33798) x-parser-schema-id: examples: - action: unsubscribe subscription_id: sub_2f4b15b33798 x-parser-schema-id: title: Unsubscribe description: Remove a subscription by ID. example: |- { "action": "unsubscribe", "subscription_id": "sub_2f4b15b33798" } bindings: [] extensions: - id: x-parser-unique-object-id value: Unsubscribe - id: x-parser-message-name value: Unsubscribe bindings: [] extensions: *ref_0 - &ref_3 id: sendUpdateTrades title: Send update trades type: receive messages: - &ref_9 id: Update payload: - name: Update Subscription description: >- Replace filters on an existing subscription. Not supported on the orderbook channel. type: object properties: - name: action type: string description: Must be 'update' required: true - name: subscription_id type: string description: Subscription ID to update required: true - name: filters type: object description: New filters (replaces existing filters entirely) required: true properties: - name: users type: array description: Wallet addresses required: false properties: - name: item type: string required: false - name: condition_ids type: array description: Market condition IDs required: false properties: - name: item type: string required: false - name: market_slugs type: array description: Market URL slugs required: false properties: - name: item type: string required: false - name: status type: string description: confirmed, pending, or all (orders channel only) enumValues: - confirmed - pending - all required: false - name: token_ids type: array description: CLOB token IDs (orderbook channel only) required: false properties: - name: item type: string required: false - name: feeds type: array description: Chainlink crypto feed symbols (crypto_prices channel only) required: false properties: - name: item type: string required: false headers: [] jsonPayloadSchema: type: object required: - action - subscription_id - filters properties: action: type: string description: Must be 'update' x-parser-schema-id: subscription_id: type: string description: Subscription ID to update x-parser-schema-id: filters: type: object description: New filters (replaces existing filters entirely) properties: users: type: array description: Wallet addresses items: type: string x-parser-schema-id: x-parser-schema-id: condition_ids: type: array description: Market condition IDs items: type: string x-parser-schema-id: x-parser-schema-id: market_slugs: type: array description: Market URL slugs items: type: string x-parser-schema-id: x-parser-schema-id: status: type: string description: confirmed, pending, or all (orders channel only) enum: - confirmed - pending - all x-parser-schema-id: token_ids: type: array description: CLOB token IDs (orderbook channel only) items: type: string x-parser-schema-id: x-parser-schema-id: feeds: type: array description: Chainlink crypto feed symbols (crypto_prices channel only) items: type: string x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: examples: - action: update subscription_id: sub_2f4b15b33798 filters: users: - 0xnew_address... status: all x-parser-schema-id: title: Update Subscription description: >- Replace filters on an existing subscription. Not supported on the orderbook channel. example: |- { "action": "update", "subscription_id": "sub_2f4b15b33798", "filters": { "users": [ "0xnew_address..." ], "status": "all" } } bindings: [] extensions: - id: x-parser-unique-object-id value: Update - id: x-parser-message-name value: Update bindings: [] extensions: *ref_0 - &ref_4 id: receiveAckTrades title: Receive ack trades type: send messages: - &ref_10 id: Ack payload: - name: Acknowledgement description: >- Server acknowledgement for subscribe, unsubscribe, and update actions. type: object properties: - name: type type: string description: ack required: true - name: subscription_id type: string description: The subscription ID required: true - name: channel type: string description: >- Channel name (trades, activity, lifecycle, orderbook, oracle, collateral, crypto_prices) required: true headers: [] jsonPayloadSchema: type: object properties: type: type: string description: ack x-parser-schema-id: subscription_id: type: string description: The subscription ID x-parser-schema-id: channel: type: string description: >- Channel name (trades, activity, lifecycle, orderbook, oracle, collateral, crypto_prices) x-parser-schema-id: required: - type - subscription_id - channel examples: - type: ack subscription_id: sub_2f4b15b33798 channel: trades x-parser-schema-id: title: Acknowledgement description: Server acknowledgement for subscribe, unsubscribe, and update actions. example: |- { "type": "ack", "subscription_id": "sub_2f4b15b33798", "channel": "trades" } bindings: [] extensions: - id: x-parser-unique-object-id value: Ack - id: x-parser-message-name value: Ack bindings: [] extensions: *ref_0 - &ref_5 id: receiveOrderFilled title: Receive order filled type: send messages: - &ref_11 id: OrderFilled payload: - name: Order Filled description: >- Trade fill event. status is 'pending' for mempool events or 'confirmed' for on-chain. type: object properties: - name: event_type type: string description: order_filled required: true - name: status type: string description: pending (mempool) or confirmed (on-chain) enumValues: - pending - confirmed required: true - name: user type: string description: Maker address required: true - name: taker type: string description: Taker address required: true - name: side type: string description: Maker's side enumValues: - BUY - SELL required: true - name: price type: number description: USDC per share required: true - name: shares type: integer description: Raw share amount (6 decimals) required: true - name: shares_normalized type: number description: Human-readable shares required: true - name: fee type: number description: Fee in USDC required: false - name: token_id type: string description: Outcome token ID required: true - name: token_label type: string description: Outcome label (Yes, Up, etc.) required: false - name: outcome type: string description: Same as token_label required: false - name: outcome_index type: integer description: 0 = first outcome, 1 = second required: false - name: complement_token_id type: string description: Opposite outcome token ID required: false - name: complement_token_label type: string description: Opposite outcome label required: false - name: is_neg_risk type: boolean description: true for neg-risk markets required: false - name: condition_id type: string description: Market condition ID required: true - name: market_slug type: string description: Market URL slug required: true - name: market_id type: string description: Internal market ID required: false - name: title type: string description: Market title required: false - name: image type: string description: Market image URL required: false - name: order_hash type: string description: Order hash required: true - name: tx_hash type: string description: Transaction hash required: true - name: log_index type: string description: Log index (hex). null for pending. required: false - name: timestamp type: integer description: Unix timestamp in seconds required: true - name: version type: integer description: 1 for V1 contracts, 2 for V2 contracts enumValues: - 1 - 2 required: true - name: builder type: string description: bytes32 hex tag (V2 only, currently zero) required: false - name: metadata type: string description: bytes32 hex tag (V2 only, currently zero) required: false - name: role type: string description: >- Which OrderFilled emission this is. 'maker' = per-maker fill (one per maker matched). 'taker' = synthetic taker-aggregate emission (one per matchOrders tx, taker == exchange contract). enumValues: - maker - taker required: true headers: [] jsonPayloadSchema: type: object properties: event_type: type: string description: order_filled x-parser-schema-id: status: type: string description: pending (mempool) or confirmed (on-chain) enum: - pending - confirmed x-parser-schema-id: user: type: string description: Maker address x-parser-schema-id: taker: type: string description: Taker address x-parser-schema-id: side: type: string description: Maker's side enum: - BUY - SELL x-parser-schema-id: price: type: number description: USDC per share x-parser-schema-id: shares: type: integer description: Raw share amount (6 decimals) x-parser-schema-id: shares_normalized: type: number description: Human-readable shares x-parser-schema-id: fee: type: number description: Fee in USDC x-parser-schema-id: token_id: type: string description: Outcome token ID x-parser-schema-id: token_label: type: string description: Outcome label (Yes, Up, etc.) x-parser-schema-id: outcome: type: string description: Same as token_label x-parser-schema-id: outcome_index: type: integer description: 0 = first outcome, 1 = second x-parser-schema-id: complement_token_id: type: string description: Opposite outcome token ID x-parser-schema-id: complement_token_label: type: string description: Opposite outcome label x-parser-schema-id: is_neg_risk: type: boolean description: true for neg-risk markets x-parser-schema-id: condition_id: type: string description: Market condition ID x-parser-schema-id: market_slug: type: string description: Market URL slug x-parser-schema-id: market_id: type: string description: Internal market ID x-parser-schema-id: title: type: string description: Market title x-parser-schema-id: image: type: string description: Market image URL x-parser-schema-id: order_hash: type: string description: Order hash x-parser-schema-id: tx_hash: type: string description: Transaction hash x-parser-schema-id: log_index: type: string description: Log index (hex). null for pending. x-parser-schema-id: timestamp: type: integer description: Unix timestamp in seconds x-parser-schema-id: version: type: integer description: 1 for V1 contracts, 2 for V2 contracts enum: - 1 - 2 x-parser-schema-id: builder: type: string description: bytes32 hex tag (V2 only, currently zero) x-parser-schema-id: metadata: type: string description: bytes32 hex tag (V2 only, currently zero) x-parser-schema-id: role: type: string description: >- Which OrderFilled emission this is. 'maker' = per-maker fill (one per maker matched). 'taker' = synthetic taker-aggregate emission (one per matchOrders tx, taker == exchange contract). enum: - maker - taker x-parser-schema-id: required: - event_type - status - user - taker - side - price - shares - shares_normalized - token_id - condition_id - market_slug - order_hash - tx_hash - timestamp - version - role examples: - event_type: order_filled status: confirmed user: '0xe9cbb1c9b3f7f411dd4fdf2ea7afa780c8b4d096' taker: '0x98f36c3d6300b905d00aef4bbae1d5a00874401f' side: SELL price: 0.04 shares: 2000000 shares_normalized: 2 fee: 0.008 token_id: 61192765571543... token_label: Up outcome: Up outcome_index: 0 is_neg_risk: false condition_id: 0x04f954e4f30f... market_slug: btc-updown-15m-1770244200 title: Bitcoin Up or Down - February 4 order_hash: 0x8bf54f44e5d7... tx_hash: 0xf30a29f249... log_index: '0x21e' timestamp: 1770244731 version: 2 builder: >- 0x0000000000000000000000000000000000000000000000000000000000000000 metadata: >- 0x0000000000000000000000000000000000000000000000000000000000000000 role: maker x-parser-schema-id: title: Order Filled description: >- Trade fill event. status is 'pending' for mempool events or 'confirmed' for on-chain. example: |- { "event_type": "order_filled", "status": "confirmed", "user": "0xe9cbb1c9b3f7f411dd4fdf2ea7afa780c8b4d096", "taker": "0x98f36c3d6300b905d00aef4bbae1d5a00874401f", "side": "SELL", "price": 0.04, "shares": 2000000, "shares_normalized": 2, "fee": 0.008, "token_id": "61192765571543...", "token_label": "Up", "outcome": "Up", "outcome_index": 0, "is_neg_risk": false, "condition_id": "0x04f954e4f30f...", "market_slug": "btc-updown-15m-1770244200", "title": "Bitcoin Up or Down - February 4", "order_hash": "0x8bf54f44e5d7...", "tx_hash": "0xf30a29f249...", "log_index": "0x21e", "timestamp": 1770244731, "version": 2, "builder": "0x0000000000000000000000000000000000000000000000000000000000000000", "metadata": "0x0000000000000000000000000000000000000000000000000000000000000000", "role": "maker" } bindings: [] extensions: - id: x-parser-unique-object-id value: OrderFilled - id: x-parser-message-name value: OrderFilled bindings: [] extensions: *ref_0 - &ref_6 id: receiveFeeRefund title: Receive fee refund type: send messages: - &ref_12 id: FeeRefund payload: - name: Fee Refund description: Maker fee rebate. Correlate to trades via order_hash. type: object properties: - name: event_type type: string description: fee_refund required: true - name: user type: string description: Refund recipient required: true - name: token_id type: string description: Outcome token ID required: false - name: condition_id type: string description: Market condition ID required: false - name: market_slug type: string description: Market URL slug required: false - name: title type: string description: Market title required: false - name: order_hash type: string description: Order hash this refund applies to required: true - name: tx_hash type: string description: Transaction hash required: true - name: refund type: number description: USDC amount refunded required: true - name: fee_charged type: number description: Final net fee after refund required: true headers: [] jsonPayloadSchema: type: object properties: event_type: type: string description: fee_refund x-parser-schema-id: user: type: string description: Refund recipient x-parser-schema-id: token_id: type: string description: Outcome token ID x-parser-schema-id: condition_id: type: string description: Market condition ID x-parser-schema-id: market_slug: type: string description: Market URL slug x-parser-schema-id: title: type: string description: Market title x-parser-schema-id: order_hash: type: string description: Order hash this refund applies to x-parser-schema-id: tx_hash: type: string description: Transaction hash x-parser-schema-id: refund: type: number description: USDC amount refunded x-parser-schema-id: fee_charged: type: number description: Final net fee after refund x-parser-schema-id: required: - event_type - user - order_hash - tx_hash - refund - fee_charged examples: - event_type: fee_refund user: 0x47a51f21d742... token_id: 53031995840519... condition_id: 0xdfb2f9d3ed88... market_slug: btc-updown-15m-1770242400 title: Bitcoin Up or Down order_hash: 0xbda8ab86c90f... tx_hash: 0x97b2ae331881... refund: 9.9904 fee_charged: 0.0096 x-parser-schema-id: title: Fee Refund description: Maker fee rebate. Correlate to trades via order_hash. example: |- { "event_type": "fee_refund", "user": "0x47a51f21d742...", "token_id": "53031995840519...", "condition_id": "0xdfb2f9d3ed88...", "market_slug": "btc-updown-15m-1770242400", "title": "Bitcoin Up or Down", "order_hash": "0xbda8ab86c90f...", "tx_hash": "0x97b2ae331881...", "refund": 9.9904, "fee_charged": 0.0096 } bindings: [] extensions: - id: x-parser-unique-object-id value: FeeRefund - id: x-parser-message-name value: FeeRefund bindings: [] extensions: *ref_0 sendOperations: - *ref_1 - *ref_2 - *ref_3 receiveOperations: - *ref_4 - *ref_5 - *ref_6 sendMessages: - *ref_7 - *ref_8 - *ref_9 receiveMessages: - *ref_10 - *ref_11 - *ref_12 extensions: - id: x-mint value: *ref_13 - id: x-parser-unique-object-id value: trades securitySchemes: - id: apiKey name: api_key type: httpApiKey description: Your Predexon API key in: query extensions: [] ````