Skip to content

REST_API_Reference

Jump to bottom
BiboxEurope edited this page Apr 20, 2020 · 6 revisions

Important: For full request format, please refer to API Request and Response Format, the following API interface description is not full.

Table of Contents

Spot trading

Market Quotation(apikey is not necessary)

Network testing

Request parameter

Name Necessary or not Type Description Default Value Range

POST request method: ping

The description of return result

{
    "result": {}, //Test succeed
    "cmd":"ping"
}

Example

// Request
{
    "cmd": "ping"
    "body": {}
}

// Response
{
    "result": {},
    "cmd":"ping"
}

View trading pair

Request parameter

Name Necessary or not Type Description Default Value Range

POST request method: api/pairList

The description of return result

{
    "result":[
        {
            "id":1,// pair id
            "pair":"ETH_BTC" // pair symbol
        },
        {
            "id":2,
            "pair":"ETH_BTC"
        }
    ],
    "cmd":"api/pairList"
}

Example

// Request
{
    "cmd": "api/pairList"
    "body": {}
}

// Response
{
    "result":[
        {"id":1,"pair":"ETH_BTC"},
        {"id":2,"pair":"BTC_EUR"}
    ],
    "cmd":"api/pairList"
}

View K line

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...
period true string K line period '1min', '3min', '5min', '15min', '30min', '1hour', '2hour', '4hour', '6hour', '12hour', 'day', 'week'
size false integer how many 1000 1-1000

POST request method: api/kline

The description of return result

{
    "result":[
        {
            "time":1512660420000, // Timestamp
            "open":"0.00586568",  // Opening Price
            "high":"0.00586568",  // The highest price
            "low":"0.00586568",   // The lowest price
            "close":"0.00586568", // Closing Price
            "vol":"0"             // Trading Volume
        },
        {
            "time":1512660480000,
            "open":"0.00586568",
            "high":"0.00586568",
            "low":"0.00586568",
            "close":"0.00586568",
            "vol":"10"
        }
    ],
    "cmd":"api/kline"
}

Example

// Request
{
    "cmd": "api/kline"
    "body": {
        "pair": "ETH_BTC",
        "period": "1min",
        "size": 10
    }
}

// Response
{
    "result":[
        {
            "time":1512660420000,
            "open":"0.00586568",
            "high":"0.00586568",
            "low":"0.00586568",
            "close":"0.00586568",
            "vol":"0"
        },
        {
            "time":1512660480000,
            "open":"0.00586568",
            "high":"0.00586568",
            "low":"0.00586568",
            "close":"0.00586568",
            "vol":"10"
        }
    ],
    "cmd":"api/kline"
}

View the market quotation of all tokens

Request parameter

Name Necessary or not Type Description Default Value Range

POST request method: api/marketAll

The description of return result

{
    "result":{
        "id":4,
        "coin_symbol":"ETH",            //Trading Token
        "currency_symbol":"BTC",        //Pricing Token
        "last":"0.00002704",            //24h the lastest price
        "high":"0.00003480",            //24h the highest price
        "low":"0.00001951",             //24h the lowest price
        "change":"+0.00000715",         //24h price change
        "percent":"+35.95%",            //24h price change percentage
        "vol24H":"641954",              //24h Trading Volume
        "amount":"16.55",               //24h Trading Amount
        "last_cny":"1.84",              //The lastest price equivelant to CNY
        "high_cny":"2.37",
        "low_cny":"1.33",
        "last_usd":"0.27",              //The lastest price equivalent to USD
        "high_usd":"0.35",
        "low_usd":"0.19"
    },
    "cmd":"api/marketAll"
}

Example

// Request
{
    "cmd": "api/marketAll"
    "body": {}
}

