Etherdrake
37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
> ## 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.
|
|
|
|
# WSS Overview
|
|
|
|
> Overview and general information about the Polymarket Websocket
|
|
|
|
## Overview
|
|
|
|
The Polymarket CLOB API provides websocket (wss) channels through which clients can get pushed updates. These endpoints allow clients to maintain almost real-time views of their orders, their trades and markets in general. There are two available channels `user` and `market`.
|
|
|
|
## Subscription
|
|
|
|
To subscribe send a message including the following authentication and intent information upon opening the connection.
|
|
|
|
| Field | Type | Description |
|
|
| ------------------------ | --------- | --------------------------------------------------------------------------- |
|
|
| auth | Auth | see next page for auth information |
|
|
| markets | string\[] | array of markets (condition IDs) to receive events for (for `user` channel) |
|
|
| assets\_ids | string\[] | array of asset ids (token IDs) to receive events for (for `market` channel) |
|
|
| type | string | id of channel to subscribe to (USER or MARKET) |
|
|
| custom\_feature\_enabled | bool | enabling / disabling custom features |
|
|
|
|
Where the `auth` field is of type `Auth` which has the form described in the WSS Authentication section below.
|
|
|
|
### Subscribe to more assets
|
|
|
|
Once connected, the client can subscribe and unsubscribe to `asset_ids` by sending the following message:
|
|
|
|
| Field | Type | Description |
|
|
| ------------------------ | --------- | ------------------------------------------------------------------------------ |
|
|
| assets\_ids | string\[] | array of asset ids (token IDs) to receive events for (for `market` channel) |
|
|
| markets | string\[] | array of market ids (condition IDs) to receive events for (for `user` channel) |
|
|
| operation | string | "subscribe" or "unsubscribe" |
|
|
| custom\_feature\_enabled | bool | enabling / disabling custom features |
|