Premium

GET 
/api/v1/premium

Get the latest premium values.

Request

Query Parameters

sourceExchange string
Specifies source exchange
Example: binance
targetExchange string
Specifies target exchange
Example: upbit
asset string
Specifies base aset. You can specify multiple quotes at once by separating them with commas.
Example: BTC
sourceQuote string
Specifies source quote asset. You can specify multiple quotes at once by separating them with commas.
Example: USDT
targetQuote string
Specifies target quote asset. You can specify multiple quotes at once by separating them with commas.
Example: KRW
currency string
Possible values: [KRW, USD]
Specifies currency for cross-exchange price differences
Default value: USD
Example: KRW
page integer
Page number
Default value: 1
Example: 1
limit integer
Page size
Default value: 10
Example: 100
key string
Possible values: [pd, pdp, spdp, spdp, sp, sv, pdp24]
Specifies key to sort by
Default value: pdp
Example: pdp
sort string
Possible values: [asc, desc]
Specifies sort
Default value: asc
Example: asc

Header Parameters

X-DTMX-APIKEY stringrequired

Your DataMaxi+ API key

Responses

200

OK

application/json

Schema

Schema

currency string

data

object[]

data specifies an array of premium data

Array [

bid string

Example: bitcoin

cc string

specifies the type of currency used to express price differences between exchanges

Example: USD

d integer

specifies the date and the time in UTC milliseconds

Example: 1629780000000

dc string

specifies the type of requested currency for prices and their differences

Example: KRW

dpd number

specifies the price difference between the source and target exchanges in requested currency

Example: 10

dsp number

specifies the latest price of the source exchange in requested currency

Example: 45000

dspcd15m number

specifies the price change difference of the source exchange in the last 15m in requested currency

Example: 1000

dspcd1h number

specifies the price change difference of the source exchange in the last 1h in requested currency

Example: 1000

dspcd24h number

specifies the price change difference of the source exchange in the last 24h in requested currency

Example: 1000

dspcd30m number

specifies the price change difference of the source exchange in the last 30m in requested currency

Example: 1000

dspcd4h number

specifies the price change difference of the source exchange in the last 4h in requested currency

Example: 1000

dspcd5m number

specifies the price change difference of the source exchange in the last 5m in requested currency

Example: 1000

dsv number

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

Example: 1000000

dtp number

specifies the latest price of the target exchange

Example: 45010

dtpcd15m number

specifies the price change difference of the target exchange in the last 15m in requested currency

Example: 1000

dtpcd1h number

specifies the price change difference of the target exchange in the last 1h in requested currency

Example: 1000

dtpcd24h number

specifies the price change difference of the target exchange in the last 24h in requested currency

Example: 1000

dtpcd30m number

specifies the price change difference of the target exchange in the last 30m in requested currency

Example: 1000

dtpcd4h number

specifies the price change difference of the target exchange in the last 4h in requested currency

Example: 1000

dtpcd5m number

specifies the price change difference of the target exchange in the last 5m in requested currency

Example: 1000

dtv number

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

Example: 1000000

pd number

specifies the price difference between the source and target exchanges (null if quotes do not match)

Example: 10

pdp number

specifies the price difference percentage between the source and target exchanges

Example: 0.02

pdp15m number

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

Example: 0.02

pdp1h number

specifies the price difference percentage between the source and target exchanges 1h 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

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

pdusd number

specifies the USD price difference between the source and target exchanges

Example: 10

sb string

specifies the base token of the source exchange

Example: BTC

se string

specifies the source exchange name

Example: binance

shb number

specifies highest bid from source exchange

Example: 10001.43

sla number

specifies lowest bid from source exchange

Example: 10001.43

sld number

specifies -2% volume depth from source exchange

Example: 10001.43

sm string

specifies the source market type

Example: spot

sop number

specifies orderbook price from source exchange (avg of highest bid & lowest ask)

Example: 10001.43

sp number

specifies the latest price of the source exchange

Example: 45000

spcd15m number

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

Example: 1000

spcd1h number

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

Example: 1000

spcd24h number

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

Example: 1000

spcd30m number

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

Example: 1000

spcd4h number

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

Example: 1000

spcd5m number

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

Example: 1000

spcdusd15m number

specifies the price change difference in USD of the source exchange in the last 15m

Example: 1000

spcdusd1h number

specifies the price change difference in USD of the source exchange in the last 1h

Example: 1000

spcdusd24h number

specifies the price change difference in USD of the source exchange in the last 24h

Example: 1000

spcdusd30m number

specifies the price change difference in USD of the source exchange in the last 30m

Example: 1000

spcdusd4h number

specifies the price change difference in USD of the source exchange in the last 4h

Example: 1000

spcdusd5m number

specifies the price change difference in USD of the source exchange in the last 5m

Example: 1000

spdp15m number

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

Example: 0.02

spdp1h number

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

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

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

spusd number

specifies the latest price in USD of the source exchange

Example: 45000

sq string

specifies the quote token of the source exchange

Example: USDT

st integer

Example: 1737525399882

sud number

specifies +2% volume depth from source exchange

Example: 10001.43

sv number

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

Example: 1000000

svusd number

specifies the trading volume of the source exchange in the last 24 hours in USD

Example: 1000000

tb string

specifies the base token of the target exchange

Example: BTC

te string

specifies the target exchange name

Example: bybit

thb number

specifies highest bid from target exchange

Example: 10001.43

tla number

specifies lowest bid from target exchange

Example: 10001.43

tld number

specifies -2% volume depth from target exchange

Example: 10001.43

tm string

specifies the target market type

Example: futures

top number

specifies orderbook price from target exchange (avg of highest bid & lowest ask)

Example: 10001.43

tp number

specifies the latest price of the target exchange

Example: 45010

tpcd15m number

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

Example: 1000

tpcd1h number

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

Example: 1000

tpcd24h number

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

Example: 1000

tpcd30m number

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

Example: 1000

tpcd4h number

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

Example: 1000

tpcd5m number

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

Example: 1000

tpcdusd15m number

specifies the price change difference in USD of the target exchange in the last 15m

Example: 1000

tpcdusd1h number

specifies the price change difference in USD of the target exchange in the last 1h

Example: 1000

tpcdusd24h number

specifies the price change difference in USD of the target exchange in the last 24h

Example: 1000

tpcdusd30m number

specifies the price change difference in USD of the target exchange in the last 30m

Example: 1000

tpcdusd4h number

specifies the price change difference in USD of the target exchange in the last 4h

Example: 1000

tpcdusd5m number

specifies the price change difference in USD of the target exchange in the last 5m

Example: 1000

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

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

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

tpusd number

specifies the latest price in USD of the target exchange

Example: 45010

tq string

specifies the quote token of the target exchange

Example: USDT

tt integer

Example: 1737525399882

tud number

specifies +2% volume depth from target exchange

Example: 10001.43

tv number

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

Example: 1000000

tvusd number

specifies the trading volume of the target exchange in the last 24 hours in USD

Example: 1000000

]