// Response
{
    "result":[
        {
            "id":4,
            "coin_symbol":"ETH",
            "currency_symbol":"BTC",
            "last":"0.00002704",
            "high":"0.00003480",
            "low":"0.00001951",
            "change":"+0.00000715",
            "percent":"+35.95%",
            "vol24H":"641954",
            "amount":"16.55",
            "last_cny":"1.84",
            "high_cny":"2.37",
            "low_cny":"1.33",
            "last_usd":"0.27",
            "high_usd":"0.35",
            "low_usd":"0.19"
        },
        {
            "id":5,
            "coin_symbol":"ETH",
            "currency_symbol":"BTC",
            "last":"0.04341296",
            "high":"0.04884176",
            "low":"0.04321405",
            "change":"-0.00047878",
            "percent":"-1.09%",
            "vol24H":"86",
            "amount":"3.77",
            "last_cny":"2950.87",
            "high_cny":"3319.88",
            "low_cny":"2937.35",
            "last_usd":"432.60",
            "high_usd":"486.70",
            "low_usd":"430.62"
        }
    ],
    "cmd":"api/marketAll"
}

View market quotation of a single token

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...

POST request method: api/market

The description of return result

{
    "result":{
        "id":4,
        "coin_symbol":"ETH",            //Trading Token
        "currency_symbol":"BTC",        //Pricing Token
        "last":"0.00002704",            //24h the lastest price
        "high":"0.00003480",            //24h the highest price
        "low":"0.00001951",             //24h the lowest price
        "change":"+0.00000715",         //24h price change
        "percent":"+35.95%",            //24h price change percentage
        "vol24H":"641954",              //24h Trading Volume
        "amount":"16.55",               //24h Trading Amount
        "last_cny":"1.84",              //The lastest price equivelant to CNY
        "high_cny":"2.37",
        "low_cny":"1.33",
        "last_usd":"0.27",              //The lastest price equivalent to USD
        "high_usd":"0.35",
        "low_usd":"0.19"
    },
    "cmd":"api/market"
}

Example

// Request
{
    "cmd": "api/market"
    "body": {
        "pair": "ETH_BTC"
    }
}

// Response
{
    "result":[
        {
            "id":4,
            "coin_symbol":"ETH",
            "currency_symbol":"BTC",
            "last":"0.00002704",
            "high":"0.00003480",
            "low":"0.00001951",
            "change":"+0.00000715",
            "percent":"+35.95%",
            "vol24H":"641954",
            "amount":"16.55",
            "last_cny":"1.84",
            "high_cny":"2.37",
            "low_cny":"1.33",
            "last_usd":"0.27",
            "high_usd":"0.35",
            "low_usd":"0.19"
        }
    ],
    "cmd":"api/market"
}

View the depth of the market

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...
size false integer how many 200 1-200

POST request method: api/depth

The description of return result

{
    "result":{
        "pair":"ETH_BTC",
        "update_time":1510983122681,
        "asks":[                            //The depth of sellers
            {
                "price":"0.008654",         //The price of pending order
                "volume":"200.9123"         //The price of pending orders
            }
        ],
        "bids":[                            //The depth of buyers
            {
                "price":"0.008596",         //The price of pending order
                "volume":"18.54306495"      //The price of pending orders
            },
            {
                "price":"0.00859289",
                "volume":"40.13567123"
            }
        ]
    },
    "cmd":"api/depth"
}

Example

// Request
{
    "cmd": "api/depth"
    "body": {
        "pair": "ETH_BTC"
    }
}

// Response
{
    "result":{
        "pair":"ETH_BTC",
        "update_time":1510983122681,
        "asks":[                            //The depth of sellers
            {
                "price":"0.008654",         //The price of pending orders
                "volume":"200.9123"         //The volume of pending orders
            }
        ],
        "bids":[                            //The depth of buyers
            {
                "price":"0.008596",         //The price of pending orders
                "volume":"18.54306495"      //The volume of pending orders
            },
            {
                "price":"0.00859289",
                "volume":"40.13567123"
            }
        ]
    },
    "cmd":"api/depth"
}

View trading record history

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...
size false integer how many 200 1-200

POST request method: api/deals

The description of return result

{
    "result":[
        {
            "pair":"ETH_BTC",
            "price":"0.008601",                 //Trading price
            "amount":"24.12584739",             //Trading amount
            "time":"1512721748000",             //Trading time
            "side":2                            //Taker trading side 1-Buy, 2-Sell
        },
        {
            "pair":"ETH_BTC",
            "price":"0.008611",                 //Trading price
            "amount":"24.23584739",             //Trading amount
            "time":"1512721748000",             //Trading time
            "side":2                            //Taker trading side 1-Buy, 2-Sell
        }
    ],
    "cmd":"api/deals"
}

