Index Data

The index price of different assets to be subscribed are controlled by the parameters in the subscription message listed below.

/trading-api/v1/index-data

Operations

SEND/trading-api/v1/index-data

Subscribe

Multiple subscriptions could be opened within the same websocket.

The index price of different assets to be subscribed are controlled by the parameters in the subscription message listed below.

Operation IDsubscribe

Accepts the following message:

Subscription

Let you subscribe to a given topic

• application/json

Message IDsubscribe

object

Examples

{
  "method": "subscribe",
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "type": "command",
  "params": {
    "topic": "indexPrice",
    "assetSymbol": "USDC"
  }
}

This example has been generated automatically.

RECEIVE/trading-api/v1/index-data

After subscribing, the server sends :

• an acknowledgement
• followed by a snapshot
• followed by incremental updates.

Operation IDsubscribe-ack

Sends one of the following messages:

• #1Acknowledgment

  Confirm the topic being subscribed

  • application/json

  Message IDsubscribe-ack

  object

  Examples

  {
    "id": "1611082473000",
    "jsonrpc": "2.0",
    "result": {
      "responseCodeName": "OK",
      "responseCode": "200",
      "message": "Successfully subscribed"
    }
  }

  This example has been generated automatically.

• #2Snapshot

  Snapshot to the subscribed index price data

  • application/json

  Message IDsubscribe-msg-0

  object

  Examples

  {
    "type": "snapshot",
    "dataType": "V1TAIndexPrice",
    "data": {
      "assetSymbol": "USDC",
      "price": "1.0000",
      "updatedAtDatetime": "2024-06-29T06:29:50.500Z",
      "updatedAtTimestamp": "1719642590000"
    }
  }

  This example has been generated automatically.

• #3Update

  Incremental update to the subscribed index price data

  • application/json

  Message IDsubscribe-msg-1

  object

  Examples

  {
    "type": "update",
    "dataType": "V1TAIndexPrice",
    "data": {
      "assetSymbol": "USDC",
      "price": "1.0000",
      "updatedAtDatetime": "2024-06-29T06:29:50.500Z",
      "updatedAtTimestamp": "1719642590000"
    }
  }

  This example has been generated automatically.

RECEIVE/trading-api/v1/index-data

In case of invalid subscription message, an error rejection would be sent.

Operation IDsubscribe-nack

Sends the following message:

Rejection

Explain why the topic could not be subscribed

• application/json

Message IDsubscribe-nack

object

Examples

{
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "error": {
    "code": "-32602",
    "errorCode": "29013",
    "errorCodeName": "'abcde' is not a valid topic"
  }
}

This example has been generated automatically.

SEND/trading-api/v1/index-data

Keepalive

In case nothing is subscribed to, keep the websocket connection alive.

Operation IDkeepalive-ping

Accepts the following message:

Keepalive Ping

• application/json

Message IDkeepalive-ping

object

Examples

{
  "method": "keepalivePing",
  "params": {},
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "type": "command"
}

This example has been generated automatically.

RECEIVE/trading-api/v1/index-data

Acknowledgement returned by the server in response to a keepalive-ping.

Operation IDkeepalive-pong

Sends the following message:

Keepalive Pong

• application/json

Message IDkeepalive-pong

object

Examples

{
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "result": {
    "responseCodeName": "OK",
    "responseCode": 200,
    "message": "Keep alive pong"
  }
}

This example has been generated automatically.

SEND/trading-api/v1/index-data

Unsubscribe

Closes every open subscription matching the given topic and asset symbol, while keeping your websocket opened.

Operation IDunsubscribe

Accepts the following message:

Unsubscription

Let you unsubscribe to a given topic

• application/json

Message IDunsubscribe

object

Examples

{
  "method": "unsubscribe",
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "type": "command",
  "params": {
    "topic": "indexPrice",
    "assetSymbol": "USDC"
  }
}

This example has been generated automatically.

RECEIVE/trading-api/v1/index-data

After unsubscribing, the server sends an acknowledgement.

Operation IDunsubscribe-ack

Sends the following message:

Acknowledgment

Confirm the topic being unsubscribed

• application/json

Message IDunsubscribe-ack

object

Examples

{
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "result": {
    "responseCodeName": "OK",
    "responseCode": 200,
    "message": "Successfully unsubscribed"
  }
}

This example has been generated automatically.

RECEIVE/trading-api/v1/index-data

In case of invalid unsubscription message, an error rejection would be sent.

Operation IDunsubscribe-nack

Sends the following message:

Rejection

Explain why the topic could not be unsubscribed

• application/json

Message IDunsubscribe-nack

object

Examples

{
  "id": "1611082473000",
  "jsonrpc": "2.0",
  "error": {
    "code": "-32602",
    "errorCode": "29013",
    "errorCodeName": "'abcde' is not a valid topic"
  }
}

This example has been generated automatically.