Skip to content

WS_API_Reference_C

Jump to bottom
Biboxcom edited this page Nov 8, 2019 · 3 revisions

目录

WebSocket API Reference

订阅 Kline 数据 bibox_sub_spot_$pair_kline_$period

参考现货API Reference

合约的pair参数： BTCUSDT永续 = 4BTC_USDT、ETHUSDT永续 = 4ETH_USDT、以此类推

data 说明

  "data": {
    "time": k线某周期开始时间,
    "count": 成交笔数,
    "open": 开盘价,
    "high": 最高价,
    "low": 最低价,
    "close": 收盘价
    "vol": 成交量(合约张数)
  }

订阅 Market 数据 bibox_sub_spot_ALL_ALL_market

参考现货API Reference

data 说明

 {
     "id": 交易对id
     "coin_symbol": 交易币种 如：4BTC、4ETH...
     "currency_symbol": 定价币种
     "last": 24h最新价
     "high": 24h最高价
     "low": 24h最低价
     "change": 24h涨跌
     "percent": 24h涨跌幅
     "vol24H": 24h成交量(张数)
     "amount": 24h成交额(USDT)
     "last_cny": 最新价折算cny
     "high_cny": 最高价折算cny
     "low_cny": 最低价折算cny
     "last_usd": 最新价折算usd
     "high_usd": 最高价折算usd
     "low_usd": 最低价折算usd
 }

请求 Depth 数据 bibox_sub_spot_$pair_depth

参考现货API Reference

合约的pair参数： BTCUSDT永续 = 4BTC_USDT、ETHUSDT永续 = 4ETH_USDT、以此类推

data说明

"bids": 买方深度列表
"asks": 卖方深度列表
{
    "price": 委托价格,
    "volume": 委托数量(张)
}

订阅 Deals 数据 bibox_sub_spot_$pair_deals

参考现货API Reference

合约的pair参数： BTCUSDT永续 = 4BTC_USDT、ETHUSDT永续 = 4ETH_USDT、以此类推

data说明

{
    "id": 成交历史id,
    "pair": 交易对, 如：4BTC_USDT、4ETH_USDT...
    "price": 成交均价,
    "amount": 成交数量,
    "time": 成交时间戳,
    "side": 成交方向，1-开多，2-开空
}

订阅 Ticker 数据 bibox_sub_spot_$pair_ticker

参考现货API Reference

合约的pair参数： BTCUSDT永续 = 4BTC_USDT、ETHUSDT永续 = 4ETH_USDT、以此类推

data说明

"data":{
   "pair": 交易对
   "last": 最新成交价
   "last_cny": 最新成交价，cny计价
   "last_usd": 最新成交价，usd计价
   "high": 24h最高价
   "low": 24h最低价
   "buy": 最新买一价
   "buy_amount": 买一量(张)
   "sell": 最新卖一价
   "sell_amount": 卖一量(张)
   "vol": 24h成交量(张)
   "percent": 24h涨跌幅
   "timestamp": 时间戳
   "base_last_cny": 最新成交价，cny计价（保留8位小数）
}

订阅 Login 数据 bibox_sub_spot_ALL_ALL_login

参考现货API Reference

合约的pair参数： BTCUSDT永续 = 4BTC_USDT、ETHUSDT永续 = 4ETH_USDT、以此类推

返回数据例子 合约资产 contract_assets

[
    {
        "channel":"bibox_sub_spot_ALL_ALL_login",
        "binary":"0",
        "data_type":1,
        "data":{
            "contract_assets":{
                "user_id":10101010,
                "coin_symbol":"USDT",
                "balance":"99.1823", // 可用余额
                "freeze":"0.7899", // 冻结金额
                "profit":"-3.6816",
                "margin":"0.7899", // 冻结保证金
                "imargin":"0.0000" // 挂单冻结资金
            }
        }
    }
]

合约持仓 contract_order