Example

// Request
{
    "cmd": "api/deals"
    "body": {
        "pair": "ETH_BTC"
    }
}

// Response
{
    "result":[
        {
            "pair":"ETH_BTC",
            "price":"0.008601",                 //Trading price
            "amount":"24.12584739",             //Trading amount
            "time":"1512721748000",             //Trading time
            "side":2                            //Taker trading side 1-Buy, 2-Sell
        },
        {
            "pair":"ETH_BTC",
            "price":"0.008611",                 //Trading price
            "amount":"24.23584739",             //Trading amount
            "time":"1512721748000",             //Trading time
            "side":2                            //Taker trading side 1-Buy, 2-Sell
        }
    ],
    "cmd":"api/deals"
}

View the market ticker

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...

POST request method: api/ticker

The description of return result

{
    "result":{
        "pair":"ETH_BTC",           //Trading pair
        "buy":"0.00582132",         //The highest bid price
        "buy_amount":"1",           //The highest bid amount
        "high":"0.00778847",        //24h The highest price
        "last":"0.00582156",        //The lastest trading price
        "low":"0.00540611",         //24h The lowest price
        "sell":"0.00582152",        //The lowest ask price
        "sell_amount":"1",           //The lowest ask amount
        "timestamp":1510983122665,  //Timestamp
        "vol":"70.50811953"         //24h trading volume
        "percent":"+10.02%"         //24h price change percentage
        "last_cny":"621.53",        //The lastest trading price，equivalent to CNY
        "last_usd":"93.93"          //The lastest trading price，equivalent to USD
    },
    "cmd":"api/ticker"
}

Example

// Request
{
    "cmd": "api/ticker"
    "body": {
        "pair": "ETH_BTC"
    }
}

// Response
{
    "result":{
        "pair":"ETH_BTC",           //Trading pair
        "buy":"0.00582132",         //The highest bid price
        "buy_amount":"1",           //The highest bid amount
        "high":"0.00778847",        //24h The highest price
        "last":"0.00582156",        //The lastest trading price
        "low":"0.00540611",         //24h The lowest price
        "sell":"0.00582152",        //The lowest ask price
        "sell_amount":"1",           //The lowest ask amount
        "timestamp":1510983122665,  //Timestamp
        "vol":"70.50811953"         //24h trading volume
        "percent":"+10.02%"         //24h price change percentage
        "last_cny":"621.53",        //The lastest trading price，equivalent to CNY
        "last_usd":"93.93"          //The lastest trading price，equivalent to USD
    },
    "cmd":"api/ticker"
}

The trade parameter specification

The description

{
    "result": {
        "min_trade_price": {  //Minimum price of trading
            "default": "0.01", //The minimum price of regular trading pairs are 0.01
            "ETH_BTC": "0.00000001",//The minimum price of ETH_BTC trading pairs are 0.00000001, and the digits after the 8th decimal will be truncated. 
            "ONT_CHF": "0.001",//The minimum price of ONF_CHF trading pairs are 0.001, and the digits after the 3rd decimal will be truncated. 
            "ONT_EUR": "0.001",//The minimum price of ONT_EUR trading pairs are 0.001, and the digits after the 3rd decimal will be truncated. 
            "XRP_EUR": "0.0001",//The minimum price of XRP_EUR trading pairs are 0.0001, and the digits after the 4th decimal will be truncated. 
            "XRP_CHF": "0.0001",//The minimum price of XRP_CHF trading pairs are 0.0001, and the digits after the 4th decimal will be truncated. 
            "XRP_GBP": "0.0001",//The minimum price of XRP_GBP trading pairs are 0.0001, and the digits after the 4th decimal will be truncated. 
            "other": "0.01"//The minimum price of other currencies are 0.01, and the digits after the 2nd decimal will be truncated.
        },
        "min_trade_amount": {//Minimum amount of trading
            "default": "0.0001",//The minimum amount of trading is 0.0001, the digits after the 4th decimal will be truncated, and this applies to all the trading pairs.

        },
        "min_trade_money": {//the minimum money (money = price * amount)
            "BTC": "0.0002",//the minimum money applies to the PAIRs of BTC-denominated
            "EUR": "5",//the minimum money applies to the PAIRs of EUR-denominated
            "CHF": "5",//the minimum money applies to the PAIRs of CHF-denominated
            "GBP": "5",//the minimum money applies to the PAIRs of GBP-denominated
        }
    },
    "cmd": "tradeLimit"
}

