Skip to main content

Premium

Premium data stream.

Connect​

websocat wss://api.datamaxiplus.com/ws/v1/premium -H 'X-DTMX-APIKEY: $YOUR_API_KEY'

Subscribe​

  • method specifies the type of request.
  • params list represents symbols on which to compute premium between source and target exchanges that user wants to subscribe. The format of parameter is {sourceBase}-{sourceQuote}@{sourceExchange}@{sourceMarket}#{targetBase}-{targetQuote}@{targetExchange}@{targetMarket}#{currency}#{conversionBase} (e.g. "BTC-USDT@bybit@spot#BTC-KRW@upbit@spot#KRW#USDT").
    • You can request the list of supported exchanges with /api/v1/premium/exchanges endpoint.
    • Supported currency: USD, KRW
    • Supported conversion base: USDT, USD
  • The id uniquely identifies the subscription request.
{
  "method": "SUBSCRIBE",
  "params": [
    string
  ],
  "id": int32
}

Response​

Schema
    keystring

    Composite subscription key for the pair.

    source_exchangestring

    Source exchange name.

    target_exchangestring

    Target exchange name.

    token_idstring

    Unified token id.

    source_basestring

    Source base token.

    source_quotestring

    Source quote token.

    target_quotestring

    Target quote token.

    source_marketstring

    Source market type (e.g. spot/futures).

    target_marketstring

    Target market type (e.g. spot/futures).

    premiumnumber

    Premium value (nullable).

    source_pricenumber

    Latest price on the source exchange (nullable).

    target_pricenumber

    Latest price on the target exchange (nullable).

    timestampinteger

    Timestamp in UTC milliseconds.