Skip to main content

Public HTTP API V4

Public endpoints V4

Base URL is https://whitebit.com

Endpoint example: https://whitebit.com/api/v4/public/{endpoint}

All endpoints return time in Unix-time format.

All endpoints return either a JSON object or array.

For receiving responses from API calls please use http method GET

If an endpoint requires parameters you should send them as query string

Error messages V4 format:


{
"success": false,
"message": "ERROR MESSAGE",
"params": []
}

Terminology

Pair:

Stock - currency that you want to buy or sell

Money - currency that you are using to buy or sell something

Maker - person who puts an order and waiting till this order will be finished

Taker - person who finishes existing order

Precision - is the number of digits to the right of the decimal point

Bid - buy order

Ask - sell order


Market activity

[GET] /api/v4/public/ticker

This endpoint retrieves a 24-hour pricing and volume summary for each market pair available on the exchange.

Response is cached for: 1 second

Parameters: NONE

Response:

{
"BTC_USDT": {
"base_id": 1, // CoinmarketCap Id of base currency; 0 - if unknown
"quote_id": 825, // CoinmarketCap Id of quote currency; 0 - if unknown
"last_price": "9164.09", // Last price
"quote_volume": "43341942.90416876", // Volume in quote currency
"base_volume": "4723.286463", // Volume in base currency
"isFrozen": false, // Identifies if trades are closed
"change": "0.57" // Change in percent between open and last prices
},
{...}
}

Asset status list

[GET] /api/v4/public/assets

This endpoint retrieves the assets status.

Response is cached for: 1 second

Parameters: NONE

Response:

{
"BTC": {
"name": "Bitcoin", // Full name of cryptocurrency.
"unified_cryptoasset_id": 1, // Unique ID of cryptocurrency assigned by Unified Cryptoasset ID, 0 if unknown
"can_withdraw": true, // Identifies whether withdrawals are enabled or disabled.
"can_deposit": true, // Identifies whether deposits are enabled or disabled.
"min_withdraw": "0.001", // Identifies the single minimum withdrawal amount of a cryptocurrency.
"max_withdraw": "2", // Identifies the single maximum withdrawal amount of a cryptocurrency.
"maker_fee": "0.1", // Maker fee in percentage
"taker_fee": "0.1", // Taker fee in percentage
"min_deposit": "0.0001", // Min deposit amount
"max_deposit": "0", // Max deposit amount, will not be returned if there is no limit, 0 if unlimited
},
"ETH": {
"name": "Ethereum",
"unified_cryptoasset_id": 1027,
"can_withdraw": true,
"can_deposit": true,
"min_withdraw": "0.02",
"max_withdraw": "0",
"maker_fee": "0.1",
"taker_fee": "0.1",
"min_deposit": "0.1",
"max_deposit": "0"
},
"USDT": {
"name": "Tether US",
"unified_cryptoasset_id": 825,
"can_withdraw": true,
"can_deposit": true,
"min_withdraw": "5",
"max_withdraw": "0",
"maker_fee": "0.1",
"taker_fee": "0.1",
"min_deposit": "0",
"max_deposit": "0",
"networks": { // This object will be available in response if the currency is available on several networks
"deposits": [ // Networks available for depositing
"ERC20",
"TRC20",
"OMNI",
"BEP20"
],
"withdraws": [ // Networks available for withdrawing
"ERC20",
"TRC20",
"OMNI",
"BEP20"
],
"default": "ERC20" // Default network for depositing / withdrawing
},
"limits": { // This object will be returned when currency has several networks/providers
"deposit": { // Deposits limits
"ERC20": { // Network/provider
"min": "5", // Min deposit amount
"max": "1000" // Max deposit amount
},
"TRC20": {
"min": "5" // If there is no max limit, it is not returned
},
...
},
"withdraw": { // Withdraws limits
"ERC20": { // Network/provider
"min": "10", // Min withdraw amount
"max": "1000" // Max withdraw amount
},
"TRC20": {
"min": "10" // If there is no max limit, it is not returned
},
...
}
}
},
{...}
}

Orderbook

[GET] /api/v4/public/orderbook/{market}?limit=100&level=2

This endpoint retrieves the current order book as two arrays (bids / asks) with additional parameters.

Response is cached for: 1 second

Parameters:

NameTypeMandatoryDescription
limitintNoOrders depth quantity:[0,5,10,20,50,100,500]. Not defined or 0 will return full order book
levelintNoOptional parameter that allows API user to see different level of aggregation. Level 0 – default level, no aggregation. Starting from level 1 (lowest possible aggregation) and up to level 5 - different levels of aggregated orderbook.

