Skip to main content

​
Subscribe

Create a subscription to receive trade alerts matching your filters.

​
Request

{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orders",
  "filters": {
    "<filter_type>": ["<value1>", "<value2>", ...]
  }
}

​
Filter Types

FilterDescriptionExample
usersWallet addresses (maker)["0x123...", "0xabc..."]
condition_idsMarket condition IDs["0x456...", "0x789..."]
market_slugsMarket URL slugs["will-donald-trump-win-the-2024-us-presidential-election"]

​
Success Response

{
  "type": "ack",
  "subscription_id": "sub_a1b2c3d4"
}
Save the subscription_id to update or unsubscribe later.

​
Examples

​
Subscribe to wallets

Track trades from specific wallet addresses: 
{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orders",
  "filters": {
    "users": [
      "0x1234567890abcdef1234567890abcdef12345678",
      "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"
    ]
  }
}

​
Subscribe to a market by slug

Track all trades in a specific market: 
{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orders",
  "filters": {
    "market_slugs": ["will-donald-trump-win-the-2024-us-presidential-election"]
  }
}

​
Subscribe to a market by condition ID

{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orders",
  "filters": {
    "condition_ids": ["0x1234567890abcdef1234567890abcdef12345678901234567890abcdef12345678"]
  }
}

​
Wildcard subscription (Pro only)

Subscribe to all trades across Polymarket: 
{
  "action": "subscribe",
  "platform": "polymarket",
  "version": 1,
  "type": "orders",
  "filters": {
    "users": ["*"]
  }
}
Wildcard must be the only subscription on the connection and allows only one connection per API key.

​
Unsubscribe

Remove an existing subscription using its ID.

​
Request

{
  "action": "unsubscribe",
  "subscription_id": "sub_a1b2c3d4"
}

​
Response

{
  "type": "ack",
  "subscription_id": "sub_a1b2c3d4"
}

​
Update Subscription

Modify filters on an existing subscription without creating a new one.

​
Request

{
  "action": "update",
  "subscription_id": "sub_a1b2c3d4",
  "filters": {
    "users": ["0xnewwallet..."]
  }
}

​
Response

{
  "type": "ack",
  "subscription_id": "sub_a1b2c3d4"
}
Updating replaces the existing filters entirely. Include all items you want to track.