coinbene openapi rest interface description

 

Basic Information

restriction of visit

Interface Type

 

WebSocket Specification

WebSocket Interface Specification

 

 

Interface Specification

Public Interface - Get Spot all Tickers and all Market pairs configuration information

Request parameters: no

Return field description:

NameTypeDescriptionstatus
trading_pairsstringIdentifier of a ticker with delimiter to separate base/quote, eg. BTC-USDT (Price of BTC is quoted in USDT)Mandatory
last_pricestringLast transacted price of base currency based on given quote currencyMandatory
lowest_askstringLowest Ask price of base currency based on given quote currencyMandatory
highest_bidstringHighest bid price of base currency based on given quote currencyMandatory
base_volumestring24-hr volume of market pair denoted in BASE currencyMandatory
quote_volumestring24-hr volume of market pair denoted in QUOTE currencyMandatory
price_change_percent_24hstring24-hr % price change of market pairMandatory
highest_price_24hstringHighest price of base currency based on given quote currency in the last 24-hrsMandatory
lowest_price_24hstringLowest price of base currency based on given quote currency in the last 24-hrsMandatory
base_currencystringSymbol/currency code of base currency, eg. BTCMandatory
quote_currencystringSymbol/currency code of quote currency, eg. USDTMandatory

Public Interface - Get Spot all asset configuration information

Request parameters: no

Return field description:

NameTypeDescriptionstatus
namestringFull name of cryptocurrencyMandatory
can_withdrawstringIdentifies whether withdrawals are enabled or disabled.Mandatory
can_depositstringIdentifies whether deposits are enabled or disabled.Mandatory
min_withdrawstringIdentifies the single minimum withdrawal amount of a cryptocurrency.Recommended
max_withdrawstringIdentifies the single maximum withdrawal amount of a cryptocurrency.Recommended
maker_feestringFees applied when liquidity is added to the order book.Recommended
taker_feestringFees applied when liquidity is removed from the order book.Recommended
unified_cryptoasset_idstringUnique ID of cryptocurrency assigned byMandatory

Public Interface - Get Spot all ticker configuration information

Request parameters: no

Return field description:

NameTypeDescriptionstatus
base_idstringThe quote pair [Unified Cryptoasset ID].Mandatory
quote_idstringThe base pair [Unified Cryptoasset ID]Mandatory
last_pricestringLast transacted price of base currency based on given quote currencyMandatory
base_volumestring24-hour trading volume denoted in BASE currencyMandatory
quote_volumestring24 hour trading volume denoted in QUOTE currencyMandatory
isFrozenstringIndicates if the market is currently enabled (0) or disabled (1).Mandatory

Public Interface - Get Spot order book for a given market pair information

Request parameters:

NameTypeDescripitonStatus
market_pairstringA pair such as “BTC_USDT”Mandatory

Return field description:

NameTypeDescriptionstatus
timestampstringUnix timestamp in milliseconds for when the last updated time occurred.Mandatory
bidsstringAn array containing 2 elements. The offer price and quantity for each bid order.Mandatory
asksstringAn array containing 2 elements. The ask price and quantity for each ask order.Mandatory

Public Interface - Get Spot trades for a given market pair information

Request parameters:

NameTypeDescripitonStatus
market_pairstringA pair such as “BTC_USDT”Mandatory

Return field description:

NameTypeDescriptionstatus
trade_idstringA unique ID associated with the trade for the currency pair transaction. Note: Unix timestamp does not qualify as trade_id.Mandatory
pricestringLast transacted price of base currency based on given quote currencyMandatory
base_volumestringTransaction amount in BASE currency.Mandatory
quote_volumestringTransaction amount in QUOTE currency.Mandatory
timestampstringUnix timestamp in milliseconds for when the transaction occurred.Mandatory
typestringUsed to determine whether or not the transaction originated as a buy or sell.Mandatory

Public Interface - Get Spot candles Data Information

Request parameters:

