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
conversion_base string
Possible values: [USD, USDT]
Specifies conversion base for cross-exchange price differences
Default value: USDT
Example: USDT
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, pdp24h]
Specifies key to sort by
Default value: pdp
Example: pdp
sort string
Possible values: [asc, desc]
Specifies sort
Default value: asc
Example: asc
source_market string
Return results matching source market
Example: "spot, futures"
target_market string
Return results matching target market
Example: "spot, futures"

Header Parameters

X-DTMX-APIKEY stringrequired

Your DataMaxi+ API key

Responses

200

OK

application/json

Schema

Schema

conversion_base string
currency string

data

object[]

data specifies an array of premium data

Array [

bid string

Example: bitcoin

d integer

specifies the date and the time in UTC milliseconds

Example: 1629780000000

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

sad2p number

specifies -2% volume depth from source exchange

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

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

sm string

specifies the source market type

Example: spot

sp number

specifies the latest price of the source exchange in requested currency

Example: 45000

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

sq string

specifies the quote token of the source exchange

Example: USDT

st integer

Example: 1737525399882

sv number

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

Example: 1000000

tad2p number

specifies -2% volume depth from target exchange

Example: 10001.43

tb string

specifies the base token of the target exchange

Example: BTC

tbd2p number

specifies +2% volume depth from target exchange

Example: 10001.43

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

tm string

specifies the target market type

Example: futures

tp number

specifies the latest price of the target exchange

Example: 45010

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

tq string

specifies the quote token of the target exchange

Example: USDT

tt integer

Example: 1737525399882

tv number

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

Example: 1000000

]

key string
limit integer
page integer
sort string
total integer

Example (from schema)

{
  "conversion_base": "string",
  "currency": "string",
  "data": [
    {
      "bid": "bitcoin",
      "d": 1629780000000,
      "pdp": 0.02,
      "pdp15m": 0.02,
      "pdp1h": 0.02,
      "pdp24h": 0.02,
      "pdp30m": 0.02,
      "pdp4h": 0.02,
      "pdp5m": 0.02,
      "sad2p": 10001.43,
      "sb": "BTC",
      "sbd2p": 10001.43,
      "se": "binance",
      "shb": 10001.43,
      "sla": 10001.43,
      "sm": "spot",
      "sp": 45000,
      "spdp15m": 0.02,
      "spdp1h": 0.02,
      "spdp24h": 0.02,
      "spdp30m": 0.02,
      "spdp4h": 0.02,
      "spdp5m": 0.02,
      "sq": "USDT",
      "st": 1737525399882,
      "sv": 1000000,
      "tad2p": 10001.43,
      "tb": "BTC",
      "tbd2p": 10001.43,
      "te": "bybit",
      "thb": 10001.43,
      "tla": 10001.43,
      "tm": "futures",
      "tp": 45010,
      "tpdp15m": 0.02,
      "tpdp1h": 0.02,
      "tpdp24h": 0.02,
      "tpdp30m": 0.02,
      "tpdp4h": 0.02,
      "tpdp5m": 0.02,
      "tq": "USDT",
      "tt": 1737525399882,
      "tv": 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...