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
premiumId string

Specifies premium ID. You can specify multiple IDs at once by separating them with commas.

currency string
Possible values: [KRW, USD, USDT]
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
query string
Specifies query used for search
Example: BTC
page integer
Page number
Default value: 1
Example: 1
limit integer
Page size
Default value: 100
Example: 100
key string
Possible values: [dpd, pdp, pdp24h, pdp4h, pdp1h, pdp30m, pdp15m, pdp5m, sp, tp, spdp24h, spdp4h, spdp1h, spdp30m, spdp15m, spdp5m, sv, tv]
Specifies key to sort by
Default value: pdp
Example: pdp
sort string
Possible values: [asc, desc]
Specifies sort
Default value: asc
Example: asc
min_pd string
Return results with price difference in USD above min_pd
Example: 10
max_pd string
Return results with price difference in USD below max_pd
Example: 10
min_pdp string
Return results with price difference percentage above min_pdp
Example: 0.1
max_pdp string
Return results with price difference percentage below max_pdp
Example: 0.1
min_pdp24h string
Return results with price difference percentage from 24h ago above min_pdp24h
Example: 0.1
max_pdp24h string
Return results with price difference percentage from 24h ago below max_pdp24h
Example: 0.1
min_pdp4h string
Return results with price difference percentage from 4h ago above min_pdp4h
Example: 0.1
max_pdp4h string
Return results with price difference percentage from 4h ago below max_pdp4h
Example: 0.1
min_pdp1h string
Return results with price difference percentage from 1h ago above min_pdp1h
Example: 0.1
max_pdp1h string
Return results with price difference percentage from 1h ago below max_pdp1h
Example: 0.1
min_pdp30m string
Return results with price difference percentage from 30m ago above min_pdp30m
Example: 0.1
max_pdp30m string
Return results with price difference percentage from 30m ago below max_pdp30m
Example: 0.1
min_pdp15m string
Return results with price difference percentage from 15m ago above min_pdp15m
Example: 0.1
max_pdp15m string
Return results with price difference percentage from 15m ago below max_pdp15m
Example: 0.1
min_pdp5m string
Return results with price difference percentage from 5m ago above min_pdp5m
Example: 0.1
max_pdp5m string
Return results with price difference percentage from 5m ago below max_pdp5m
Example: 0.1
min_dsp string
Return results with price in fiat on source exchange above min_dsp
Example: 1000
max_dsp string
Return results with price in fiat on source exchange below max_dsp
Example: 1000
min_dtp string
Return results with price in fiat on target exchange above min_dtp
Example: 1000
max_dtp string
Return results with price in fiat on target exchange below max_dtp
Example: 1000
min_spdp24h string
Return results with price difference percentage (between now and 24h ago on source exchange) above min_spdp24h
Example: 0.1
max_spdp24h string
Return results with price difference percentage (between now and 24h ago on source exchange) below max_spdp24h
Example: 0.1
min_spdp4h string
Return results with price difference percentage (between now and 4h ago on source exchange) above min_spdp4h
Example: 0.1
max_spdp4h string
Return results with price difference percentage (between now and 4h ago on source exchange) below max_spdp4h
Example: 0.1
min_spdp1h string
Return results with price difference percentage (between now and 1h ago on source exchange) above min_spdp1h
Example: 0.1
max_spdp1h string
Return results with price difference percentage (between now and 1h ago on source exchange) below max_spdp1h
Example: 0.1
min_spdp30m string
Return results with price difference percentage (between now and 30m ago on source exchange) above min_spdp30m
Example: 0.1
max_spdp30m string
Return results with price difference percentage (between now and 30m ago on source exchange) below max_spdp30m
Example: 0.1
min_spdp15m string
Return results with price difference percentage (between now and 15m ago on source exchange) above min_spdp15m
Example: 0.1
max_spdp15m string
Return results with price difference percentage (between now and 15m ago on source exchange) below max_spdp15m
Example: 0.1
min_spdp5m string
Return results with price difference percentage (between now and 5m ago on source exchange) above min_spdp5m
Example: 0.1
max_spdp5m string
Return results with price difference percentage (between now and 5m ago on source exchange) below max_spdp5m
Example: 0.1
min_sv string
Return results with 24h volume in fiat on source exchange above min_sv
Example: 1000000
max_sv string
Return results with 24h volume in fiat on source exchange below max_sv
Example: 1000000
min_tv string
Return results with 24h volume in fiat on target exchange above min_tv
Example: 1000000
max_tv string
Return results with 24h volume in fiat on target exchange below max_tv
Example: 1000000
min_net_funding_rate string
Return results with net funding rate above min_net_funding_rate
Example: 0.1
max_net_funding_rate string
Return results with net funding rate below max_net_funding_rate
Example: 0.1
min_source_funding_rate string
Return results with source funding rate above min_source_funding_rate
Example: 0.1
max_source_funding_rate string
Return results with source funding rate below max_source_funding_rate
Example: 0.1
min_target_funding_rate string
Return results with target funding rate above min_target_funding_rate
Example: 0.1
max_target_funding_rate string
Return results with target funding rate below max_target_funding_rate
Example: 0.1
source_market string
Return results matching source market
Example: "spot, futures"
target_market string
Return results matching target market
Example: "spot, futures"
only_transferable boolean
Return only transferable if set true
Default value: false
Example: true
network string
Return results containing only specified network
Example: "ethereum"
source_funding_rate_interval string
Return results with min source funding rate interval
Example: "1,4,8"
target_funding_rate_interval string
Return results with min target funding rate interval
Example: "1,4,8"
premium_type string
Return based on matching premium_type
Default value: ""
Example: "spot-futures, spot-spot, futures-futures"
token_include string
Return results containing only specified token
Example: "BTC,ETH"
token_exclude string
Return results not containing specified token
Example: "BTC,ETH"

Responses

200

OK

application/json

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

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

pmd integer

sepcifies premium duration

Example: 1

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

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

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

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

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

tbd2p number

specifies +2% volume depth from target exchange

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

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

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

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

Example (from schema)

{
  "conversion_base": "string",
  "currency": "string",
  "data": [
    {
      "detail": {
        "bid": "bitcoin",
        "d": 1629780000000,
        "fg": 0.01,
        "nfr": 0.01,
        "pdp": 0.02,
        "pdp15m": 0.02,
        "pdp1h": 0.02,
        "pdp24h": 0.02,
        "pdp30m": 0.02,
        "pdp4h": 0.02,
        "pdp5m": 0.02,
        "pmd": 1,
        "sad2p": 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,
        "sp": 45000,
        "spa": 1.0392900530713021e+47,
        "spdp15m": 0.02,
        "spdp1h": 0.02,
        "spdp24h": 0.02,
        "spdp30m": 0.02,
        "spdp4h": 0.02,
        "spdp5m": 0.02,
        "sq": "USDT",
        "st": 1737525399882,
        "sv": 1000000,
        "t": true,
        "tad2p": 10001.43,
        "tb": "BTC",
        "tbd2p": 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,
        "tp": 45010,
        "tpa": 1.0392900530713021e+47,
        "tpdp15m": 0.02,
        "tpdp1h": 0.02,
        "tpdp24h": 0.02,
        "tpdp30m": 0.02,
        "tpdp4h": 0.02,
        "tpdp5m": 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
}

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"
}

500

Internal Server Error

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

Loading...