Premium

GET /api/v1/premium

Get real-time premium (price difference) data across exchanges.

Request

Query Parameters

source_exchange string

Specifies source exchange(s), separated by ,

target_exchange string

Specifies target exchange(s), separated by ,

asset string

Specifies asset(s), separated by ,

source_quote string

Specifies source quote(s), separated by ,

target_quote string

Specifies target quote(s), separated by ,

source_market string

Possible values: [spot, futures]

Specifies source market

target_market string

Possible values: [spot, futures]

Specifies target market

premium_type string

Possible values: [spot-spot, futures-futures, spot-futures]

Specifies premium type(s), separated by ,

currency string

Specifies currency applied to price values

Default value: USD

conversion_base string

Specifies conversion base

Default value: USDT

page integer

Page number

Default value: 1

limit integer

Page size

Default value: 10

sort string

Possible values: [asc, desc]

Specifies sort order

Default value: desc

key string

Specifies key to sort by

Default value: pdp

query string

Search query for filtering assets

only_transferable boolean

Filter only transferable assets

Default value: false

network string

Specifies network(s), separated by ,

min_sv number

Minimum source volume

min_tv number

Minimum target volume

Header Parameters

X-DTMX-APIKEY stringrequired

Your DataMaxi+ API key

Responses

application/json

Schema
Example (from schema)

Schema

conversion_base string

currency string

data

object[]

Array [

detail

object

bid string

Example: bitcoin

d integer

specifies the date and the time in UTC milliseconds

Example: 1629780000000

fg number

funding gap which is difference between source and target fundingrate without funding interval consideration

Example: 0.01

nfr number

net fundingrate which takes funding interval into account

Example: 0.01

pdp number

specifies the price difference percentage between the source and target exchanges

Example: 0.02

pdp1h number

specifies the price difference percentage between the source and target exchanges 1h ago

Example: 0.02

pdp4h number

specifies the price difference percentage between the source and target exchanges 4h ago

Example: 0.02

pdp5m number

specifies the price difference percentage between the source and target exchanges 5m ago

Example: 0.02

pdp15m number

specifies the price difference percentage between the source and target exchanges 15m ago

Example: 0.02

pdp24h number

specifies the price difference percentage between the source and target exchanges 24h ago

Example: 0.02

pdp30m number

specifies the price difference percentage between the source and target exchanges 30m ago

Example: 0.02

pmd integer

sepcifies premium duration

Example: 1

sad number

source ask depth within +2% base

Example: 10001.43

sad2p number

specifies -2% volume depth from source exchange

Example: 10001.43

sadf number

source ask depth within +2% quote

Example: 10001.43

sb string

specifies the base token of the source exchange

Example: BTC

sbd2p number

specifies +2% volume depth from source exchange

Example: 10001.43

sc string

for amm source ticker, amm source chain

Example: ethereum

se string

specifies the source exchange name

Example: binance

sfr number

source funding rate

Example: 0.01

sfri integer

source funding rate interval, 1 stands for 1 hour

Example: 1

sfrt integer

source fundingrate info timestamp in UTC millisecond

Example: 1737525399882

shb number

specifies highest bid from source exchange

Example: 10001.43

sla number

specifies lowest bid from source exchange

Example: 10001.43

sm string

specifies the source market type

Example: spot

sms boolean

boolean if source exchange margin is supported, returned only for spot market

Example: true

snd integer

source next distribution time in UTC milliseconds

Example: 1737525399882

soi number

Open Interest snapshot — USD-denominated. Source and target sides.

Example: 1234567890

soich1h number

OI % change over rolling 1h / 4h / 24h windows.

Example: 2.35

soich4h number

Example: -1.2

soich24h number

Example: 5.4

soivr number

OI / 24h USD quote volume. Crude "leverage per turnover" metric.

Example: 0.45

sp number

specifies the latest price of the source exchange in requested currency

Example: 45000

spa string

for amm source ticker, amm pool address

Example: 1.0392900530713021e+47

spdp1h number

specifies the price difference percentage of the source exchange in the last 1h

Example: 0.02

spdp4h number

specifies the price difference percentage of the source exchange in the last 4h

Example: 0.02

spdp5m number

specifies the price difference percentage of the source exchange in the last 5m

Example: 0.02

spdp15m number

specifies the price difference percentage of the source exchange in the last 15m

Example: 0.02

spdp24h number

specifies the price difference percentage of the source exchange in the last 24h

Example: 0.02

spdp30m number

specifies the price difference percentage of the source exchange in the last 30m

Example: 0.02

sq string

specifies the quote token of the source exchange

Example: USDT

st integer

specifies the date and the time of source ticker in UTC milliseconds

Example: 1737525399882

sv number

specifies the trading volume of the source exchange in the last 24 hours in requested currency

Example: 1000000

t boolean

transferable, null if unknown

Example: true

tad2p number

specifies -2% volume depth from target exchange

Example: 10001.43

tb string

specifies the base token of the target exchange

Example: BTC

tbd number

target bid depth within -2% base

Example: 10001.43

tbd2p number

specifies +2% volume depth from target exchange

Example: 10001.43

tbdf number

target bid depth within -2% quote

Example: 10001.43

tc string

for amm target ticker, amm target chain

Example: ethereum

te string

specifies the target exchange name

Example: bybit

tfr number

target funding rate

Example: 0.01

tfri integer

target funding rate interval, 1 stands for 1 hour

Example: 1

tfrt integer

target fundingrate info timestamp in UTC millisecond

Example: 1737525399882

thb number

specifies highest bid from target exchange

Example: 10001.43

tla number

specifies lowest bid from target exchange

Example: 10001.43

tm string

specifies the target market type

Example: futures

tms boolean

boolean if target exchange margin is supported, returned only for spot market

Example: true

tnd integer

target next distribution time in UTC millisconds

Example: 1737525399882

toi number

Example: 987654321

toich1h number

Example: 2.35

toich4h number

Example: -1.2

toich24h number

Example: 5.4

toivr number

Example: 0.52

tp number

specifies the latest price of the target exchange

Example: 45010

tpa string

for amm target ticker, amm pool address

Example: 1.0392900530713021e+47

tpdp15m number

specifies the price difference percentage of the target exchange in the last 15m

Example: 0.02

tpdp1h number

specifies the price difference percentage of the target exchange in the last 1h

Example: 0.02

tpdp4h number

specifies the price difference percentage of the target exchange in the last 4h

Example: 0.02

tpdp5m number

specifies the price difference percentage of the target exchange in the last 5m

Example: 0.02

tpdp24h number

specifies the price difference percentage of the target exchange in the last 24h

Example: 0.02

tpdp30m number

specifies the price difference percentage of the target exchange in the last 30m

Example: 0.02

tq string

specifies the quote token of the target exchange

Example: USDT

tt integer

specifies the date and the time of target ticker in UTC milliseconds

Example: 1737525399882

tv number

specifies the trading volume of the target exchange in the last 24 hours in requested currency

Example: 1000000

source_annualized_funding_rate number

target_annualized_funding_rate number

]