Users Asset Information (needs apikey)

Spot account asset

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
select false integer View or not the asset details 0-The total assets of all tokens, 1-the asset details of all tokens

POST request method: transfer/assets

The description of return result

{
    "result":{
        "total_btc":"107.71371658",             //The total assets of all tokens, equivalent to BTC
        "total_cny":"5587362.53",               //The total assets of all tokens, equivalent to CNY
        "total_usd":"4000.30",                  //The total assets of all tokens, equivalent to USD
        "assets_list":[                         //The asset details of tokens
            {
                "coin_symbol":"BTC",
                "balance":"102.31666784",       //Available
                "freeze":"0.01800000",          //Freeze
                "BTCValue":"1100.35043000",     //equivalent to BTC
                "CNYValue":"59448654.69",       //equivalent to CNY
                "USDValue":"8945419.86",        //equivalent to USD
            },
            {
                "coin_symbol":"ETH",
                "balance":"100.00000000",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69",
                "USDValue":"8945419.86", 
            },
            {
                "coin_symbol":"ETH",
                "balance":"125.34853787",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69",  
                "USDValue":"8945419.86", 
            },
            {
                "coin_symbol":"ETH",
                "balance":"712.79411732",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69",
                "USDValue":"8945419.86",
            }
        ]
    },
    "cmd":"transfer/assets"
}

Example

// Request
{
    "cmd": "transfer/assets"
    "body": {
        "select": 1
    }
}

// Response
{
    "result":{
        "total_btc":"107.71371658",
        "total_cny":"5587362.53",
        "total_usd":"4000.30",
        "assets_list":[
            {
                "coin_symbol":"BTC",
                "balance":"102.31666784",
                "freeze":"0.01800000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69", 
                "USDValue":"8945419.86",
            },
            {
                "coin_symbol":"ETH",
                "balance":"100.00000000",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69",
                "USDValue":"8945419.86",
            },
            {
                "coin_symbol":"ETH",
                "balance":"125.34853787",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69",
                "USDValue":"8945419.86",
            },
            {
                "coin_symbol":"ETH",
                "balance":"712.79411732",
                "freeze":"0.00000000",
                "BTCValue":"1100.35043000",
                "CNYValue":"59448654.69", 
                "USDValue":"8945419.86",
            }
        ]
    },
    "cmd":"transfer/assets"
}

Deposit

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
coin_symbol true string deposit Token ETH, ONT, ...

POST request method: transfer/transferIn

The description of return result

{
    "result":"xxxxxxxxxxxxxxxxx", // deposit address
    "cmd":"transfer/transferIn"
}

Example

// Request
{
    "cmd": "transfer/transferIn"
    "body":{
        "coin_symbol":"ETH"
    }
}

// Response
{
    "result":"xxxxxxxxxxxxxxxxx", // deposit address
    "cmd":"transfer/transferIn"
}

Withdraw

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
coin_symbol true string withdraw Token ETH, BTC, ...
amount true double withdraw amount
totp_code false integer google code New address required,Old address ignored
trade_pwd false string trade password New address required,Old address ignored
addr true string withdraw address
addr_remark true string the remark of withdraw address
memo false string withdraw tag memo is required for some tokens, such as ONT

POST request method: transfer/transferOut

The description of return result

{
    "result":228   //withdrawal id
    "cmd":"transfer/transferOut"
}

Example

// Request
{
    "cmd": "transfer/transferOut"
    "body":{
        "coin_symbol":"ETH",
        "amount":1,
        "totp_code":703634,
        "trade_pwd":"12345678",
        "addr":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "addr_remark":"BiboxEurope-1",
        "memo":"",
    }
}