NameTypeStatusDescription
symbolstringMandatoryThe name of the currency pair, such as BTC_USDT
periodstringMandatorytime period, values are as follows ["1", "3", "5", "15", "30", "60", "120", "240", "360", "720 "," D "," W "," M "], which correspond to [1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 12hour, 1day, 1week, 1month]
startstringRecommendedSpecify the start time of the kline line, timestamp accurate to the second
endstringRecommendedSpecify kline line end time, timestamp accurate to seconds

 

Public Interface - Get Usdt Swap all contracts configuration information

Request parameters: no

Return field description:

NameTypeDescriptionstatus
namestringcontract nameMandatory
ticker_idstringcontract nameMandatory
multiplierstringcontact multiplierMandatory
min_amountstringminimum quantityMandatory
max_amountstringmaximum quantityMandatory
min_price_changestringminimum price changeMandatory
price_precisionstringpsrice precisionMandatory
contract_pricestringcontract multiplierMandatory
contract_price_currencystringlast priceMandatory
contract_typestringcontract typeMandatory

 

Public Interface - Get Usdt Swap order book for a given market pair information

Request parameters:

NameTypeDescripitonStatus
ticker_idstringA pair such as “ETH-SWAP”Mandatory

Return field description:

NameTypeDescriptionstatus
timestampstringUnix timestamp in milliseconds for when the last updated time occurred.Mandatory
bidsstringAn array containing 2 elements. The offer price and quantity for each bid order.Mandatory
asksstringAn array containing 2 elements. The ask price and quantity for each ask order.Mandatory

 

Public Interface - Get Usdt Swap single ticker information

Request parameters:

NameTypeDescripitonStatus
ticker_idstringA pair such as “BTC-SWAP”Mandatory

Return field description:

NameTypeDescriptionstatus
ticker_idstringcontract nameMandatory
last_pricestringlast priceMandatory
mark_pricestringmark priceMandatory
ask_pricestringask best priceMandatory
bid_pricestringbid best priceMandatory
high24hstring24h high priceMandatory
low24hstring24h low priceMandatory
base_volumestringbase volumeMandatory
quote_volumestringquote volumeMandatory
chg24hstring24h price changeMandatory
chg0hstring0h price changeMandatory
funding_ratestringfunding rateMandatory
open_intereststringopen interestMandatory
maker_feestringmaker feeMandatory
taker_feestringtaker feeMandatory

 

Public Interface - Get Btc Swap all contracts configuration information

Request parameters: no

Return field description:

NameTypeDescriptionstatus
namestringcontract nameMandatory
ticker_idstringcontract nameMandatory
multiplierstringcontact multiplierMandatory
min_amountstringminimum quantityMandatory
max_amountstringmaximum quantityMandatory
min_price_changestringminimum price changeMandatory
price_precisionstringpsrice precisionMandatory
contract_pricestringcontract multiplierMandatory
contract_price_currencystringlast priceMandatory
contract_typestringcontract typeMandatory

 

Public Interface - Get Btc Swap order book for a given market pair information

Request parameters:

NameTypeDescripitonStatus
ticker_idstringA pair such as “BTCUSD”Mandatory

Return field description:

NameTypeDescriptionstatus
timestampstringUnix timestamp in milliseconds for when the last updated time occurred.Mandatory
bidsstringAn array containing 2 elements. The offer price and quantity for each bid order.Mandatory
asksstringAn array containing 2 elements. The ask price and quantity for each ask order.Mandatory

 

Public Interface - Get Btc Swap single ticker information

Request parameters:

NameTypeDescripitonStatus
ticker_idstringA pair such as “BTCUSD”Mandatory

Return field description:

NameTypeDescriptionstatus
ticker_idstringcontract nameMandatory
last_pricestringlast priceMandatory
mark_pricestringmark priceMandatory
ask_pricestringask best priceMandatory
bid_pricestringbid best priceMandatory
high24hstring24h high priceMandatory
low24hstring24h low priceMandatory
base_volumestringbase volumeMandatory
quote_volumestringquote volumeMandatory
chg24hstring24h price changeMandatory
chg0hstring0h price changeMandatory
funding_ratestringfunding rateMandatory
open_intereststringopen interestMandatory
maker_feestringmaker feeMandatory
taker_feestringtaker feeMandatory