Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.novig.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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.

​
Message Format

{
  "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

FieldTypeDescription
idstringUUID of the fill
orderIdstringUUID of your order that was filled
pricenumberExecution price in decimal probability (0-1)
qtynumberQuantity filled in Minimum Currency Units
createdAtstringISO 8601 timestamp of the fill
isWashbooleanWhether this was a wash trade
isTakerbooleanWhether you were the taker (true) or maker (false)
marketIdstringUUID of the market
outcomeIdstringUUID 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.

​
Message Format

{
  "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

FieldTypeDescription
idstringUUID of the cancelled order
outcomeIdstringUUID of the outcome
marketIdstringUUID of the market
pricenumberOrder price in decimal probability
qtynumberRemaining quantity when cancelled
originalQtynumberOriginal order quantity
currencystringCASH or COIN
timestampstringISO 8601 timestamp of cancellation
statusstringOrder status (CANCELLED)
flagsstringCustom 8-character metadata (if set)