Channel Name
Channel: private (Automatically subscribed when authenticated)
The private channel is automatically available when you connect with a valid Bearer token. You do not need to explicitly subscribe.
Event Types
The private channel broadcasts two types of events:
- fill - Your order has been filled (partially or completely)
- cancel - Your order has been explicitly cancelled
Fill Events
Sent when your order is matched with another order on the book.
{
"event": "fill",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174001",
"price": 0.667,
"qty": 50,
"createdAt": "2023-10-05T12:00:00Z",
"isWash": false,
"isTaker": true,
"marketId": "123e4567-e89b-12d3-a456-426614174002",
"outcomeId": "123e4567-e89b-12d3-a456-426614174003"
}
}
Fill Fields
| Field | Type | Description |
|---|
id | string | UUID of the fill |
orderId | string | UUID of your order that was filled |
price | number | Execution price in decimal probability (0-1) |
qty | number | Quantity filled in Minimum Currency Units |
createdAt | string | ISO 8601 timestamp of the fill |
isWash | boolean | Whether this was a wash trade |
isTaker | boolean | Whether you were the taker (true) or maker (false) |
marketId | string | UUID of the market |
outcomeId | string | UUID of the outcome |
Cancel Events
Sent when your order is explicitly cancelled. This includes:
- User-initiated cancellations via API requests
- GTT (Good-Til-Time) order expirations
Implicit cancellations (e.g., when a market closes) do not send individual cancel messages. Use the Market Lifecycle Channel to handle market close events. {
"event": "cancel",
"data": {
"id": "123e4567-e89b-12d3-a456-426614174002",
"outcomeId": "123e4567-e89b-12d3-a456-426614174000",
"marketId": "123e4567-e89b-12d3-a456-426614174003",
"price": 0.667,
"qty": 60,
"originalQty": 110,
"currency": "COIN",
"timestamp": "2023-10-05T12:00:00Z",
"status": "CANCELLED",
"flags": "ABC12345"
}
}
Cancel Fields
| Field | Type | Description |
|---|
id | string | UUID of the cancelled order |
outcomeId | string | UUID of the outcome |
marketId | string | UUID of the market |
price | number | Order price in decimal probability |
qty | number | Remaining quantity when cancelled |
originalQty | number | Original order quantity |
currency | string | CASH or COIN |
timestamp | string | ISO 8601 timestamp of cancellation |
status | string | Order status (CANCELLED) |
flags | string | Custom 8-character metadata (if set) |
