Mini Ticker Stream

24hr rolling window mini-ticker statistics for a single symbol. These are NOT the statistics of the UTC day, but a 24hr rolling window from requestTime to 24hrs before.

Update Speed

• Pushed on each block that is at least 1 second since the last push.

Subscribe Request

• Subscribe Schema

See WsMiniTickerSubscriptionParams in Schema.

interface SubscribeRequest {
  op: "subscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  params: WsMiniTickerSubscriptionParams;
}

• Subscribe Ack Schema

See WsMiniTickerSubscriptionResult in Schema.

interface SubscriptionResult {
  op: "subscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  result: WsMiniTickerSubscriptionResult | null;
  success: boolean; // Indicates if the request was successfully processed by the engine.
  connID: string;
  error: string | null; // Condition: If success is false. Error message.
  time_in: number; // The timestamp when the subscription was received on the wire, just prior to parsing data, in milliseconds.
  time_out: number; // The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data, in milliseconds.
}

• Example: Subscribe

{
  "op": "subscribe",
  "params": {
    "channel": "miniTicker",
    "symbols": ["BTC-USD"]
  }
}

• Example: Subscribe Ack

{
  "op": "subscribe",
  "result": {
    "channel": "miniTicker",
    "symbol": "BTC-USD"
  },
  "success": true,
  "connID": "0x9b2b4dab436282ffc8308ec125e0a4f4",
  "time_in": 1672515782130,
  "time_out": 1672515782136
}

Unsubscribe Request

• Unsubscribe Schema

See WsMiniTickerSubscriptionParams in Schema.

interface UnsubscribeRequest {
  op: "unsubscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  params: WsMiniTickerSubscriptionParams;
}

• Unsubscribe Ack Schema

See WsMiniTickerSubscriptionResult in Schema.

interface UnsubscriptionResult {
  op: "unsubscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  result: WsMiniTickerSubscriptionResult | null;
  success: boolean; // Indicates if the request was successfully processed by the engine.
  connID: string;
  error: string | null; // Condition: If success is false. Error message.
  time_in: number; // The timestamp when the subscription was received on the wire, just prior to parsing data, in milliseconds.
  time_out: number; // The timestamp when the acknowledgement was sent on the wire, just prior to transmitting data, in milliseconds.
}

• Example: Unsubscribe

{
  "op": "unsubscribe",
  "params": {
    "channel": "miniTicker",
    "symbols": ["BTC-USD"]
  }
}

• Example: Unsubscribe Ack

{
  "op": "unsubscribe",
  "result": {
    "channel": "miniTicker",
    "symbol": "BTC-USD"
  },
  "success": true,
  "connID": "0x9b2b4dab436282ffc8308ec125e0a4f4",
  "time_in": 1672515782130,
  "time_out": 1672515782136
}

Snapshot / Update Response

• Snapshot / Update Schema

See WsMiniTickerData in Schema.

interface MiniTickerResponse {
  channel: "miniTicker";
  type: "snapshot" | "update";
  data: Array<WsMiniTickerData>;
}

• Example: Snapshot

{
  "channel": "miniTicker",
  "type": "snapshot",
  "data": [
    {
      "E": 1766907116587,
      "s": "BTC-USD",
      "c": "87644",
      "o": "87545",
      "h": "87923",
      "l": "87274",
      "v": "5839.63544",
      "q": "511238370.12834"
    }
  ]
}

• Example: Update

{
  "channel": "miniTicker",
  "type": "update",
  "data": [
    {
      "E": 1766907116587,
      "s": "BTC-USD",
      "c": "87644",
      "o": "87545",
      "h": "87923",
      "l": "87274",
      "v": "5839.63544",
      "q": "511238370.12834"
    }
  ]
}