// Response
{
    "result":228   // withdrawal id
    "cmd":"transfer/transferOut"
}

Deposit history list

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
filter_type false integer filter type 0 0-all，1-deposit is in process，2-deposit finished，3-deposit failed
coin_symbol false string deposit token ETH, BTC, ...
page true integer The page number from the page 1
size true integer the amount in one page 1-50

POST request method: transfer/transferInList

The description of return result

{
    "result":{
        "count":2,
        "page":1,
        "items":[
            {
                "coin_symbol":"ETH",                        // token
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",  // address
                "amount":"1.00000000",                      // amount
                "confirmCount":"15",                        // the acknowledgment number
                "createdAt":1540641511000,
                "status":2                                 // status,  1-deposit is in process，2-deposit finished，3-deposit failed
            },
            {
                "coin_symbol":"ETH",
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
                "amount":"1.00000000",
                "confirmCount":"15",
                "createdAt":1540622460000,
                "status":2
            }
        ]
    },
    "cmd":"transfer/transferInList"
}

Example

// Request
{
    "cmd": "transfer/transferInList"
    "body": {
        "filter_type": 0,
        "page": 1,
        "size": 10,
    }
}

// Response
{
    "result":{
        "count":2,
        "page":1,
        "items":[
            {
                "coin_symbol":"ETH",
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
                "amount":"1.00000000", 
                "confirmCount":"15", 
                "createdAt":1540641511000,
                "status":2                 
            },
            {
                "coin_symbol":"ETH",
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
                "amount":"1.00000000",
                "confirmCount":"15",
                "createdAt":1540622460000,
                "status":2
            }
        ]
    },
    "cmd":"transfer/transferInList"
}

Withdraw history list

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
filter_type false integer filter type -2: The review fails; -1: user canceled; 0: to be reviewed; 1: The review passes (token to be listed); 2: token listing; 3: token listing completed
coin_symbol false string deposit token ETH, BTC, ...
page true integer The page number from the page 1
size true integer the amount in one page 1-50

POST request method: transfer/transferOutList

The description of return result

{
    "result":{
        "count":2,
        "page":1,
        "items":[
            {
                "coin_symbol":"ETH",                        // token
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",  // address
                "amount":"1.00000000",                      // amount
                "fee":"0.00000000",                         // withdraw fee
                "createdAt":1540641511000,
                "memo":"",
                "status":-2                                 // Status, -2: The review fails; -1: user canceled; 0: to be reviewed; 1: The review passes (token to be listed); 2: token listing; 3: token listing completed
            },
            {
                "coin_symbol":"ETH",
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
                "amount":"1.00000000",
                "fee":"0.00000000",
                "createdAt":1540622460000,
                "memo":"",
                "status":3
            }
        ]
    },
    "cmd":"transfer/transferOutList"
}

Example

// Request
{
    "cmd": "transfer/transferOutList"
    "body": {
        "page": 1,
        "size": 10,
    }
}

// Response
{
    "result":{
        "count":2,
        "page":1,
        "items":[
            {
                "coin_symbol":"ETH",  
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx", 
                "amount":"1.00000000",
                "fee":"0.00000000",    
                "createdAt":1540641511000,
                "memo":"",
                "status":-2
            },
            {
                "coin_symbol":"ETH",
                "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
                "amount":"1.00000000",
                "fee":"0.00000000",
                "createdAt":1540622460000,
                "memo":"",
                "status":3
            }
        ]
    },
    "cmd":"transfer/transferOutList"
}

Withdrawal information

POST https://api.bibox.cc/v1/transfer

Request parameter

Name Necessary or not Type Description Default Value Range
id true integer withdrawal id

POST request method: transfer/withdrawInfo

The description of return result

{
    "result":{
      	"id":228,
        "createdAt": 1512756997000,
        "coin_symbol":"ETH",                        //
        "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",  // withdrawal address
        "status":3,                                 // Status, -2: The review fails; -1: user canceled; 0: to be reviewed; 1: The review passes (token to be listed); 2: token listing; 3: token listing completed
        "amount":"1.00000000",                      // amount
        "fee":0.1                                   // fee
    },
    "cmd":"transfer/withdrawInfo"
}

