Skip to content

2026-08-11

2026-08-11Latest

Stream Stats

The exchange’s live stats for each subscribed market, complete on subscribe and again whenever they change.

SEND/ws

Authorization

Authorization

UDX-Access-KeyAPI key · headerrequired

Opaque API key ID.

UDX-Access-TimestampAPI key · headerrequired

Unix time in milliseconds, within 30 seconds of server time.

UDX-Access-SignatureAPI key · headerrequired

Standard-base64 RSA-PSS/SHA-256 signature with a 32-byte salt. Sign timestamp + "GET" + "/ws"; the upgrade request has no body hash and no idempotency key.

Messages

statsDeliver one market's complete current stats.

typestringrequired

Identifies a market stats frame.

sidSubscriptionIdrequired

Exchange-assigned subscription ID whose lifetime is this WebSocket connection.

min 1 · max 9007199254740991

seqSequenceNumberrequired

Gap-detection sequence local to one subscription. It starts at 1 and increments once per frame on that subscription.

min 1 · max 9007199254740991

msgStatsPayloadrequired

One market's stats.

Show properties

statsMarketStatsUpdaterequired

The exchange's live figures for a market.

Show properties

tickerTickerrequired

A human-meaningful natural key naming a single-leg or multi-leg market.

min length 1 · max length 128

open_intereststringrequired

Contracts held long, which equals contracts held short.

max length 24 · matches ^[0-9]+(\.[0-9]{1,2})?$

last_pricestring

Price of the most recent trade on any day. Absent until the market has traded.

max length 24 · matches ^[0-9]+(\.[0-9]{1,6})?$

dayMarketDayStatsrequired

Trading activity in the current trade day. Prices are absent until the market trades in the day.

Show properties

openstring

Price of the day's first trade.

max length 24 · matches ^[0-9]+(\.[0-9]{1,6})?$

highstring

Highest trade price of the day.

max length 24 · matches ^[0-9]+(\.[0-9]{1,6})?$

lowstring

Lowest trade price of the day.

max length 24 · matches ^[0-9]+(\.[0-9]{1,6})?$

volumestringrequired

Contracts traded in the day.

max length 24 · matches ^[0-9]+(\.[0-9]{1,2})?$

notionalstringrequired

Dollars traded in the day.

max length 24 · matches ^[0-9]+(\.[0-9]{1,6})?$

updated_atstring<date-time>required

When the exchange last updated these figures.

max length 40

Errors

permission_deniedThe caller lacks required access.

codestringrequired

Stable machine-readable error code.

detailErrorDetailrequired

Human-readable occurrence detail that clients must not parse.

min length 1 · max length 500

instanceErrorInstancerequired

Request identifier for troubleshooting with exchange support.

max length 100 · matches ^urn:request-id:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

channel_unavailableThe channel's upstream source cannot serve the operation right now. Retry with backoff; the connection stays usable.

codestringrequired

Stable machine-readable error code.

detailErrorDetailrequired

Human-readable occurrence detail that clients must not parse.

min length 1 · max length 500

instanceErrorInstancerequired

Request identifier for troubleshooting with exchange support.

max length 100 · matches ^urn:request-id:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

internal_errorAn unexpected failure left connection state safe to continue.

codestringrequired

Stable machine-readable error code.

detailErrorDetailrequired

Human-readable occurrence detail that clients must not parse.

min length 1 · max length 500

instanceErrorInstancerequired

Request identifier for troubleshooting with exchange support.

max length 100 · matches ^urn:request-id:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Channel Bindings

Channel Bindings

ws

methodGET

headers

UDX-Access-Keystringrequired

Opaque API key ID.

min length 1 · max length 255

UDX-Access-Timestampstringrequired

Unix time in milliseconds, within 30 seconds of server time.

max length 13 · matches ^[0-9]{13}$

UDX-Access-Signaturestringrequired

Standard-base64 RSA-PSS/SHA-256 signature with a 32-byte salt. Sign timestamp + "GET" + "/ws"; the upgrade request has no body hash and no idempotency key.

min length 1 · max length 1024

Sec-WebSocket-Protocolstringrequired

Negotiated dated WebSocket API version.

Examples

stats

{
  "type": "stats",
  "sid": 5,
  "seq": 3,
  "msg": {
    "stats": {
      "ticker": "UDX-EXAMPLE-MARKET",
      "open_interest": "1200",
      "last_price": "0.54",
      "day": {
        "open": "0.51",
        "high": "0.56",
        "low": "0.5",
        "volume": "840",
        "notional": "445.2"
      },
      "updated_at": "2026-01-01T00:00:00.000000Z"
    }
  }
}

permission_denied

{
  "type": "error",
  "sid": 7,
  "msg": {
    "code": "permission_denied",
    "detail": "the market is no longer visible to this member",
    "instance": "urn:request-id:4ecbe594-50fa-4b7a-950f-5ed74bb8372d"
  }
}

channel_unavailable

{
  "type": "error",
  "sid": 7,
  "msg": {
    "code": "channel_unavailable",
    "detail": "current market data is unavailable for this subscription",
    "instance": "urn:request-id:4ecbe594-50fa-4b7a-950f-5ed74bb8372d"
  }
}

internal_error

{
  "type": "error",
  "sid": 7,
  "msg": {
    "code": "internal_error",
    "detail": "the subscription could not be continued",
    "instance": "urn:request-id:4ecbe594-50fa-4b7a-950f-5ed74bb8372d"
  }
}