key string
limit integer
page integer
sort string
total integer

Example (from schema)

{
  "currency": "string",
  "data": [
    {
      "bid": "bitcoin",
      "cc": "USD",
      "d": 1629780000000,
      "dc": "KRW",
      "dpd": 10,
      "dsp": 45000,
      "dspcd15m": 1000,
      "dspcd1h": 1000,
      "dspcd24h": 1000,
      "dspcd30m": 1000,
      "dspcd4h": 1000,
      "dspcd5m": 1000,
      "dsv": 1000000,
      "dtp": 45010,
      "dtpcd15m": 1000,
      "dtpcd1h": 1000,
      "dtpcd24h": 1000,
      "dtpcd30m": 1000,
      "dtpcd4h": 1000,
      "dtpcd5m": 1000,
      "dtv": 1000000,
      "pd": 10,
      "pdp": 0.02,
      "pdp15m": 0.02,
      "pdp1h": 0.02,
      "pdp24h": 0.02,
      "pdp30m": 0.02,
      "pdp4h": 0.02,
      "pdp5m": 0.02,
      "pdusd": 10,
      "sb": "BTC",
      "se": "binance",
      "shb": 10001.43,
      "sla": 10001.43,
      "sld": 10001.43,
      "sm": "spot",
      "sop": 10001.43,
      "sp": 45000,
      "spcd15m": 1000,
      "spcd1h": 1000,
      "spcd24h": 1000,
      "spcd30m": 1000,
      "spcd4h": 1000,
      "spcd5m": 1000,
      "spcdusd15m": 1000,
      "spcdusd1h": 1000,
      "spcdusd24h": 1000,
      "spcdusd30m": 1000,
      "spcdusd4h": 1000,
      "spcdusd5m": 1000,
      "spdp15m": 0.02,
      "spdp1h": 0.02,
      "spdp24h": 0.02,
      "spdp30m": 0.02,
      "spdp4h": 0.02,
      "spdp5m": 0.02,
      "spusd": 45000,
      "sq": "USDT",
      "st": 1737525399882,
      "sud": 10001.43,
      "sv": 1000000,
      "svusd": 1000000,
      "tb": "BTC",
      "te": "bybit",
      "thb": 10001.43,
      "tla": 10001.43,
      "tld": 10001.43,
      "tm": "futures",
      "top": 10001.43,
      "tp": 45010,
      "tpcd15m": 1000,
      "tpcd1h": 1000,
      "tpcd24h": 1000,
      "tpcd30m": 1000,
      "tpcd4h": 1000,
      "tpcd5m": 1000,
      "tpcdusd15m": 1000,
      "tpcdusd1h": 1000,
      "tpcdusd24h": 1000,
      "tpcdusd30m": 1000,
      "tpcdusd4h": 1000,
      "tpcdusd5m": 1000,
      "tpdp15m": 0.02,
      "tpdp1h": 0.02,
      "tpdp24h": 0.02,
      "tpdp30m": 0.02,
      "tpdp4h": 0.02,
      "tpdp5m": 0.02,
      "tpusd": 45010,
      "tq": "USDT",
      "tt": 1737525399882,
      "tud": 10001.43,
      "tv": 1000000,
      "tvusd": 1000000
    }
  ],
  "key": "string",
  "limit": 0,
  "page": 0,
  "sort": "string",
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

Loading...