Example

// Request
{
    "cmd": "transfer/withdrawInfo"
    "body": {
        "id": 228
    }
}

// Response
{
    "result":{
      	"id":228,
        "createdAt": 1512756997000,
        "coin_symbol":"ETH",
        "to_address":"xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "status":3,
        "amount":"1.00000000",
        "fee":0.1
    },
    "cmd":"transfer/withdrawInfo"
}

Transaction(Needs apikey)

place an order

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
pair true string Trading pair ETH_BTC, BTC_EUR, ...
account_type true integer Account type 0-spot account
order_type true integer Trading type 2-limit order
order_side true integer Trading side 1-Buy，2-Sell
price true double order price minimum value 0.00000001
amount true double order amount minimum value 0.0001

POST request method: orderpending/trade

The description of return result

{
    "result": "100055558128036",     //order id
    "index": 12345,   //user defined random index
    "cmd":"orderpending/trade"
}

Example

// Request
{
    "cmd": "orderpending/trade",
    "index": 12345,                  //random index, specific one in a batch
    "body": {
        "pair": "ETH_BTC",           
        "account_type": 0, 
        "order_type": 2, 
        "order_side": 1,
        "price": 0.00032, 
        "amount": 1000 
    }
}

// Response
{
    "result": "100055558128036",     //order id
    "index": 12345,   //random index, specific one in a batch
    "cmd":"orderpending/trade"
}

cancel an order

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
orders_id true string order id

POST request method: orderpending/cancelTrade

The description of return result

{
    "result":"OK",    //Note: This result only indicates that the server received the cancelling request, and the cancelling result can query the order record
    "index": 12345,   //random index, specific one in a batch
    "cmd":"orderpending/cancelTrade"
}

Example

// Request
{
    "cmd": "orderpending/cancelTrade",
    "index": 12345,
    "body": {
        "orders_id": "8588285380268971"
    }
}

// Response
{
    "result":"OK",
    "index": 12345,
    "cmd":"orderpending/cancelTrade"
}

The current order list

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
pair false string Trading pair ETH_BTC, BTC_EUR, ...
account_type true integer Account type 0-spot account
order_side false integer Trading side 1-Buy，2-Sell
coin_symbol false string Trading Token ETH, ONT, ...
currency_symbol false string Pricing Token BTC, EUR, ...
page true integer The page number from the page 1
size true integer the amount in one page 1-50

POST request method: orderpending/orderPendingList

The description of return result

{
    "result":{
        "count":1,
        "page":1,
        "items":[
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0,  
                "coin_symbol":"ETH",                    //Trading Token
                "currency_symbol":"BTC",                //Pricing Token
                "order_side":2,                         //Trading side 1-Buy, 2-Sell
                "order_type":2,                         //2-limit order
                "price":"0.00900000",                   //order price
                "amount":"1.00000000",                  //order amount
                "money":"0.00900000",                   //currency amount (price * amount)
                "deal_amount":"0.00000000",             //deal amount
                "deal_percent":"0.00%",                 //deal percentage
                "unexecuted":"0.00000000",              //unexecuted amount
                "status":1                              //Status,-1-fail, 0,1-to be dealt, 2-dealt partly, 3-dealt totally, 4- cancelled partly, 5-cancelled totally, 6-to be cancelled
            }
        ]
    },
    "cmd":"orderpending/orderPendingList"
}

Example

// Request
{
    "cmd": "orderpending/orderPendingList",
    "body": {
        "account_type": 0,
        "order_side": 2,
        "page": 1,
        "size": 10,
        "coin_symbol": "ETH",
        "currency_symbol": "BTC"
    }
}

// Response
{
    "result":{
        "count":1,
        "page":1,
        "items":[
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0,
                "coin_symbol":"ETH", 
                "currency_symbol":"BTC",
                "order_side":2,
                "order_type":2, 
                "price":"0.00900000",
                "amount":"1.00000000",
                "money":"0.00900000",  
                "deal_amount":"0.00000000",
                "deal_percent":"0.00%",
                "unexecuted":"0.00000000", 
                "status":1 
            }
        ]
    },
    "cmd":"orderpending/orderPendingList"
}