Response:

{
"timestamp": 1594391413, // Current timestamp
"asks": [ // Array of ask orders
[
"9184.41", // Price of lowest ask
"0.773162" // Amount of lowest ask
],
[ ... ]
],
"bids": [ // Array of bid orders
[
"9181.19", // Price of highest bid
"0.010873" // Amount of highest bid
],
[ ... ]
]
}

Recent Trades

[GET] /api/v4/public/trades/{market}?type=sell

This endpoint retrieves the trades that have been executed recently on the requested market.

Response is cached for: 1 second

Parameters:

NameTypeMandatoryDescription
typeStringNoCan be buy or sell

Response:

[
{
"tradeID": 158056419, // A unique ID associated with the trade for the currency pair transaction Note: Unix timestamp does not qualify as trade_id.
"price": "9186.13", // Transaction price in quote pair volume.
"quote_volume": "0.0021", // Transaction amount in quote pair volume.
"base_volume": "9186.13", // Transaction amount in base pair volume.
"trade_timestamp": 1594391747, // Unix timestamp in milliseconds, identifies when the transaction occurred.
"type": "sell" // Used to determine whether or not the transaction originated as a buy or sell. Buy – Identifies an ask that was removed from the order book. Sell – Identifies a bid that was removed from the order book.
},
{
"tradeID": 158056416,
"price": "9186.13",
"base_volume": "9186.13",
"quote_volume": "0.002751",
"trade_timestamp": 1594391746,
"type": "sell"
},
{...}
}

Fee

[GET] /api/v4/public/fee

This endpoint retrieves the list of fees and min/max amount for deposits and withdraws


Response:

{
"USDT (ERC20)": {
"ticker": "USDT", // currency ticker
"name": "Tether US", // currency ticker
"providers": [],
"deposit": { // deposit fees
"min_amount": "0.0005", // min deposit amount. 0 if there is no limitation
"max_amount": "0.1", // max deposit amount. 0 if there is no limitation
"fixed": "0.0005", // fixed fee amount which applies for all transaction
"flex": {
"min_fee": "100", // min fee amount
"max_fee": "1000", // max fee amount
"percent": "10"
}, // flex fee only applies for all transactions but according to min/max fee. Nullable if there is no flex fee
},
"withdraw": {
"min_amount": "0.001",
"max_amount": "0",
"fixed": null,
"flex": null
},
"is_depositable": true, //true if currency can be deposit
"is_withdrawal": true //true if currency can be withdraw
},
"USD": {
"ticker": "USD", // currency ticker
"name": "United States Dollar", // currency ticker
"providers": [
"USD_ADVCASH",
"USD_CAPITALIST",
"USD_EPAY_COM",
"USD_PERFECT_MONEY",
"USD_VISAMASTER_INTERKASSA"
], // the list of providers. It is uses for fiat currencies. Provider is a payment system with own fees, which process payment operation
"deposit": { // for currencies with payment providers fee and amounts shows for each provider directly
"USD_VISAMASTER_INTERKASSA": {
"min_amount": "10",
"max_amount": "1500",
"fixed": null,
"flex": null,
"is_depositable": false,
"name": "USD Visa/MasterCard Interkassa", // provider name
"ticker": "USD_VISAMASTER_INTERKASSA" //provider ticker
}
},
"withdraw": {
"USD_VISAMASTER_INTERKASSA": {
"min_amount": "20",
"max_amount": "1500",
"fixed": null,
"flex": null,
"is_withdrawal": false,
"name": "USD Visa/MasterCard Interkassa",
"ticker": "USD_VISAMASTER_INTERKASSA"
}
}
},
}

Server Time

[GET] /api/v4/public/time

This endpoint retrieves the current server time.

Response is cached for: 1 second

Response:

{
"time": 1631451591
}

Server Status

[GET] /api/v4/public/ping

This endpoint retrieves the current API life-state.

Response is cached for: 1 second

Response:

[
"pong"
]

Collateral Markets List

[GET] /api/v4/public/collateral/markets

This endpoint returns the list of markets that available for collateral trading

Response:

[
"ADA_USDT",
"BCH_USDT",
"BTC_USDT",
"DOGE_USDT",
"EOS_USDT",
"ETH_BTC",
"ETH_USDT",
"LINK_USDT",
"LTC_USDT",
"SHIB_USDT",
"SOL_USDT",
"TRX_USDT",
"USDC_USDT",
"XLM_USDT",
"XRP_USDT"
]