[
    {
        "channel":"bibox_sub_spot_ALL_ALL_login",
        "binary":"0",
        "data_type":1,
        "data":{
            "contract_order":{
                "user_id":10101010,
                "coin_symbol":"USDT",
                "pair":"4BTC_USDT", // 合约符号
                "order_side":2, // 持仓方向，1开多，2开空
                "price":"3949.7850", // 开仓均价
                "price_up":"4009.0200", // 挂单开多均价
                "price_down":"3946.0300", // 挂单开空均价
                "fee_rate":"0.0000",
                "contract":2, // 持仓张数
                "margin":"1.5799", // 保证金
                "imargin":"0.0000", // 挂单占用资金
                "icontract_up":1, // 委托开多未成交张数
                "icontract_down":0, // 委托开空未成交张数
                "leverage":"50", // 杠杆倍数，0代表全仓
                "price_force":"4009.0318", // 爆仓价格
                "price_alert":"3989.2829", // 爆仓告警价格
                "profit":"-3.5492" 
            }
        }
    }
]

委托单 contract_pending

[
    {
        "channel":"bibox_sub_spot_ALL_ALL_login",
        "binary":"0",
        "data_type":1,
        "data":{
            "contract_pending":{
                "id":"628754", // 委托订单号
                "user_id":10101010,
                "coin_symbol":"USDT",
                "pair":"4BTC_USDT", // 合约符号
                "order_side":1, // 1开多，2开空
                "order_type":1,
                "price":"4009.0200", // 挂单价格
                "contract":1, // 挂单张数
                "fee_rate_maker":"0.0000",
                "fee_rate_taker":"0.0000",
                "order_from":1,
                "status":3, // 0，1：未成交，2：部分成交，3以上：已完成
                "price_deal":"3952.5600", // 成交均价
                "contract_deal":1, // 已成交张数
                "deal_count":1,
                "createdAt":1550671734000, // 下单时间
                "updatedAt":1550671734000
            }
        }
    }
]

成交记录 contract_detail

[
    {
        "channel":"bibox_sub_spot_ALL_ALL_login",
        "binary":"0",
        "data_type":1,
        "data":{
            "contract_detail":{
                "order_id":"628754", // 委托订单号
                "user_id":10101010,
                "coin_symbol":"USDT",
                "pair":"4BTC_USDT", // 合约符号
                "order_side":1, // 1开多，2开空
                "order_type":1, // 1市价，2限价
                "order_from":1,
                "contract":1, // 成交张数
                "price":"4009.0200", // 开仓价
                "price_deal":"3952.5600", // 成交价
                "fee":"0.0000", // 手续费
                "is_maker":0, // 是否是maker
                "is_cancel":0, // 是否是撤销单
                "is_persist":0,
                "force_sub":0,
                "createdAt":1550671735000, // 生成时间
                "updatedAt":1550671735000
            }
        }
    }
]

仓位变化记录 contract_deal_log

{
    "channel":"bibox_sub_spot_ALL_ALL_login",
    "binary":"0",
    "data_type":1,
    "data":{
        "contract_deal_log":{
            "id":"1125899906842966183", 
            "user_id":10040000,
            "type":"1", // 1开仓，2平仓，3爆仓，4减仓
            "pair":"4ETH_USDT",
            "coin_symbol":"USDT",
            "price_open":"182.2091272149", // 开仓均价
            "price":"181.1900", // 挂单价格
            "price_deal":"181.1900", // 成交价格
            "contract":"1", // 成交张数，可能为负
            "profit":"0", // 收益
            "fee":"0.0011", // 手续费
            "order_side":1, // 方向
            "createdAt":1572855008209,
            "updatedAt":1572855008209
        }
    }
}

订阅指数 bibox_sub_spot_ALL_ALL_indexMarket

成功建立和 WebSocket API 的连接之后，向 Server 发送如下格式的数据来订阅数据

{
    "event":"addChannel",
    "channel":"bibox_sub_spot_ALL_ALL_indexMarket",
    "binary":1
}
参数名称 是否必须 类型 描述 默认值 取值范围

正确订阅

{
    "event":"addChannel",
    "channel":"bibox_sub_spot_ALL_ALL_indexMarket",
    "binary":1
}

订阅成功返回数据的例子

