Skip to content

docs: include exchange in WebSocket examples #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
realfishsam merged 1 commit into from
May 22, 2026
Merged

docs: include exchange in WebSocket examples #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api-reference/watch-order-book.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ while (true) {

```json WebSocket
// → Subscribe
{ "id": "req-1", "action": "subscribe", "method": "watchOrderBook", "args": ["OUTCOME_ID", 10] }
{ "id": "req-1", "action": "subscribe", "exchange": "polymarket", "method": "watchOrderBook", "args": ["OUTCOME_ID", 10] }

// ← Subscription confirmed
{ "event": "subscribed", "id": "req-1" }
Expand All @@ -85,7 +85,7 @@ while (true) {
}

// → Unsubscribe
{ "id": "req-1", "action": "unsubscribe" }
{ "id": "req-1", "action": "unsubscribe", "exchange": "polymarket", "method": "watchOrderBook", "args": ["OUTCOME_ID"] }
```

</CodeGroup>
Expand Down
1 change: 1 addition & 0 deletions docs/api-reference/watch-order-books.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ while (true) {
{
"id": "req-1",
"action": "subscribe",
"exchange": "polymarket",
"method": "watchOrderBooks",
"args": [["OUTCOME_ID_1", "OUTCOME_ID_2", "OUTCOME_ID_3"], 10]
}
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/watch-trades.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ while (true) {

```json WebSocket
// → Subscribe
{ "id": "req-1", "action": "subscribe", "method": "watchTrades", "args": ["OUTCOME_ID"] }
{ "id": "req-1", "action": "subscribe", "exchange": "polymarket", "method": "watchTrades", "args": ["OUTCOME_ID"] }

// ← Data event
{
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/websocket.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ All messages are JSON text frames. A single connection supports multiple concurr
### Subscribe

```json
{ "id": "req-1", "action": "subscribe", "method": "watchOrderBook", "args": ["OUTCOME_ID", 50] }
{ "id": "req-1", "action": "subscribe", "exchange": "polymarket", "method": "watchOrderBook", "args": ["OUTCOME_ID", 50] }
```

### Data event
Expand All @@ -42,7 +42,7 @@ All messages are JSON text frames. A single connection supports multiple concurr
### Unsubscribe

```json
{ "id": "req-1", "action": "unsubscribe" }
{ "id": "req-1", "action": "unsubscribe", "exchange": "polymarket", "method": "watchOrderBook", "args": ["OUTCOME_ID"] }
```

### Error
Expand Down
Loading