All Coin Prices Stream

Coin price and margin ratio for all coins pushed on updating. This stream is available for perps only. Note that only coin prices that have changed will be present in the update array.

Update Speed

• Pushed on each block that is at least 1 second since the last push when price or margin ratio changes.

Subscribe Request

• Subscribe Schema

See WsAllCoinPriceSubscriptionParams in Schema.

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

• Subscribe Ack Schema

See WsAllCoinPriceSubscriptionResult in Schema.

interface SubscriptionResult {
  op: "subscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  result: WsAllCoinPriceSubscriptionResult | 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": "allCoinPrice"
  }
}

• Example: Subscribe Ack

{
  "op": "subscribe",
  "result": {
    "channel": "allCoinPrice"
  },
  "success": true,
  "connID": "0xb0922dfe2b14dadb1195ea4db2b45508",
  "time_in": 1672515782130,
  "time_out": 1672515782136
}

Unsubscribe Request

• Unsubscribe Schema

See WsAllCoinPriceSubscriptionParams in Schema.

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

• Unsubscribe Ack Schema

See WsAllCoinPriceSubscriptionResult in Schema.

interface UnsubscriptionResult {
  op: "unsubscribe";
  id: number | null; // Optional client originated request identifier sent as acknowledgment in the response.
  result: WsAllCoinPriceSubscriptionResult | 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": "allCoinPrice"
  }
}

• Example: Unsubscribe Ack

{
  "op": "unsubscribe",
  "result": {
    "channel": "allCoinPrice"
  },
  "success": true,
  "connID": "0xb0922dfe2b14dadb1195ea4db2b45508",
  "time_in": 1672515782130,
  "time_out": 1672515782136
}

Snapshot / Update Response

• Snapshot / Update Schema

See WsCoinPriceData in Schema.

interface AllCoinPriceResponse {
  channel: "allCoinPrice";
  type: "snapshot" | "update";
  data: Array<WsCoinPriceData>;
}

• Example: Snapshot

{
  "channel": "allCoinPrice",
  "type": "snapshot",
  "data": [
    {
      "E": 1781104148461,
      "i": 1,
      "a": "vBTC",
      "p": "61984.5",
      "mr": "0.9"
    },
    {
      "E": 1781104148461,
      "i": 2,
      "a": "vETH",
      "p": "1640.66",
      "mr": "0.85"
    }
  ]
}

• Example: Update

{
  "channel": "allCoinPrice",
  "type": "update",
  "data": [
    {
      "E": 1781104149161,
      "i": 2,
      "a": "vETH",
      "p": "1640.66",
      "mr": "0.85"
    },
    {
      "E": 1781104149161,
      "i": 44,
      "a": "vDEFI.ssi",
      "p": "0.3307316954868111",
      "mr": "0"
    }
  ]
}