[
    {
        "id":147,
        "is_hide":0,
        "pair_type":0,
        "area_id":15,
        "coin_symbol":"ETH",
        "currency_symbol":"USDT",
        "last":"147.1849",
        "high":"148.3986",
        "low":"140.4113",
        "change":"-0.5364",
        "percent":"-0.36%",
        "vol24H":"43108",
        "amount":"6240970.83",
        "last_cny":"989.4382",
        "base_last_cny":"",
        "high_cny":"997.5971",
        "low_cny":"943.9036",
        "last_usd":"147.1848",
        "high_usd":"148.3985",
        "low_usd":"140.4113"
    },
    {
        "id":146,
        "is_hide":0,
        "pair_type":0,
        "area_id":15,
        "coin_symbol":"BTC",
        "currency_symbol":"USDT",
        "last":"3955.1652",
        "high":"3993.1069",
        "low":"3880.6072",
        "change":"+6.1701",
        "percent":"+0.16%",
        "vol24H":"43109",
        "amount":"169654088.16",
        "last_cny":"26588.2733",
        "base_last_cny":"",
        "high_cny":"26843.3333",
        "low_cny":"26087.0635",
        "last_usd":"3955.1651",
        "high_usd":"3993.1068",
        "low_usd":"3880.6072"
    }
]

data 说明

 {
     "id":147,
     "is_hide":0,
     "pair_type":0,
     "area_id":15,
     "coin_symbol":"ETH", // 币种符号
     "currency_symbol":"USDT", // 计价货币，USDTFUND代表溢价指数
     "last":"147.1867", // 最新价格
     "high":"148.3986",
     "low":"140.4113",
     "change":"-0.5346",
     "percent":"-0.36%",
     "vol24H":"43109",
     "amount":"6241118.04",
     "last_cny":"989.4508",
     "base_last_cny":"",
     "high_cny":"997.5971",
     "low_cny":"943.9036",
     "last_usd":"147.1867",
     "high_usd":"148.3985",
     "low_usd":"140.4113"
 }

之后每当指数有更新时，client 会收到数据，例子

{
    "id":147,
    "is_hide":0,
    "pair_type":0,
    "area_id":15,
    "coin_symbol":"ETH",
    "currency_symbol":"USDT",
    "last":"147.1867",
    "high":"148.3986",
    "low":"140.4113",
    "change":"-0.5346",
    "percent":"-0.36%",
    "vol24H":"43109",
    "amount":"6241118.04",
    "last_cny":"989.4508",
    "base_last_cny":"",
    "high_cny":"997.5971",
    "low_cny":"943.9036",
    "last_usd":"147.1867",
    "high_usd":"148.3985",
    "low_usd":"140.4113"
}

订阅合约下单价格限制 bibox_sub_spot_ALL_ALL_contractPriceLimit

成功建立和 WebSocket API 的连接之后，向 Server 发送如下格式的数据来订阅数据

{
    "event":"addChannel",
    "channel":"bibox_sub_spot_ALL_ALL_contractPriceLimit",
    "binary":1
}
参数名称 是否必须 类型 描述 默认值 取值范围

正确订阅

{
    "event":"addChannel",
    "channel":"bibox_sub_spot_ALL_ALL_contractPriceLimit",
    "binary":1
}

订阅成功返回数据的例子

{
    "4BTC_USDT":{
        "min_up":"2964.4562",
        "max_up":"4090.9496",
        "min_down":"3814.2670",
        "max_down":"4940.7603",
        "market_up":"4090.9496",
        "market_down":"3814.2670"
    },
    "4ETH_USDT":{
        "min_up":"110.3038",
        "max_up":"155.1606",
        "min_down":"138.9828",
        "max_down":"183.8396",
        "market_up":"155.1606",
        "market_down":"138.9828"
    }
}

data 说明

       "4BTC_USDT":{ // 合约符号
           "min_up":"2964.4562", // 开多最小价格
           "max_up":"4090.9496", // 开多最大价格
           "min_down":"3814.2670", // 开空最小价格
           "max_down":"4940.7603", // 开空最大价格
           "market_up":"4090.9496", // 市价开多最大价格
           "market_down":"3814.2670" // 市价开空最小价格
       }
   }

之后每当下单价格限制有更新时，client 会收到数据，例子

{
    "4BTC_USDT":{
        "min_up":"2964.4562",
        "max_up":"4090.9496",
        "min_down":"3814.2670",
        "max_down":"4940.7603",
        "market_up":"4090.9496",
        "market_down":"3814.2670"
    },
    "4ETH_USDT":{
        "min_up":"110.3038",
        "max_up":"155.1606",
        "min_down":"138.9828",
        "max_down":"183.8396",
        "market_up":"155.1606",
        "market_down":"138.9828"
    }
}

Home

Bibox交易所提供REST API 和 WebSocket API，便于投资者查看行情、快速交易。

Bibox交易所

https://www.bibox.com

REST API

WebSocket API

合约

REST API

WebSocket API

Clone this wiki locally