The order history

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
pair false string Trading pair ETH_BTC, ETH_BTC, ...
account_type true integer Account type 0-spot account
order_side false integer Trading side 1-Buy，2-Sell
coin_symbol false string Trading Token ETH, ONT, ...
currency_symbol false string Pricing Token BTC, USDT, ...
page true integer The page number from the page 1
size true integer the amount in one page 1-50
hide_cancel false integer hide cancelled orders 0-not hide，1-hide

POST request method: orderpending/pendingHistoryList

The description of return result

{
    "result":{
        "count":1,
        "page":1,
        "items":[
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0,  
                "coin_symbol":"ETH",                    //Trading Token
                "currency_symbol":"BTC",                //Pricing Token
                "order_side":2,                         //Trading side 1-Buy, 2-Sell
                "order_type":2,                         //2-limit order
                "price":"0.00900000",                   //order price
                "amount":"1.00000000",                  //order amount
                "money":"0.00900000",                   //currency amount (price * amount)
                "deal_amount":"0.00000000",             //deal amount
                "deal_percent":"0.00%",                 //deal percentage
                "unexecuted":"0.00000000",              //unexecuted amount
                "status":3                              //Status,-1-fail, 0,1-to be dealt, 2-dealt partly, 3-dealt totally, 4- cancelled partly, 5-cancelled totally, 6-to be cancelled
            }
        ]
    },
    "cmd":"orderpending/pendingHistoryList"
}

Example

// Request
{
    "cmd": "orderpending/pendingHistoryList",
    "body": {
        "account_type": 0,
        "order_side": 2,
        "page": 1,
        "size": 10,
        "coin_symbol": "ETH",
        "currency_symbol": "BTC"
    }
}

// Response
{
    "result":{
        "count":1,
        "page":1,
        "items":[
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0, 
                "coin_symbol":"ETH",
                "currency_symbol":"BTC",
                "order_side":2,
                "order_type":2,
                "price":"0.00900000",
                "amount":"1.00000000",
                "money":"0.00900000",
                "deal_price":"0.00900000",
                "deal_amount":"1.00000000",
                "deal_money":"0.00900000",
                "deal_percent":"100%",
                "status":3
            }
        ]
    },
    "cmd":"orderpending/pendingHistoryList"
}

The order history detail

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
id true string order id
account_type true integer Account type 0-spot account

POST request method: orderpending/orderDetail

The description of return result

{
    "result":{
        "sum":"0.00588746",                   // sum of amount
        "orderList":[
            {
                "id":"2251799813844119243",   //deal id
                "createdAt":1561007144000,    //deal timestamp 
                "account_type":0,             //spot account
                "coin_symbol":"KAT",          //Trading Token
                "currency_symbol":"ETH",      //Pricing Token
                "order_side":2,               //Trading side 1-Buy, 2-Sell
                "order_type":2,               //2-limit order
                "price":"0.00001183",         //order price
                "amount":"497.6722",          //order amount
                "money":"0.00588746",         //currency amount (price * amount)
                "fee":"0.00000000",           //fee amount
                "pay_ETH":0,                  //pay ETH for fee
                "fee_symbol":"ETH",           //fee token symbol
                "relay_id":"11221615825364891" // order id
            }
        ]
    },
    "cmd":"orderpending/orderDetail"
}

Example

// Request
{
    "cmd": "orderpending/orderDetail",
    "body": {
        "id": "11221615825364891"      // order id
    }
}

// Response
{
    "result":{
        "sum":"0.00588746",                   // sum of amount
        "orderList":[
            {
                "id":"2251799813844119243",   //
                "createdAt":1561007144000,    //deal timestamp 
                "account_type":0,             //spot account
                "coin_symbol":"KAT",          //Trading Token
                "currency_symbol":"ETH",      //Pricing Token
                "order_side":2,               //Trading side 1-Buy, 2-Sell
                "order_type":2,               //2-limit order
                "price":"0.00001183",         //order price
                "amount":"497.6722",          //order amount
                "money":"0.00588746",         //currency amount (price * amount)
                "fee":"0.00000000",           //fee amount
                "pay_ETH":0,                  //pay ETH for fee
                "fee_symbol":"ETH",           //fee token symbol
                "relay_id":"11221615825364891" // order id
            }
        ]
    },
    "cmd":"orderpending/orderDetail"
}