key string

limit integer

page integer

sort string

total integer

{
  "conversion_base": "string",
  "currency": "string",
  "data": [
    {
      "detail": {
        "bid": "bitcoin",
        "d": 1629780000000,
        "fg": 0.01,
        "nfr": 0.01,
        "pdp": 0.02,
        "pdp1h": 0.02,
        "pdp4h": 0.02,
        "pdp5m": 0.02,
        "pdp15m": 0.02,
        "pdp24h": 0.02,
        "pdp30m": 0.02,
        "pmd": 1,
        "sad": 10001.43,
        "sad2p": 10001.43,
        "sadf": 10001.43,
        "sb": "BTC",
        "sbd2p": 10001.43,
        "sc": "ethereum",
        "se": "binance",
        "sfr": 0.01,
        "sfri": 1,
        "sfrt": 1737525399882,
        "shb": 10001.43,
        "sla": 10001.43,
        "sm": "spot",
        "sms": true,
        "snd": 1737525399882,
        "soi": 1234567890,
        "soich1h": 2.35,
        "soich4h": -1.2,
        "soich24h": 5.4,
        "soivr": 0.45,
        "sp": 45000,
        "spa": 1.0392900530713021e+47,
        "spdp1h": 0.02,
        "spdp4h": 0.02,
        "spdp5m": 0.02,
        "spdp15m": 0.02,
        "spdp24h": 0.02,
        "spdp30m": 0.02,
        "sq": "USDT",
        "st": 1737525399882,
        "sv": 1000000,
        "t": true,
        "tad2p": 10001.43,
        "tb": "BTC",
        "tbd": 10001.43,
        "tbd2p": 10001.43,
        "tbdf": 10001.43,
        "tc": "ethereum",
        "te": "bybit",
        "tfr": 0.01,
        "tfri": 1,
        "tfrt": 1737525399882,
        "thb": 10001.43,
        "tla": 10001.43,
        "tm": "futures",
        "tms": true,
        "tnd": 1737525399882,
        "toi": 987654321,
        "toich1h": 2.35,
        "toich4h": -1.2,
        "toich24h": 5.4,
        "toivr": 0.52,
        "tp": 45010,
        "tpa": 1.0392900530713021e+47,
        "tpdp15m": 0.02,
        "tpdp1h": 0.02,
        "tpdp4h": 0.02,
        "tpdp5m": 0.02,
        "tpdp24h": 0.02,
        "tpdp30m": 0.02,
        "tq": "USDT",
        "tt": 1737525399882,
        "tv": 1000000
      },
      "source_annualized_funding_rate": 0,
      "target_annualized_funding_rate": 0
    }
  ],
  "key": "string",
  "limit": 0,
  "page": 0,
  "sort": "string",
  "total": 0
}

Bad Request

application/json

Schema
Example (from schema)

Schema

error string

error specifies the error message

{
  "error": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

error string

error specifies the error message

{
  "error": "string"
}

Internal Server Error

application/json

Schema
Example (from schema)

Schema

error string

error specifies the error message

{
  "error": "string"
}

Premium

/api/v1/premium

Request​

Query Parameters

Header Parameters

Responses​

Request

Responses