The order

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
id true string order id
account_type true integer Account type 0-spot account

POST request method: orderpending/order

The description of return result

{
    "result":{
        "id":"100055558128036",
        "createdAt": 1512756997000,
        "account_type":0,  
        "coin_symbol":"ETH",                    //Trading Token
        "currency_symbol":"BTC",                //Pricing Token
        "order_side":2,                         //Trading side 1-Buy, 2-Sell
        "order_type":2,                         //2-limit order
        "price":"0.00900000",                   //order price
        "amount":"1.00000000",                  //order amount
        "money":"0.00900000",                   //currency amount (price * amount)
        "deal_amount":"0.00000000",             //deal amount
        "deal_percent":"0.00%",                 //deal percentage
        "unexecuted":"0.00000000",              //unexecuted amount
        "status":3                              //Status, -1-fail, 0,1-to be dealt, 2-dealt partly, 3-dealt totally, 4- cancelled partly, 5-cancelled totally, 6-to be cancelled
    },
    "cmd":"orderpending/order"
}

Example

// Request
{
    "cmd": "orderpending/order",
    "body": {
        "id": "100055558128036"
    }
}

// Response
{
    "result":{
        "id":"100055558128036",
         "createdAt": 1512756997000,
         "account_type":0,
         "pair":"ETH_BTC",
         "coin_symbol":"ETH",
         "currency_symbol":"BTC", 
         "order_side":2,
         "order_type":2,
         "price":"0.00900000",
         "amount":"1.00000000",
         "money":"0.00900000",
         "deal_amount":"0.00000000",
         "deal_percent":"0.00%",
         "unexecuted":"0.00000000",
         "status":1
    },
    "cmd":"orderpending/order"
}

The dealed order history

POST https://api.bibox.cc/v1/orderpending

Request parameter

Name Necessary or not Type Description Default Value Range
pair false string Trading pair ETH_BTC, ETH_BTC, ...
account_type true integer Account type 0-spot account
order_side false integer Trading side 1-Buy，2-Sell
coin_symbol false string Trading Token ETH, ONT, ...
currency_symbol false string Pricing Token BTC, USDT, ...
page true integer The page number from the page 1
size true integer the amount in one page 1-50

POST request method: orderpending/orderHistoryList

The description of return result

{
    "result":{
        "count":1,
        "page":1, 
        "items":[ 
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0,
                "coin_symbol":"ETH",
                "currency_symbol":"BTC",
                "order_side":2,
                "order_type":2, 
                "price":"0.00886500", 
                "amount":"1.00000000",
                "money":"0.00886500",
                "fee":0 
            }
        ]
    },
    "cmd":"orderpending/orderHistoryList"
}

Example

// Request
{
    "cmd": "orderpending/orderHistoryList",
    "body": {
        "account_type": 0,
        "order_side": 2,
        "page": 1,
        "size": 10,
        "coin_symbol": "ETH",
        "currency_symbol": "BTC"
    }
}

// Response
{
    "result":{
        "count":1,
        "page":1,
        "items":[ 
            {
                "id":"100055558128036",
                "createdAt": 1512756997000,
                "account_type":0,
                "coin_symbol":"ETH",
                "currency_symbol":"BTC", 
                "order_side":2, 
                "order_type":2,
                "price":"0.00886500", 
                "amount":"1.00000000",
                "money":"0.00886500",
                "fee":0
            }
        ]
    },
    "cmd":"orderpending/orderHistoryList"
}

Home

BiboxEurope Exchange provides REST API and WebSocket API, which are convenient for investors to view the market and trade easily.

BiboxEurope Exchange

https://www.bibox.cc

REST API

WebSocket API

Clone this wiki locally