NAV Navbar
json

更新日志

版本 时间 更新内容
V1.10.3
2022-06-2
* K线API增加精度: 1w, 1m
V1.10.2
2021-11-11
* GET /v1/margins 添加统一保证金模式下的保证金信息.
V1.10.1
2021-08-10
* GET /v1/user_trades 新增参数: start_id/end_id
* websocket order_book频道新增推送频率fixed100ms
* websocket新增RPC: cancel_on_disconnect
V1.10.0
2021-05-26
* 查询页数 offset 最大为100, 超过次页请缩小查询范围(比如时间范围).
V1.9.0
2021-03-30
* 更新stop order前缀: 普通stop order, 前缀是stop-, 加强版stop order(条件单), 前缀是trigger-
V1.8.0
2021-03-12
* 更新以下REST接口的分页信息:
GET v1/market/trades
GET v1/orders
GET v1/transactions
GET v1/user/settlements
原有: "paging": {"limit": 2, "offset": 3, "total": 59}
新的: "page_info": { "has_more": true }
* 支持 hidden 订单:
POST /v1/orders
POST /v1/batchorders
* 以下REST接口返回数据新增 source, hidden:
POST /v1/orders
POST /v1/batchorders
POST /v1/amend_orders
POST /v1/amend_batchorders
GET /v1/orders
GET /v1/open_orders
GET /v1/stop_orders
* websocket order 频道返回数据新增 hidden.
* 加强版stop order, 新增 trigger-limit, trigger-market 订单类型
V1.7.2
2021-02-19
* 新增 GET /v1/user/info
* 对于 GET /v1/platform_blocktradesGET /v1/blocktrades, 返回值新增 trade_id, index_price, sigma
V1.7.1
2021-02-04
* 新增 GET /v1/currencies
V1.7.0
2021-01-14
* 对于 GET /v1/tickers and websocket ticker 返回值新增 funding_rate,funding_rate8h 字段
* REST 接口 GET /v1/orders, GET /v1/open_orders 和 websocket 频道 order 返回值新增 reorder_index(内部使用)
V1.6.1
2020-12-29
* 对于/v1/accounts, 返回值新增projected_info字段
* 接口 /v1/market/trades 添加参数 start_time, end_time
* 新增 v1/total_volumes
* 对于GET /v1/wallet/withdraw, /v1/wallet/withdrawals/v1/wallet/deposits, 返回值增加is_onchain字段
V1.6.0
2020-12-08
* Currency 参数为必填
* 以下接口会添加参数 currency
POST /v1/batchorders
POST /v1 amend_orders
POST /v1/amend_batchorders
POST /v1/blocktrades
* 接口 POST /v1/account_configs/cod 不再是币种级别, currency 已经去掉
* 接口 GET /v1/tickers 和websocket ticker 频道, 如果前24小时没有成交,获取上一次成交作为open,high,low,close
V1.4.0
2020-10-22
* 新增 /v1/settlement_prices
* 新增 GET /v1/funding_rate_history
V1.3.1
2020-09-22
* account频道新增future_delta字段
* position频道新增liq_price, leverage字段
V1.3.0 2020-09-18 * 新增 mmp rest api:
GET /v1/mmp_state,
POST /v1/update_mmp_config,
POST /v1/reset_mmp, and
*新增 websocket mmp_frozen 频道
V1.0.2.6 2020-09-08 * 增加label: GET /v1/user/trades and WS user_trade channel
* 新增接口 /v1/system/cancel_only_status 查询 cancel only 状态.
* 修复 websocket trade, market_trade 的返回结构.
* 支持对手价.
* 修复trade里面的 usd_price: (rest & ws) for options
V1.0.2 2020-08-25 * 新增批量改单接口: POST /v1/amend_batchorders
* /v1/market/trades 增加 block trade 标记
* 修复 transaction log 的 trade id.
* 新增接口 GET /v1/funding_rate
V1.0.1 2020-08-10 * 新增批量下单接口: POST /v1/batchorders
V1.0 2020-07-30 *新增account_configs/cod 接口
* order频道新增 is_liquidation, taker_fee_rate,maker_fee_rate,label,stop_price,reduce_only,post_only,reject_post_only 字段
* market_trade, user_trade 频道新增 is_block_trade字段
V0.4 2020-07-15 *API返回参数中去掉fee,pnl,cashflow, order action字段,影响接口包括:POST /v1/orders,POST /v1/amend_orders,POST /v1/close_positions
* amend_orders接口新增 qty字段
* block trade,platform_blocktrades 接口新增source字段
* accounts接口新增future_delta字段
*instruments接口新增contract_size,contract_size_currency字段
V0.3 2020-06-30 * Transaction log query 接口新增 position 字段
* 新增block trade接口
* 批量删除接口支持更多参数
* block trade query接口新增taker/maker字段
V0.2 2020-06-15 * Order接口新增:post_only, reject_post_only 字段
* Order query 接口新增 label 字段
V0.1 2020-06-01 初始版本

介绍

用户手册

在bit.com 我们提供数字资产合约、期权等衍生品交易服务。 有两种方式可以调用我们的API接口:Rest 和 Websocket。

测试环境访问地址

生产环境访问地址

访问限制

为了保证系统运行效率,bit.com实施API访问限流措施。公有接口按IP进行频率限制,私有接口按UID进行频率限制。当请求频率超限时,会返加“429 too many requests” 提示。每个UID的API限制参数可在bit.com网站的交易中心页面进行查看。如需提高限制参数,请联系我们的用户支持([email protected])。

鉴权

私有接口必填字段


如果鉴权失败,会返回错误码412“AkID is valid”。

签名算法

    #########
    # Python code to calc BIT.COM API signature
    #########
    import hashlib
    import hmac

    def encode_list(self, item_list):
        list_val = []
        for item in item_list:
            obj_val = self.encode_object(item)
            list_val.append(obj_val)
        sorted_list = sorted(list_val)
        output = '&'.join(sorted_list)
        output = '[' + output + ']'
        return output

    def encode_object(self, param_map):
        sorted_keys = sorted(param_map.keys())
        ret_list = []
        for key in sorted_keys:
            val = param_map[key]
            if isinstance(val, list):
                list_val = self.encode_list(val)
                ret_list.append(f'{key}={list_val}')
            elif isinstance(val, dict):
                # call encode_object recursively
                dict_val = self.encode_object(val)
                ret_list.append(f'{key}={dict_val}')
            elif isinstance(val, bool):
                bool_val = str(val).lower()
                ret_list.append(f'{key}={bool_val}')
            else:
                general_val = str(val)
                ret_list.append(f'{key}={general_val}')

        sorted_list = sorted(ret_list)
        output = '&'.join(sorted_list)
        return output

    def get_signature(self, http_method, api_path, param_map):
        str_to_sign = api_path + '&' + self.encode_object(param_map)
        print('str_to_sign = ' + str_to_sign)
        sig = hmac.new(self.secret_key.encode('utf-8'), str_to_sign.encode('utf-8'), digestmod=hashlib.sha256).hexdigest()
        return sig

    #########
    # END
    #########

  1. 请求参数:POST为JSON,其余部分为查询字符串
  2. 对签名进行编码,对于简单的json对象,请按字母顺序对参数进行排序,并把他们用“&”连接,如'param1=value1&param2=value2', then get str_to_sign = api_path + '&' + 'param1=value1&param2=value2'
  3. 对嵌套数组对象,对每个对象进行编码,并按字母顺序进行排序,使用“&”符号连接,并用[ ]括起来,如 str_to_sign = api_path + '&' + 'param1=value1&array_key1=[array_item1&array_item2]', 参见下面的例子
  4. 签名使用哈希算法,hex(hmac_sha256(str_to_sign, secret_key))
  5. 在请求参数中添加签名字段:对查询字符串,添加“&signature=YOUR_SIGNATURE”, 对JOSN请求体, 添加 {'signature':YOUR_SIGNATURE}


































GET 请求示例:

*Secret Key: eabc3108-dd2b-43df-a98d-3e2054049b73
*HTTP method: GET
*API Path: /v1/margins
*Query string: price=8000&qty=30&instrument_id=BTC-PERPETUAL&timestamp=1588242614000
*得到 str_to_sign = /v1/margins&instrument_id=BTC-PERPETUAL&price=8000&qty=30&timestamp=1588242614000

> echo -n "/v1/margins&instrument_id=BTC-PERPETUAL&price=8000&qty=30&timestamp=1588242614000" | openssl dgst -sha256 -hmac "eabc3108-dd2b-43df-a98d-3e2054049b73"

> e3be96fdd18b5178b30711e16d13db406e0bfba089f418cf5a2cdef94f4fb57d

sig = hex(hmac_sha256(str_to_sign, secret_key)) = e3be96fdd18b5178b30711e16d13db406e0bfba089f418cf5a2cdef94f4fb57d

*最后JSON请求体为: { "instrument_id": "BTC-27MAR20-9000-C", "order_type": "limit", "price": "0.021", "qty": "3.14", "side": "buy", "time_in_force": "gtc", "stop_price": "", "stop_price_trigger": "", "auto_price": "", "auto_price_type": "", "timestamp": 1588242614000, "signature": "e3be96fdd18b5178b30711e16d13db406e0bfba089f418cf5a2cdef94f4fb57d" }

POST 请求示例:

Secret Key: eabc3108-dd2b-43df-a98d-3e2054049b73
HTTP method: POST
API Path: /v1/orders
JSON body:
{ "instrument_id": "BTC-27MAR20-9000-C", "order_type": "limit", "price": "0.021", "qty": "3.14", "side": "buy", "time_in_force": "gtc", "stop_price": "", "stop_price_trigger": "", "auto_price": "", "auto_price_type": "", "timestamp": 1588242614000 }

得到 str_to_sign = /v1/orders&auto_price=&auto_price_type=&instrument_id=BTC-27MAR20-9000-C&order_type=limit&price=0.021&qty=3.14&side=buy&stop_price=&stop_price_trigger=&time_in_force=gtc&timestamp=1588242614000

> echo -n "/v1/orders&auto_price=&auto_price_type=&instrument_id=BTC-27MAR20-9000-C&order_type=limit&price=0.021&qty=3.14&side=buy&stop_price=&stop_price_trigger=&time_in_force=gtc&timestamp=1588242614000" | openssl dgst -sha256 -hmac "eabc3108-dd2b-43df-a98d-3e2054049b73"

> 34d9afa68830a4b09c275f405d8833cd1c3af3e94a9572da75f7a563af1ca817

sig = hex(hmac_sha256(str_to_sign, secret_key)) = 34d9afa68830a4b09c275f405d8833cd1c3af3e94a9572da75f7a563af1ca817

最后JSON请求体为: { "instrument_id": "BTC-27MAR20-9000-C", "order_type": "limit", "price": "0.021", "qty": "3.14", "side": "buy", "time_in_force": "gtc", "stop_price": "", "stop_price_trigger": "", "auto_price": "", "auto_price_type": "", "timestamp": 1588242614000, "signature": "34d9afa68830a4b09c275f405d8833cd1c3af3e94a9572da75f7a563af1ca817" }

POST 请求带 boolean 字段

例如以POST /v1/orders 为例 (post_only 字段),

例子

request

得到 string to sign

POST 请求带 array 字段

for item in object_array:
    str_list.add(encode(item))
str_list.sorted()
str_to_sign = '&'.join(str_list)

以 POST /v1/blocktrades 为例:

私钥是 eabc3108-dd2b-43df-a98d-3e2054049b73

例子

request

得到 string to sign

多币种支持

币种: BTCETHBCH

为了支持多币种, account/order/trade/position/tx_log 都存储在独立的数据库里, 因此BTC和ETH的account_id/order_id/trade_id的值有可能是重复的, 例如,用户有 一笔BTC的订单ID为123,他也可能有一笔ETH的订单123,order_id不是全局唯一的, currency+order_id才是唯一的。

接口目录

路径 方法 描述 范围 限速归类 权限
/v1/orders POST 下单 private trade COIN-M futures&options trade
/v1/batchorders POST 批量下单 private trade COIN-M futures&options trade
/v1/amend_orders POST 修改订单 private trade COIN-M futures&options trade
/v1/amend_batchorders POST 批量改单 private trade COIN-M futures&options trade
/v1/cancel_orders POST 取消订单 private trade COIN-M futures&options trade
/v1/close_positions POST 平仓 private trade COIN-M futures&options trade
/v1/account_configs/cod POST 更新 COD 配置 private trade COIN-M futures&options trade
/v1/update_mmp_config POST 更新 MMP 配置 private trade COIN-M futures&options trade
/v1/reset_mmp POST 重置 MMP 状态 private trade COIN-M futures&options trade
/v1/open_orders GET 查询未结订单 private others read
/v1/orders GET 查询订单历史 private others read
/v1/stop_orders GET 查询止盈止损单历史 private others read
/v1/margins GET 查询预估保证金 private others read
/v1/user/trades GET 查询用户交易记录 private others read
/v1/positions GET 查询仓位 private others read
/v1/user/deliveries GET 查询交割历史 private others read
/v1/user/settlements GET 查询结算历史 private others read
/um/v1/account_mode GET 查询账户类型 private others read
/v1/accounts GET 合约账户信息 private others read
/v1/transactions GET 合约交易日志 private others read
/um/v1/account GET 统一 UM 账户信息 private UM-others read
/um/v1/transactions GET 统一 UM 交易日志 private UM-others read
/um/v1/interest_records GET 统一账户计息记录 private UM-others read
/v1/ws/auth GET 获取 websocket 的 token private others read
/v1/account_configs/cod GET 查询 COD 配置 private others read
/v1/mmp_state GET 查询 MMP 状态 private others read
/v1/blocktrades POST block trade 下单 private block_trade block_trade
/v1/blocktrades GET 查询当前用户的 block trade private block_trade block_trade
/v1/platform_blocktrades GET 查询平台的 block trade private block_trade block_trade
/v1/user/info GET blocktrade 权限查询用户信息 private block_trade block_trade
/v1/system/time GET 查询服务器时间戳 public public /
/v1/system/version GET 查询 API 版本 public public /
/v1/system/cancel_only_status GET 查询 cancel only 状态 public public /
/v1/instruments GET 查询产品列表 public public /
/v1/market/summary GET 查询市场价格汇总 public public /
/v1/tickers GET 查询市场 ticker public public /
/v1/orderbooks GET 查询市场深度 public public /
/v1/market/trades GET 查询市场最新交易 public public /
/v1/klines GET 查询 kline public public /
/v1/index GET 查询指数价格 public public /
/v1/delivery_info GET 查询每日交割价 public public /
/v1/funding_rate GET 查询资金费率 public public /
/v1/funding_rate_history GET 查询资金费率历史 public public /
/v1/settlement_prices GET 获取市场结算价格信息 public public /
/v1/total_volumes GET 获取市场全币种 24 小时成交量 public public /
/um/v1/loan_rates GET 查询借币利率 public public /

系统接口

查询服务器时间

GET /v1/system/time

curl "https://betaapi.bitexch.dev/v1/system/time"

返回数据

{
  "code": 0,
  "message": "",
  "data": 1587884283175
}

查询服务器时间。

请求参数

None

返回数据

字段名称 数据类型 说明
data integer 服务器时间戳

查询API版本

GET /v1/system/version

curl "https://betaapi.bitexch.dev/v1/system/version"

返回数据

{
  "code": 0,
  "message": "",
  "data": "v1.0"
}

查询API版本。

请求参数

None

返回数据

字段名称 数据类型 说明
data string API 版本

查询 cancel only 状态

GET /v1/system/cancel_only_status

curl "https://betaapi.bitexch.dev/v1/system/cancel_only_status"

返回数据


{
    "code": 0,
    "message": "",
    "data": {
        "status": 0,
        "remain_ms": 0
    }
}

当bit.com在进行系统维护、升级等特殊时期,整个系统会处于只允许撤销订单,不能下新订单的状态(即cancel only状态)。此接口用于查询系统是否处于cancel-only 状态,还有多长时间结束。

status
status=1: cancel-only生效中
status=0: cancel-only已经结束,可以下单

remain_ms
Cancel-only 还有多长时间结束(毫秒)

请求参数

None

返回数据

字段名称 数据类型 说明
status integer Cancel-only 状态
remain_ms integer Cancel-only 还有多长时间结束(毫秒)

公共市场数据

获取指数

GET /v1/index

curl "https://betaapi.bitexch.dev/v1/index?currency=BTC"

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "name": "BTC",
        "index_price": "9444.49000000"
    }
}

已弃用, 请使用 /um/index_price

获取指数价格。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种

返回数据

字段名称 数据类型 说明
name string 指数名称
index_price string 指数价格

获取产品信息

GET /v1/instruments

curl "https://betaapi.bitexch.dev/v1/instruments?currency=BTC&category=option&active=true"

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "instrument_id": "BTC-29MAY20-9500-P",
            "created_at": 1589425192000,
            "updated_at": 1589425192000,
            "base_currency": "BTC",
            "quote_currency": "USD",
            "strike_price": "9500.00000000",
            "expiration_at": 1590739200000,
            "option_type": "put",
            "category": "option",
            "min_price": "0.00050000",
            "max_price": "10.00000000",
            "price_step": "0.00050000",
            "min_size": "0.10000000",
            "size_step": "0.10000000",
            "delivery_fee_rate": "0.00020000",
            "contract_size": "1.00000000",
            "contract_size_currency": "BTC",  
            "display_at": 1589425292000,
            "active": true
        }
    ]
}

获取产品(期货/期权) 信息, 查询条件: 币种/产品种类。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
active boolean false true 是否查询活跃产品

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
category string 产品种类
created_at integer 创建时间戳
updated_at integer 更新时间戳
expiration_at integer 到期时间戳 (永续的到期时间设置为2100-01-01)
base_currency string Base币种
quote_currency string Quote币种
option_type string 期权种类: Call/put
strike_price string 期权执行价格
min_price string 最小下单价格(订单价格还受限于 min sell/max buy)
max_price string 最大下单价格(订单价格还受限于 min sell/max buy)
price_step string 价格步长
min_size string 最小下单数量
size_step string 数量步长
delivery_fee_rate string 期权交割费率
contract_size string 合约乘数
contract_size_currency string 合约乘数币种
active bool 是否活跃
display_at integer 上架显示时间 (内部使用)

获取行情信息

GET /v1/tickers

curl "https://betaapi.bitexch.dev/v1/tickers?instrument_id=BTC-26JUN20-5000-C"

返回数据

{
    "code": 0,
    "message": "",
    "data":{
        "time":1589126498813,
        "instrument_id":"BTC-26JUN20-5000-C",
        "best_bid":"0.50200000",
        "best_ask":"0.50500000",
        "best_bid_qty":"2.30000000",
        "best_ask_qty":"0.80000000",
        "ask_sigma":"2.22748567",
        "bid_sigma":"2.18964114",
        "last_price":"0.50500000",
        "last_qty":"0.10000000",
        "open24h":"0.50500000",
        "high24h":"0.50500000",
        "low24h":"0.50500000",
        "price_change24h":"",
        "volume24h":"0.10000000",
        "open_interest":"289.50000000",
        "underlying_name":"BTC-26JUN20",
        "underlying_price":"8616.02000000",
        "mark_price":"0.43989364",
        "sigma":"1.29049244",
        "delta":"0.92073799",
        "vega":"4.54807454",
        "theta":"-6.28858194",
        "gamma":"0.00003713",
        "min_sell":"0.38950000",
        "max_buy":"0.49000000"
    }

}

根据产品名称获取tickers信息。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
last_price string 最新成交价
last_qty string 最新成交量
open24h string 24小时开盘价
high24h string 24小时最高价
low24h string 24小时最低价
volume24h string 24小时成交量
price_change24h string 24小时价格变动
open_interest string 未平仓量
best_bid string 最佳买入价
best_ask string 最佳卖出价
best_bid_qty string 最佳买入数量
best_ask_qty string 最佳卖出数量
bid_sigma string 买入sigma (期权)
ask_sigma string 卖出sigma (期权)
underlying_name string 标的指数(期权)
underlying_price string 标的指数价格(期权)
funding_rate string 资金费率 (永续)
funding_rate8h string 过去8小时的平均资金费率 (永续)
mark_price string 报价
sigma string 报价sigma值(期权)
delta string 报价delta值(期权)
vega string 报价vega值(期权)
theta string 报价theta值(期权)
gamma string 报价gamma值(期权)
max_buy string 最大买入价
min_sell string 最小卖出价

获取市场深度

GET /v1/orderbooks

curl "https://betaapi.bitexch.dev/v1/orderbooks?instrument_id=BTC-27MAR20-9000-C&level=3"

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "instrument_id": "BTC-27MAR20-9000-C",
        "timestamp": 1585299600000,
        "asks": [
            ["0.02300000", "3.00000000"],
            ["0.02400000", "0.70000000"],
            ["0.02500000", "18.00000000"]
        ],
        "bids": [
            ["0.02100000", "0.30000000"],
            ["0.02000000", "2.00000000"],
            ["0.01900000", "5.60000000"]
        ]
    }
}

根据产品名称获取市场深度。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
level int false 5 深度层数,范围:[1,50]

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
timestamp integer 时间戳(数据时间)
asks string Asks 队列 [price, qty]
bids string Bids 队列 [price, qty]

获取市场成交记录

GET /v1/market/trades

curl "https://betaapi.bitexch.dev/v1/market/trades?currency=BTC&category=option&option_type=call&instrument_id=BTC-27MAR20-9000-C&offset=1&limit=1"

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "created_at": 1585299600000,
            "index_price": "8000.00000000",
            "underlying_price": "8000.00000000",
            "instrument_id": "BTC-27MAR20-9000-C",
            "price": "0.03400000",
            "qty": "1.00000000",
            "side": "buy",
            "sigma": "0.00200000",
            "trade_id": 3743,
            "is_block_trade": false
        }
    ]
}

获取市场成交记录。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
option_type string false "" 期权类型
instrument_id string false "" 产品名称
start_time integer false 开始时间戳
end_time integer false 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
trade_id integer 交易ID
instrument_id string 产品名称
created_at integer 成交时间戳
price string 成交价格
qty string 成交数量
side string 方向
index_price string 指数价格
sigma string 隐含波动率 (期权)
underlying_price string 标的价格 (期权)
is_block_trade bool 是否为block trade

获取K线

GET /v1/klines

curl "https://betaapi.bitexch.dev/v1/klines?instrument_id=BTC-27MAR20-9000-C&start_time=1585296000000&end_time=1585596000000&timeframe_min=1440"

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "close": [
            0.023
        ],
        "high": [
            0.031
        ],
        "low": [
            0.022
        ],
        "open": [
            0.028
        ],
        "timestamps": [
            1585296000000
        ],
        "volume": [
            31.2
        ]
    }
}

按照产品名称查询K线。

/v1/klines 返回最多1000条数据。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
start_time integer true 起始时间戳
end_time integer true 结束时间戳
timeframe_min string true "" K线周期(分钟) (1, 3, 5, 15, 30, 60, 120, 240, 360, 720, 1440)

返回数据

字段名称 数据类型 说明
open float array 开盘价
high float array 最高价
low float array 最低价
close float array 收盘价
timestamps float array 开盘时间戳
volume float array 成交量

获取历史交割价格(期权)

GET /v1/delivery_info

curl "https://betaapi.bitexch.dev/v1/delivery_info?currency=BTC&offset=1&limit=10"

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "currency": "BTC",
            "delivery_time": 1585296000000,
            "price": "7982.00000000"
        }
    ]
}

获取历史交割价格。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
currency string 币种
delivery_time integer 时间戳
price string 交割价

获取市场结算价格信息

GET /v1/settlement_prices

curl "https://betaapi.bitexch.dev/v1/settlement_prices?currency=BTC&start_time=1600421456435&end_time=1603013456435"

返回数据


{
  "code": 0,
  "message": "",
  "data": {
    "data": {
      "1600473600000": [
        {
          "date": 1600473600000,
          "currency": "BTC",
          "instrument_id": "BTC-OPTIONS",
          "settlement_type": "delivery",
          "price": "10920.02000000"
        },
        {
          "date": 1600473600000,
          "currency": "BTC",
          "instrument_id": "BTC-PERPETUAL",
          "settlement_type": "settlement",
          "price": "10907.68451016"
        },
        {
          "date": 1600473600000,
          "currency": "BTC",
          "instrument_id": "BTC-19SEP20-F",
          "settlement_type": "delivery",
          "price": "10920.02000000"
        }
      ],
      "1600560000000": [
        {
          "date": 1600560000000,
          "currency": "BTC",
          "instrument_id": "BTC-OPTIONS",
          "settlement_type": "delivery",
          "price": "10981.62000000"
        },
        {
          "date": 1600560000000,
          "currency": "BTC",
          "instrument_id": "BTC-PERPETUAL",
          "settlement_type": "settlement",
          "price": "10961.44289452"
        },
        {
          "date": 1600560000000,
          "currency": "BTC",
          "instrument_id": "BTC-20SEP20-F",
          "settlement_type": "delivery",
          "price": "10981.62000000"
        }
      ]
    }
  }
}

获取市场历史结算价格信息.
开始和结束的时间跨度小于或者等于30天.
BTC-OPTIONS表示所有期权是同一个交割价格.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
start_time integer true 起始时间戳
end_time integer true 结束时间戳

返回数据

字段名称 数据类型 说明
date integer 结算/交割时间戳
currency string 币种
instrument_id string 产品名称 (BTC-OPTIONS表示所有期权)
settlement_type string delivery/settlement
price string 结算/交割价格

获取市场价格汇总信息

GET /v1/market/summary

curl "https://betaapi.bitexch.dev/v1/market/summary?currency=BTC&category=future&instrument_id=BTC-PERPETUAL"

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "instrument_id": "BTC-PERPETUAL",
            "timestamp": 1589029194249,
            "best_bid": "9594.00000000",
            "best_ask": "9623.50000000",
            "best_bid_qty": "16860.00000000",
            "best_ask_qty": "5770.00000000",
            "last_price": "9617.00000000",
            "last_qty": "5530.00000000",
            "open24h": "9858.00000000",
            "high24h": "9989.50000000",
            "low24h": "9498.50000000",
            "volume24h": "1325995140.00000000",
            "open_interest": "460634610.00000000",
            "mark_price": "9556.24890315",
            "max_buy": "9700.50000000",
            "min_sell": "9413.00000000",
            "delta": "",
            "gamma": "",
            "vega": "",
            "theta": ""
        }
    ]
}

根据产品名称获取市场价格汇总信息。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "option" 产品种类
instrument_id string false "" 产品名称

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
timestamp integer 时间戳
best_bid string 最佳买入价
best_ask string 最佳卖出价
best_bid_qty string 最佳买入数量
best_ask_qty string 最佳卖出数量
last_price string 最新成交价
last_qty string 最新成交数量
open24h string 24小时开盘价
high24h string 24小时最高价
low24h string 24小时最低价
volume24h string 24小时成交量
open_interest string 未平仓量
mark_price string 报价
max_buy string 最大买入价
min_sell string 最小卖出价
delta string 期权delta值
gamma string 期权gamma值
vega string 期权vega值
theta string 期权theta值

查询资金费率

GET /v1/funding_rate

curl "https://betaapi.bitexch.dev/v1/funding_rate?instrument_id=BTC-PERPETUAL"

返回数据


{
  "code": 0,
  "message": "",
  "data": {
    "instrument_id": "BTC-PERPETUAL",
    "time": 1635913370000,
    "funding_rate": "0.00000000",
    "funding_rate_8h": "-0.00102858",
    "index_price": "62989.63000000",
    "mark_price": "62969.83608581"
  }
}

查询最新的永续资金费率。 资金费率每10秒更新一次。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称 (永续)

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
time integer 时间戳
funding_rate string 永续资金费率
funding_rate_8h string 永续过去8小时的平均资金费率
index_price string 指数价格
mark_price string 永续标记价格

查询资金费率历史

GET /v1/funding_rate_history

curl "https://betaapi.bitexch.dev/v1/funding_rate_history?instrument_id=BTC-PERPETUAL&start_time=1603260000000&end_time=1603346400000&history_type=1H"

返回数据


{
    "code": 0,
    "message": "",
    "data": [
        {
            "instrument_id": "BTC-PERPETUAL",
            "time": 1603263600000,
            "average_funding_rate": "0.00100000",
            "index_price": "8880.17000000",
            "mark_price": "8900.18000000"
        }
    ]
}

注意: 开始时间须在2020.10.31之后 (timestamp: 1604102400000).

获取时间范围内的资金费率历史,历史种类有1H/8H/24H。

返回时间范围内每3分钟的过去1小时资金费率平均值,对于8小时/24小时历史,返回时间范围内每个整小时时间的过去24小时资金费率平均值。

对于查询1小时历史数据,查询时间范围不能超过1天。 对于查询8小时/24小时历史数据,查询时间范围不能超过30天。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品ID (只能是永续合约)
start_time integer true 开始时间
end_time integer true 结束时间
history_type string true 1H/8H/24H

返回数据

字段名称 数据类型 说明
instrument_id string 产品ID
time integer 时间戳
average_funding_rate string 过去1小时/8小时/24小时平均历史费率
index_price string 指数价格
mark_price string 永续合约标记价格

获取市场全币种24小时成交量

GET v1/total_volumes

curl "https://betaapi.bitexch.dev/v1/total_volumes"

Response

{
  "code": 0,
  "message": "",
  "data": {
    "total_volume_24_hours": "140512988.61600000",
    "details": [
      {
        "currency": "BTC",
        "category": "option",
        "volume_base_ccy": "5254.40000000",
        "volume_usd": "124599899.13600000",
        "index_price": "23713.44000000"
      },
      {
        "currency": "BTC",
        "category": "future",
        "volume_base_ccy": "404.96317700",
        "volume_usd": "9603070.00000000",
        "index_price": "23713.44000000"
      },
      {
        "currency": "ETH",
        "category": "option",
        "volume_base_ccy": "6233.00000000",
        "volume_usd": "3855484.48000000",
        "index_price": "618.56000000"
      },
      {
        "currency": "ETH",
        "category": "future",
        "volume_base_ccy": "3968.14375323",
        "volume_usd": "2454535.00000000",
        "index_price": "618.56000000"
      }
    ]
  }
}

获取市场全币种24小时成交量
缓存5秒钟。

请求参数

返回数据

字段名称 数据类型 说明
total_volume_24_hours string 总成交量
details array 明细

details

字段名称 数据类型 说明
currency string 币种
category string 产品种类
volume_base_ccy string 成交量(基础币种)
volume_usd string 成交量(USD)
index_price string 指数价格

获取币本位合约全部保证金币种

GET v1/currencies

curl "https://betaapi.bitexch.dev/v1/currencies"

Response

{
    "code": 0,
    "message": "",
    "data": {
        "currencies": [
            "BTC",
            "ETH",
            "BCH"
        ]
    }
}

查询交易所支持币本位合约的全部保证金币种

请求参数

返回数据

字段名称 数据类型 说明
currencies array 币种数组

账户信息


查询账户模式

GET /um/v1/account_mode


curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/um/v1/account_mode?timestamp=1589521383462&signature=30f7cf5c8018f5dfee515533e25a1813e9120be7898b62fb85a2f4129f3e9528"

返回数据


// account_mode = Um
{
    "code": 0,
    "message": "",
    "data": {
        "user_id": 1,
        "account_mode": "um",
        "auto_borrow": true,
        "um_risk_mode": "regular",
        "classic_accounts": []
    }
}

// account_mode = classic
{
    "code": 0,
    "message": "",
    "data": {
        "user_id": 1,
        "account_mode": "classic",
        "auto_borrow": false,
        "um_risk_mode": "",
        "classic_accounts": [
            {
                "currency": "BCH",
                "classic_risk_mode": "portfolio_margin"
            },
            {
                "currency": "BTC",
                "classic_risk_mode": "portfolio_margin"
            },
            {
                "currency": "ETH",
                "classic_risk_mode": "portfolio_margin"
            }
        ]
    }
}

查询账户类型。账户类型有两类:经典模式和统一UM模式。另外还有迁移中的临时状态。

查询参数

None

返回数据

字段名称 数据类型 说明
user_id int 用户ID
account_mode string 账户模式
auto_borrow bool 是否自动借币
um_risk_mode string 统一模式下 风控模式 (当账户类型为统一模式时有效)
classic_accounts array 经典模式下分币种的风控模式(当账户类型为经典模式时有效)
字段名称 数据类型 说明
currency string 币种
classic_risk_mode string 风控模式

币本位合约账户信息

GET /v1/accounts


curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/accounts?currency=BTC&timestamp=1589521383462&signature=30f7cf5c8018f5dfee515533e25a1813e9120be7898b62fb85a2f4129f3e9528"

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "user_id": "51140",
        "currency": "BTC",
        "cash_balance": "99.59591877",
        "available_balance": "97.47174526",
        "margin_balance": "99.59589266",
        "initial_margin": "2.12414740",
        "maintenance_margin": "0.00002866",
        "equity": "100.02737507",
        "pnl": "0.08047907",
        "total_delta": "1.40711353",
        "account_id": "3033",
        "mode": "regular",
        "session_upl": "0.08047907",
        "session_rpl": "-0.00002286",
        "option_value": "0.43148240",
        "option_pnl": "0.08048240",
        "option_session_rpl": "0.00000000",
        "option_session_upl": "0.08048240",
        "option_delta": "1.83338535",
        "option_gamma": "0.00017907",
        "option_vega": "4.04908990",
        "option_theta": "-36.98180587",
        "future_pnl": "-0.00000333",
        "future_session_rpl": "-0.00002286",
        "future_session_upl": "-0.00000333",
        "future_session_funding": "-0.00002286",
        "future_delta":"0.00521057",
        "created_at": 1588218506000,
        "projected_info": {
            "projected_initial_margin": "0.97919888",
            "projected_maintenance_margin": "0.78335911",
            "projected_total_delta": "3.89635553"
        }
    }
}

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种

返回数据

字段名称 数据类型 说明
account_id string 账户ID
mode string 风控模式
available_balance string 可用余额
cash_balance string 现金余额
currency string 币种
equity string 权益
initial_margin string 初始保证金
maintenance_margin string 维持保证金
margin_balance string 保证金余额
pnl string 总损益
total_delta string 账户delta总值
session_rpl string 已实现损益
session_upl string 未实现损益
option_value string 期权市值
option_pnl string 期权损益
option_session_rpl string 期权已实现损益
option_session_upl string 期权未实现损益
option_delta string 期权 delta
option_gamma string 期权 gamma
option_vega string 期权 vega
option_theta string 期权 theta
future_pnl string 期货损益
future_session_rpl string 期货已实现损益
future_session_upl string 期货未实现损益
future_session_funding string 期货funding
future_delta string 期货 delta
user_id string 用户ID
created_at integer 创建时间戳
projected_info object Projected Info


ProjectedInfo ProjectedInfo是指过完下一个交割/结算时间之后,IM/MM/Delta的预测值。

Name Type Desc
projected_initial_margin string Projected IM
projected_maintenance_margin string Projected MM
projected_total_delta string Projected Delta

币本位合约交易日志

GET /v1/transactions

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/transactions?currency=BTC&start_time=1585270800000&end_time=1589522084000&type=trade&offset=1&limit=10&timestamp=1589522094430&signature=50b8d98d358253a1f12bc4d75c1ff77f4c0fe6cde8d00251a144c2f699d26b8a" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "transaction_time": 1589521370683,
            "instrument_id": "BTC-22MAY20-7500-C",
            "transaction_type": "trade",
            "direction": "open-buy",
            "qty": "2.00000000",
            "price": "0.17550000",
            "cash_flow": "-0.35100000",
            "funding": "--",
            "fee_paid": "0.00100000",
            "fee_rate": "0.00050000",
            "change": "-0.35200000",
            "balance": "99.59591877",
            "position": "3.00000000",
            "trade_id": "23210268",
            "order_id": "17551020",
            "remark": ""
        }
    ]
}

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
start_time integer false 0 起始时间戳
end_time integer false 0 结束时间戳
type string false "" 交易日志类型
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
transaction_time integer 时间戳
instrument_id string 产品名称
transaction_type string 交易日志类型
direction string 方向. Trade:open buy/open sell/close buy/close sell/liquidation buy/liquidation sell
delivery:close buy/close sell
settlement:long/short
qty string 数量
price string 价格. Type=trade:
filled price (BTC for option, USD for future)
Type=delivery:
Price is delivery unit pnl
Type=settlement:
Price is mark price of 8:00 UTC
cash_flow string 现金流
funding string type = trade/settlement
fee_paid string 手续费
fee_rate string 手续费率
change string 账户变动
balance string 变动后的余额
position string 交易后的仓位
order_id string 相关订单ID
trade_id string 相关交易记录ID
remark string 备注

统一UM账户信息

GET /um/v1/accounts


curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/um/v1/accounts?timestamp=1589521383462&signature=30f7cf5c8018f5dfee515533e25a1813e9120be7898b62fb85a2f4129f3e9528"

返回数据


{
    "code": 0,
    "message": "",
    "data": {
        "user_id": 481554,
        "created_at": 1649923879505,
        "total_collateral": "3170125.05978108",
        "total_margin_balance": "3170125.05978108",
        "total_available": "3169721.64891398",
        "total_initial_margin": "403.41086710",
        "total_maintenance_margin": "303.16627631",
        "total_initial_margin_ratio": "0.00012725",
        "total_maintenance_margin_ratio": "0.00009563",
        "total_liability": "0.00000000",
        "total_unsettled_amount": "-0.84400340",
        "spot_orders_hc_loss": "0.00000000",
        "total_position_pnl": "1225.53245820",
        "details": [
            {
                "currency": "BTC",
                "equity": "78.13359310",
                "liability": "0.00000000",
                "index_price": "41311.20615385",
                "cash_balance": "78.13360190",
                "margin_balance": "78.13359310",
                "available_balance": "78.12382795",
                "initial_margin": "0.00976516",
                "spot_margin": "0.00000000",
                "maintenance_margin": "0.00733859",
                "potential_liability": "0.00000000",
                "interest": "0.00000000",
                "interest_rate": "0.07000000",
                "pnl": "0.02966586",
                "total_delta": "0.48532539",
                "session_rpl": "0.00001552",
                "session_upl": "-0.00003595",
                "option_value": "0.00000000",
                "option_pnl": "0.00000000",
                "option_session_rpl": "0.00000000",
                "option_session_upl": "0.00000000",
                "option_delta": "0.00000000",
                "option_gamma": "0.00000000",
                "option_vega": "0.00000000",
                "option_theta": "0.00000000",
                "future_pnl": "0.02966586",
                "future_session_rpl": "0.00001552",
                "future_session_upl": "-0.00003595",
                "future_session_funding": "0.00001552",
                "future_delta": "0.48532539",
                "future_available_balance": "76.72788921",
                "option_available_balance": "76.72788921",
                "unsettled_amount": "-0.00002043",
                "usdt_index_price": "41311.20615385"
            },
            {
                "currency": "ETH",
                "equity": "1.99960000",
                "liability": "0.00000000",
                "index_price": "3119.01923077",
                "cash_balance": "1.99960000",
                "margin_balance": "1.99960000",
                "available_balance": "1.99960000",
                "initial_margin": "0.00000000",
                "spot_margin": "0.00000000",
                "maintenance_margin": "0.00000000",
                "potential_liability": "0.00000000",
                "interest": "0.00000000",
                "interest_rate": "0.07000000",
                "pnl": "0.00000000",
                "total_delta": "0.00000000",
                "session_rpl": "0.00000000",
                "session_upl": "0.00000000",
                "option_value": "0.00000000",
                "option_pnl": "0.00000000",
                "option_session_rpl": "0.00000000",
                "option_session_upl": "0.00000000",
                "option_delta": "0.00000000",
                "option_gamma": "0.00000000",
                "option_vega": "0.00000000",
                "option_theta": "0.00000000",
                "future_pnl": "0.00000000",
                "future_session_rpl": "0.00000000",
                "future_session_upl": "0.00000000",
                "future_session_funding": "0.00000000",
                "future_delta": "0.00000000",
                "future_available_balance": "1.99960000",
                "option_available_balance": "1.99960000",
                "unsettled_amount": "0.00000000",
                "usdt_index_price": "3119.01923077"
            }
        ],
        "usdt_total_collateral": "3170125.05978108",
        "usdt_total_margin_balance": "3170125.05978108",
        "usdt_total_available": "3169721.64891398",
        "usdt_total_initial_margin": "403.41086710",
        "usdt_total_maintenance_margin": "303.16627631",
        "usdt_total_initial_margin_ratio": "0.00012725",
        "usdt_total_maintenance_margin_ratio": "0.00009563",
        "usdt_total_liability": "0.00000000",
        "usdt_total_unsettled_amount": "-0.84400340"
    }
}



UM用户,用此接口获取统一交易账户信息。

PM total_initial_margin_ratio 公式
true (total_im + spot_haircut_loss) / collateral
false (total_im + spot_haircut_loss) / margin_balance

1)如果分子和分母都为0,返回0。
2)否则如果分母 <=0, 返回 "infinity".
3)返回分子/分母

PM total_maintenance_margin_ratio 公式
true total_maintenance_margin / collateral
false total_maintenance_margin / margin_balance

1)如果分子和分母都为0,返回0。
2)否则如果分母 <=0, 返回 "infinity".
3)返回分子/分母

请求参数

参数名称 数据类型 是否必填 默认值 说明
with_linear_pair_margins string false "" linear_pair_margins字段中返回按正向币对分类的保证金数值. 仅支持Portfolio Margin下返回.

返回数据

字段名称 数据类型 说明
user_id int 用户ID
created_at int 时间戳(查询时刻)
total_collateral string 账户维度USD总担保品金额
total_margin_balance string 账户维度USD总保证金余额
total_available string 账户维度USD总可用余额
total_initial_margin string 账户维度USD总初始保证金
total_maintenance_margin string 账户维度USD总维持保证金
total_initial_margin_ratio string 账户维度USD总初始保证金率,可能会返回"infinity"
total_maintenance_margin_ratio string 账户维度USD总维持保证金率,可能会返回"infinity"
total_liability string 账户维度USD总负债
total_unsettled_amount string 账户维度USD总待结金额
spot_orders_hc_loss string 现货挂单损失
total_position_pnl string 账户维度USD损益 [SUM(ccy.pnl * ccy.index-price)]
details array 分币种账户信息
usdt_total_collateral string (兼容旧字段) 等于 total_collateral
usdt_total_margin_balance string (兼容旧字段) 等于 total_margin_balance
usdt_total_available string (兼容旧字段) 等于 total_available
usdt_total_initial_margin string (兼容旧字段) 等于 total_initial_margin
usdt_total_maintenance_margin string (兼容旧字段) 等于 total_maintenance_margin
usdt_total_initial_margin_ratio string (兼容旧字段) 等于 total_initial_margin_ratio
usdt_total_maintenance_margin_ratio string (兼容旧字段) 等于 total_maintenance_margin_ratio
usdt_total_liability string (兼容旧字段) 等于 total_liability
usdt_total_unsettled_amount string (兼容旧字段) 等于 total_unsettled_amount
字段名称 数据类型 说明
currency string 币种
equity string 权益
liability string 负债
index_price string USD指数价格
usdt_index_price string (兼容旧字段) 等于 index_price
cash_balance string 现金余额
margin_balance string 保证金余额
available_balance string 可用余额
initial_margin string 初始保证金
spot_margin string 现货冻结金额
maintenance_margin string 维持保证金
potential_liability string 潜在负债
interest string 借币利息
interest_rate string 借币利率
pnl string 币种维度损益
total_delta string 账户delta总值
session_rpl string 已实现损益
session_upl string 未实现损益
option_value string 期权市值
option_pnl string 期权损益
option_session_rpl string 期权已实现损益
option_session_upl string 期权未实现损益
option_delta string 期权delta
option_gamma string 期权gamma
option_vega string 期权vega
option_theta string 期权theta
future_pnl string 期货损益
future_session_rpl string 期货已实现损益
future_session_upl string 期货未实现损益
future_session_funding string 期货funding
future_delta string 期货delta
future_available_balance string 期货最大可用余额
option_available_balance string 期权最大可用余额
unsettled_amount string 待结金额

当请求中有with_linear_pair_margins=true参数时, 在linear_pair_margins字段中返回一个数组. 仅支持Portfolio Margin下返回.

字段名称 数据类型 说明
pair string 正向币对名称
initial_margin string 币对初始保证金
maintenance_margin string 币对维持保证金

统一UM账户交易日志

GET /um/v1/transactions

curl -H "X-Bit-Access-Key: ak-8e97ac6c-8075-4a94-b2bb-38bd537619fa" "https://betaapi.bitexch.dev/um/v1/transactions?currency=BTC&type=trade-recv&limit=2&timestamp=1620369292928&signature=35d76033f6e251ce85524ec4310417fd555953fff00cd33f3a94e3d27d062965" 


返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "tx_time": 1631240595162,
            "tx_type": "deposit",
            "ccy": "BTC",
            "instrument_id": "",
            "direction": "",
            "qty": "3.20000000",
            "price": "",
            "position": "",
            "fee_paid": "0.00000000",
            "fee_rate": "",
            "funding": "",
            "change": "3.20000000",
            "balance": "107.00000000",
            "order_id": "",
            "trade_id": "",
            "remark": ""
        },
        {
            "tx_time": 1630722195162,
            "tx_type": "spot-trade-recv",
            "ccy": "BTC",
            "instrument_id": "BTC-USDT",
            "direction": "buy",
            "qty": "2.00000000",
            "price": "60000.00000000",
            "position": "",
            "fee_paid": "0.00030000",
            "fee_rate": "0.00000000",
            "funding": "",
            "change": "2.00000000",
            "balance": "102.00000000",
            "order_id": "9001",
            "trade_id": "3001",
            "remark": ""
        }
    ],
    "page_info": {
        "has_more": false
    }
}

查询统一交易账户的交易日志。

查询参数

参数名称 数据类型 是否必填 默认值 说明
currency string false "" 币种
instrument_id string false "" 产品名称
start_time integer false One month ago 起始时间戳
end_time integer false Now 结束时间戳
type string false "" UM交易日志类型
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

参数名称 数据类型 说明
tx_time integer 时间戳
tx_type string UM交易日志类型
ccy string 币种
instrument_id string 产品名称
direction string 方向: buy/sell
qty string 数量
price string 交易价格 (针对trade交易类型有效)
position string 期权/期货仓位
fee_paid string 手续费
fee_rate string 手续费率
funding string 资金费用
change string 账户变动
cash_flow string 现金流(现货cash_flow=change, 期权/期货请参考期权/期货的transactions文档)
balance string 变动后的余额
order_id string 订单ID
trade_id string 交易ID
remark string 备注

查询计息记录

GET /um/v1/interest_records


curl -H "X-Bit-Access-Key: ak-8e97ac6c-8075-4a94-b2bb-38bd537619fa" "https://betaapi.bitexch.dev/um/v1/interest_records?currency=BTC&timestamp=1631669478618&signature=3d4685f07751cd51f42ee631938f189cbe6e9712cc6d559881e5b3b6d1ba1224" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "currency": "BTC",
            "time": 1631559600000,
            "loan_rate": "0.00300000",
            "liability": "100.00000000",
            "interest": "1.05000000"
        },
        {
            "currency": "BTC",
            "time": 1631556000000,
            "loan_rate": "0.00300000",
            "liability": "100.00000000",
            "interest": "1.06000000"
        },
        {
            "currency": "BTC",
            "time": 1631552400000,
            "loan_rate": "0.00300000",
            "liability": "100.00000000",
            "interest": "1.07000000"
        }
    ],
    "page_info": {
        "has_more": true
    }
}

只有UM模式用户可启用借币功能。此接口用于获取统一保证金UM账户的计息记录。

查询参数

参数名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
start_time integer false One month ago 起始时间戳
end_time integer false Now 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

参数名称 数据类型 说明
currency string 币种
time integer 计息时间戳
loan_rate string 计息利率
liability string 计息负债
interest string 利息

查询币本位合约用户仓位

GET /v1/positions

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/positions?currency=BTC&category=option&instrument_id=BTC-22MAY20-7500-C&offset=1&limit=10&timestamp=1589521619990&signature=9a7f7704cb4d6ec3cd2dccbd55e09ce8abd1ffb48529a742337706dd1a43eea8" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "instrument_id": "BTC-22MAY20-7500-C",
        "qty": "-2.00000000",
        "initial_margin": "0.00000000",
        "maintenance_margin": "0.00000000",
        "avg_price": "0.17550000",
        "session_avg_price": "0.17550000",
        "mark_price": "0.21738391",
        "index_price": "9496.73000000",
        "session_funding": "0.00000000",
        "position_pnl": "0.08376782",
        "position_session_upl": "0.08376782",
        "position_session_rpl": "0.00000000",
        "category": "option",
        "roi": "0.00000000",
        "option_delta": "1.84693852",
        "option_gamma": "0.00017124",
        "option_vega": "3.80882409",
        "option_theta": "-34.02850739",
        "liq_price": "0.00000000",
        "leverage:": "50.00000000",
    }]
}

查询用户仓位. qty and qty_base 带方向, 正数为多仓,负数为空仓。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品类别
instrument_id string false "" 产品名称
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
instrument_id string 产品名称
qty string 仓位,带方向(期权仓位单位为BTC, 期货仓位单位为USD)
qty_base string 仓位, 带方向 (基础币种) (期货)
avg_price string 平均成交价
index_price string 指数价格
mark_price string 报价
initial_margin string 初始保证金
maintenance_margin string 维持保证金
session_avg_price string 会话平均价
session_funding string 会话funding
position_pnl string 仓位损益
position_session_upl string 仓位未实现损益
position_session_rpl string 仓位已实现损益
category string 产品种类
roi string 回报率
option_delta string 期权 delta
option_gamma string 期权 gamma
option_vega string 期权 vega
option_theta string 期权 theta
liq_price string 预估平仓价(期货)
leverage string 杠杆率(期货)

查询币本位合约交割记录

GET /v1/user/deliveries

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/user/deliveries?currency=BTC&category=option&instrument_id=BTC-3MAY20-8625-C&start_time=1585270800000&end_time=1589522084000&offset=1&limit=10&timestamp=1589531240715&signature=1f060cafdcab4466ef3c79363ecea6710ec1966419a35b78f20d75329fed4a7b" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "type": "delivery",
        "timestamp": 1588492890000,
        "instrument_id": "BTC-3MAY20-8625-C",
        "position": "1.00000000",
        "exercise": true,
        "delivery_price": "8994.37000000",
        "delivery_pnl": "0.04106680"
    }]
}

查询用户交割记录.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
start_time integer false 0 起始时间戳
end_time integer false 0 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
type string Settlement type (delivery)
instrument_id string 产品名称
position string 交割仓位
timestamp integer 交割时间戳
exercise boolean 是否行权
delivery_price string 交割价格
delivery_pnl string 交割损益

查询币本位合约结算记录

GET /v1/user/settlements


curl -H "X-Bit-Access-Key: ak-c1d4bc58-37f3-49da-93b5-396ab44b1543" "https://betaapi.bitexch.dev/v1/user/settlements?currency=BTC&offset=1&limit=10&timestamp=1590851451072&signature=538b4ed2b917db4c96e12ddb5daafe84b58f566173f4d003533c19ccc32ff177" 


返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "type": "settlement",
        "timestamp": 1590825600000,
        "instrument_id": "BTC-PERPETUAL",
        "position": "-280750.00000000",
        "direction": "short",
        "session_upl": "-0.02754390",
        "session_rpl": "0.00125935",
        "session_funding": "-0.00028997",
        "price": "32000"
    }]
}

查询用户结算记录(期货).

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
start_time integer false 0 起始时间戳
end_time integer false 0 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
type string 结算类型(settlement)
timestamp integer 时间戳
instrument_id string 产品名称
position string 结算仓位
direction string 方向
session_upl string 未实现损益
session_rpl string 已实现损益
session_funding string 永续funding
price string 结算价格

开启或关闭COD(Cancel On Disconnect)

POST /v1/account_configs/cod

curl -X POST "https://betaapi.bitexch.dev/v1/account_configs/cod" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113"  -d '{"cod":true, "timestamp": 1590572422557, "signature": "3c8c2271a58e3d11dfbd262a6be40ebdd07e8f394a002db0065068b36bc66d5a"}'

返回数据

{
    "code": 0,
    "message": "",
    "data": {
    }
}

开启或关闭COD, 如果COD是开启状态, 同时全部私有频道的连接都断开的话, 这个账户的所有未结订单都会被撤销.

请求参数

字段名称 数据类型 是否必填 默认值 说明
cod bool true "" 开启或关闭COD

返回数据

None


查询COD配置

GET /v1/account_configs/cod

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/account_configs/cod?timestamp=1588932548594&signature=d642b046b247bf00ba285bb260582aadf33e98d2b47d26479b99cc1a7941f807"

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "cod": true
    }
}

查询COD配置.

请求参数

返回数据

字段名称 数据类型 说明
cod bool COD是否开启

查询MMP状态

GET /v1/mmp_state

curl -H "X-Bit-Access-Key: ak-96cc0cbd-c501-448f-a32d-21228bc9648f" "https://betaapi.bitexch.dev/v1/mmp_state?currency=BTC&timestamp=1600050649936&signature=3a3c511ab776674c4a8db31135f22c8bf2bc5aac4eb0070c8c4d577e89e01643" 

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "currency": "BTC",
        "mmp_enabled": true,
        "mmp_user_configurable": false,
        "mmp_config": {
            "window_ms": 20000,
            "frozen_period_ms": 30000,
            "qty_limit": "1000.00000000",
            "delta_limit": "1000.00000000"
        },
        "mmp_frozen_until_ms": -1,
        "mmp_frozen":false
    }
}    

查询MMP状态.

mmp_enabled
MMP是否开启.

mmp_user_configurable
用户是否可以更改MMP配置, 如果为true,用户可以调用 POST /v1/update_mmp_config

mmp_config
MMP 配置参数:
mmp_frozen_until_ms
mmp_frozen_until_ms 显示冻结状态.
mmp_frozen_until_ms > 0: 冻结到指定时间戳,或者手动reset MMP解冻
mmp_frozen_until_ms = 0: 冻结直到reset MMP解冻
mmp_frozen_until_ms = -1: 解冻状态

mmp_frozen
显示MMP是否已经冻结.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种

返回数据

字段名称 数据类型 说明
currency string 货币
mmp_enabled bool MMP 是否开启
mmp_user_configurable bool 用户是否可以修改MMP配置
mmp_config object MMP配置(如下)
mmp_frozen_until_ms integer MMP冻结时间戳
mmp_frozen bool MMP是否冻结
字段名称 数据类型 说明
window_ms integer MMP滚动时间窗口
frozen_period_ms integer MMP冻结时间窗口
qty_limit string MMP数量上限 (in base currency, e.g. BTC)
delta_limit string MMP delta 上限 (in base currency, e.g. BTC)

更新MMP配置

POST /v1/update_mmp_config

curl -X POST "https://betaapi.bitexch.dev/v1/update_mmp_config" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-96cc0cbd-c501-448f-a32d-21228bc9648f"  -d '{"currency": "BTC", "window_ms": 20000, "frozen_period_ms": 30000, "qty_limit": "1000.00000000", "delta_limit": "1000.00000000", "timestamp": 1600050944127, "signature": "661b535fa878633718922fd90b419de4b5d9ae447833876b91bc8bcc7906e0f3"}' 

返回数据

{
    "code": 0,
    "message": "",
    "data": "ok"
}    

更新MMP配置参数 仅当mmp.user_configurable = true, 可以调用此函数,否则返回错误。

MMP冻结状态会触发当 qty >= qty_limit 或者 abs(delta) >= delta_limit.

window_ms: MMP 滚动时间窗口
frozen_period_ms: MMP 冻结时间窗口
qty_limit: MMP 数量上限 (in base currency, e.g. BTC)
delta_limit: MMP delta 上限 (in base currency, e.g. BTC)



请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 货币
window_ms integer true 0 MMP 滚动时间窗口
frozen_period_ms integer true 0 MMP 冻结时间窗口
qty_limit string true "" MMP 数量上限 (in base currency, e.g. BTC)
delta_limit string true "" MMP delta 上限 (in base currency, e.g. BTC)

返回数据

字段名称 数据类型 说明
data string ok

重置MMP状态

POST /v1/reset_mmp

curl -X POST "https://betaapi.bitexch.dev/v1/reset_mmp" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-96cc0cbd-c501-448f-a32d-21228bc9648f"  -d '{"currency": "BTC", "timestamp": 1600050689085, "signature": "992507afc30728c2bc55d7bf7f47e76126ce3f40ddebc205594877381c4374fa"}' 

返回数据

{
    "code": 0,
    "message": "",
    "data": "ok"
}    

重置MMP状态(解冻),用户可以继续下MMP订单。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 货币

返回数据

字段名称 数据类型 说明
data string ok

订单管理

下单

POST /v1/orders


curl -X POST "https://betaapi.bitexch.dev/v1/orders" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113"  -d '{"instrument_id": "BTC-29MAY20-8000-C", "price": "0.08", "qty": "3", "side": "buy", "time_in_force": "gtc", "auto_price": "", "label":"hedge", "hidden": false, "timestamp": 1589523989378, "signature": "68b658eb68f4ce529623bb4505f5c1c6408b37064a9a5f2102d08088e59d917c"}' 


返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "order_id": "17552314",
        "created_at": 1589523803017,
        "updated_at": 1589523803017,
        "user_id": "51140",
        "instrument_id": "BTC-29MAY20-8000-C",
        "order_type": "limit",
        "side": "buy",
        "price": "0.08000000",
        "qty": "3.00000000",
        "time_in_force": "gtc",
        "avg_price": "0.00000000",
        "filled_qty": "0.00000000",
        "status": "open",
        "is_liquidation": false,
        "auto_price": "0.00000000",
        "auto_price_type": "",
        "taker_fee_rate": "0.00050000",
        "maker_fee_rate": "0.00020000",
        "label":"hedge",
        "stop_price": "0.00000000",
        "reduce_only": false,
        "post_only": false,
        "reject_post_only": false,
        "mmp":false,
        "source": "api",
        "hidden": false
    }
}

下一个新订单。
订单类型的默认值是"限价单limit”,订单为市价单market时,价格字段非必填。
生效时间的默认值是‘gtc’。
订单qty单位: 永续/交割合约是USD, 期权是COIN(e.g. BTC)


条件单:
* 订单类型有 stop-limit/stop-market/trigger-limit/trigger-market。
* 止单价格(stop_price)是指触发的条件价格,价格(price)是触发条件价格后的订单下单价格。
* 支持以last-price为触发价格。当last_price达到stop_price 时,则被触发下单。


自动价格类型:
*usd:下单时,设置"auto price type"为'usd',"auto price"为美元计价的值。订单价格将按auto_price/underlying_price公式进行计算,订单每6秒钟进行一次重新报价。
*implv:下单时,设置"auto price"为'implied',"auto price"为隐含波动率计价的值。订单价格将按convert_iv_to_usd(auto_price) / underlying_price公式进行计算,并且订单每6秒进行一次重新报价。示例:想设置隐含波动率85.56%,应输入 85.56。


mmp(market-maker-protect) 订单: 如果用户为MMP用户,且允许用户自定义修改MMP参数时,order下单接口中 "mmp" 字段可生效(可以为'true'也可为'false');如果用户为MMP用户,且不允许用户自定义修改MMP参数时,order下单接口中limit gtc订单强制"mmp"字段为'true'值。



bbo(best-bid-offer) 订单:如果 "bbo"是'true',下单价格取对手价,(买单为卖一价, 卖单为买一价), 如果没有对手价,价格取标记价格。 批量下单不支持对手价下单。

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
qty string true "" 订单数量(正数)
side string true "" 方向
price string false "0.0" 订单价格(市价单不用填)
order_type string false "limit" 订单类型
time_in_force string false "gtc" 生效时间
auto_price_type string false "" 自动价格类型
auto_price string false "" 自动价格, 仅当 "自动价格类型"为 'usd','implv'时需要。 *implv 是百分比, 85.56 代表 85.56%
stop_price string false "" 触发条件价。下条件单时此字段为必填。
label string false "" 用户方唯一订单label,由用户方维护
post_only bool false false 是否post only单
如果 reject_post_only = true, post only单进不了orderbook就会被撤销.
如果 reject_post_only = false, post only单进不了orderbook就会被修改价格。
reject_post_only bool false false 作为maker挂单时不支持改价。当"post_only"为'是'时,该字段有效。
bbo bool false false 是否 bbo 单,是否为对手价下单
mmp bool false false 是否 mmp 单
hidden bool false false 是否隐藏

返回数据

字段名称 数据类型 说明
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方唯一订单ID,由用户方维护
stop_price string 触发条件价
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
source string 订单来源
hidden bool 是否隐藏订单

批量下单

POST /v1/batchorders


curl -X POST "https://betaapi.bitexch.dev/v1/batchorders" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-96cc0cbd-c501-448f-a32d-21228bc9648f"  -d '{"currency": "BTC", "orders_data": [{"instrument_id": "BTC-25SEP20-8000-C-XX", "price": "0.15", "qty": "51", "side": "buy", "hidden": true}, {"instrument_id": "BTC-PERPETUAL", "price": "12000", "qty": "100", "side": "sell"}], "timestamp": 1596782252388, "signature": "0b8b64d2f35f9742a17af4ee0b993d0248a27a98f320abbfe8e7316f184e30d5"}' 


返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "Orders": [
            {
                "order_id": "",
                "created_at": 0,
                "updated_at": 0,
                "user_id": "",
                "instrument_id": "",
                "order_type": "",
                "side": "",
                "price": "",
                "qty": "",
                "time_in_force": "",
                "avg_price": "",
                "filled_qty": "",
                "status": "",
                "is_liquidation": false,
                "auto_price": "",
                "auto_price_type": "",
                "taker_fee_rate": "",
                "maker_fee_rate": "",
                "label": "",
                "reduce_only": false,
                "post_only": false,
                "reject_post_only": false,
                "mmp": false,
                "source": "api",
                "hidden": true,
                "error_code": 18100185,
                "error_msg": "Invalid instrument BTC-25SEP20-8000-C-XX"
            },
            {
                "order_id": "501758",
                "created_at": 1596782252996,
                "updated_at": 1596782252996,
                "user_id": "51140",
                "instrument_id": "BTC-PERPETUAL",
                "order_type": "limit",
                "side": "sell",
                "price": "12000.00000000",
                "qty": "100.00000000",
                "time_in_force": "gtc",
                "avg_price": "0.00000000",
                "filled_qty": "0.00000000",
                "status": "open",
                "is_liquidation": false,
                "auto_price": "0.00000000",
                "auto_price_type": "",
                "taker_fee_rate": "0.00045000",
                "maker_fee_rate": "0.00025000",
                "label": "",
                "reduce_only": false,
                "post_only": false,
                "reject_post_only": false,
                "mmp": false,
                "source": "api",
                "hidden": false,
                "error_code": 0,
                "error_msg": ""
            }
        ]
    }
}

批量下单。
提供订单数组,订单信息同下单接口POST /v1/orders。
批量下单不支持条件单。
批量下单最大下单数为10。


请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
orders_data array true 请求列表(如下)
字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
qty string true "" 订单数量(正数)
side string true "" 方向
price string false "0.0" 订单价格(市价单不用填)
order_type string false "limit" 订单类型
time_in_force string false "gtc" 生效时间
auto_price_type string false "" 自动价格类型
auto_price string false "" 自动价格, 仅当 "自动价格类型"为 'usd','implv'时需要。 *implv 是百分比, 85.56 代表 85.56%
stop_price string false "" 触发条件价。下条件单时此字段为必填。
label string false "" 用户方唯一订单ID,由用户方维护
post_only bool false false 是post only单,则支持仅作为maker挂单,不立即成交。限价单且生效时间类型为'gtc'时该字段有效。条件单暂不支持该设置。
reject_post_only bool false false 是reject单,作为maker挂单时不支持改价。当"post_only"为'是'时,该字段有效。
mmp bool false false 是否 mmp 单
hidden bool false false 是否隐藏

返回数据

Name Type Desc
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方唯一订单ID,由用户方维护
stop_price string 触发条件价
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
source string 订单来源
hidden bool 是否隐藏订单
error_code int 订单请求错误码: 0为成功,否则为失败
error_msg string 订单请求错误信息

撤销订单

POST /v1/cancel_orders


curl -X POST "https://betaapi.bitexch.dev/v1/cancel_orders" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113"  -d '{"currency": "BTC", "order_id": "44092860", "timestamp": 1590572422557, "signature": "3c8c2271a58e3d11dfbd262a6be40ebdd07e8f394a002db0065068b36bc66d5a"}' 



返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "num_cancelled": 1
    }
}

撤销订单。
无参数表示撤销此用户的全部订单。
撤销单笔订单,只需提供订单ID。
批量撤单参数包括: order_id_list, label, instrument_id, category, currency。
批量撤单参数优先级: order_id_list > label > instrument_id > category > currency。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
order_id string false "" 订单ID
order_id_list string false "" 订单ID列表csv格式,例如: 1,2,3
category string false "" 产品种类
instrument_id string false "" 产品名称
label string false "" 用户方唯一订单ID,由用户方维护

返回数据

字段名称 数据类型 说明
num_cancelled integer 成功撤单数目

修改订单

POST /v1/amend_orders


curl -X POST "https://betaapi.bitexch.dev/v1/amend_orders" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113"  -d '{"currency": "BTC", "order_id": "1206764", "price": "9450", "timestamp": 1590760362688, "signature": "a74dda0f2bdaf1e1587a5e7577a281497cb66607166bd3b7e0cc4c805c750bf1"}' 



返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "order_id": "1206764",
        "created_at": 1590760363846,
        "updated_at": 1590760363846,
        "user_id": "51140",
        "instrument_id": "BTC-PERPETUAL",
        "order_type": "limit",
        "side": "buy",
        "price": "9450.00000000",
        "qty": "260.00000000",
        "time_in_force": "gtc",
        "avg_price": "9435.67307692",
        "filled_qty": "260.00000000",
        "status": "filled",
        "is_liquidation": false,
        "auto_price": "0.00000000",
        "auto_price_type": "",
        "taker_fee_rate": "0.00050000",
        "maker_fee_rate": "-0.00020000",
        "label": "hedge",
        "stop_price": "0.00000000",
        "reduce_only": false,
        "post_only": false,
        "reject_post_only": false,
        "mmp": false,
        "source": "api",
        "hidden": false
    }
}

支持修改订单的价格、数量、自动价格。
订单ID为必填参数。
以下参数必须至少提供一个: 价格,数量,自动价格。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
order_id string true "" 订单ID
price string false "" 新的订单价格
auto_price string false "" 新的自动价格 (自动价格单)
qty string false "" 新订单数量

返回数据

字段名称 数据类型 说明
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方唯一订单ID
stop_price string 触发条件价,条件单此参数有效。
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
source string 订单来源
hidden bool 是否隐藏订单

批量修改订单

POST /v1/amend_batchorders


curl -X POST "https://betaapi.bitexch.dev/v1/amend_batchorders" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-96cc0cbd-c501-448f-a32d-21228bc9648f"  -d '{"currency": "BTC", "orders_data": [{"order_id": "572083", "price": "14000", "qty": "3000"}, {"order_id": "invalid-order-id", "price": "15000", "qty": "1000"}, {"order_id": "615775", "price": "0.12", "qty": "3.7"}], "timestamp": 1597313835731, "signature": "c8b5fddd5f2cfa1517854dc54c51e7c3b79af91f0927ea1389ba43dbeee45652"}' 


返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "Orders": [
            {
                "order_id": "572083",
                "created_at": 1597313836214,
                "updated_at": 1597313836214,
                "user_id": "51140",
                "instrument_id": "BTC-PERPETUAL",
                "order_type": "limit",
                "side": "sell",
                "price": "14000.00000000",
                "qty": "3000.00000000",
                "time_in_force": "gtc",
                "avg_price": "0.00000000",
                "filled_qty": "0.00000000",
                "status": "open",
                "is_liquidation": false,
                "auto_price": "0.00000000",
                "auto_price_type": "",
                "taker_fee_rate": "0.00045000",
                "maker_fee_rate": "0.00025000",
                "label": "",
                "reduce_only": false,
                "post_only": true,
                "reject_post_only": false,
                "mmp": false,
                "source": "api",
                "hidden": false,
                "error_code": 0,
                "error_msg": ""
            },
            {
                "order_id": "",
                "created_at": 0,
                "updated_at": 0,
                "user_id": "",
                "instrument_id": "",
                "order_type": "",
                "side": "",
                "price": "",
                "qty": "",
                "time_in_force": "",
                "avg_price": "",
                "filled_qty": "",
                "status": "",
                "is_liquidation": false,
                "auto_price": "",
                "auto_price_type": "",
                "taker_fee_rate": "",
                "maker_fee_rate": "",
                "label": "",
                "reduce_only": false,
                "post_only": false,
                "reject_post_only": false,
                "mmp": false,
                "source": "api",
                "hidden": false,
                "error_code": 18100113,
                "error_msg": "order id is invalid : invalid-order-id"
            },
            {
                "order_id": "615775",
                "created_at": 1597313836214,
                "updated_at": 1597313836214,
                "user_id": "51140",
                "instrument_id": "BTC-25SEP20-9000-C",
                "order_type": "limit",
                "side": "buy",
                "price": "0.12000000",
                "qty": "3.70000000",
                "time_in_force": "gtc",
                "avg_price": "0.00000000",
                "filled_qty": "0.00000000",
                "status": "open",
                "is_liquidation": false,
                "auto_price": "90.00000000",
                "auto_price_type": "usd",
                "taker_fee_rate": "0.00040000",
                "maker_fee_rate": "0.00030000",
                "label": "aaaa",
                "reduce_only": false,
                "post_only": false,
                "reject_post_only": false,
                "mmp": false,
                "source": "api",
                "hidden": false,
                "error_code": 0,
                "error_msg": ""
            }
        ]
    }
}

批量修改订单。
对每一个请求:
订单ID为必填参数。
以下参数必须至少提供一个:价格,数量,自动价格。
批量改单最大订单数为10。


请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
orders_data array true 请求列表(如下)
字段名称 数据类型 是否必填 默认值 说明
order_id string true "" 订单ID
price string false "" 新的订单价格
auto_price string false "" 新的自动价格 (自动价格单)
qty string false "" 新订单数量

返回数据

Name Type Desc
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方唯一订单ID,由用户方维护
stop_price string 触发条件价
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
source string 订单来源
hidden bool 是否隐藏订单
error_code int 订单请求错误码: 0为成功,否则为失败
error_msg string 订单请求错误信息

关闭仓位

POST /v1/close_positions


curl -X POST "https://betaapi.bitexch.dev/v1/close_positions" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113"  -d '{"instrument_id": "BTC-PERPETUAL", "price": "9500", "order_type": "limit", "timestamp": 1589524756236, "signature": "5bf4f9f00722d133336e736196c09a8e02c634dc0deacf2cf12413049d8d8b06"}' 




返回数据



{
    "code": 0,
    "message": "",
    "data": {
        "order_id": "17553311",
        "created_at": 1589524757818,
        "updated_at": 1589524757818,
        "user_id": "51140",
        "instrument_id": "BTC-PERPETUAL",
        "order_type": "limit",
        "side": "sell",
        "price": "9500.00000000",
        "qty": "50.00000000",
        "time_in_force": "gtc",
        "avg_price": "9522.50000000",
        "filled_qty": "50.00000000",
        "status": "filled",
        "is_liquidation": false,
        "auto_price": "0.00000000",
        "auto_price_type": "",
        "taker_fee_rate": "0.00050000",
        "maker_fee_rate": "0.00020000",
        "label": "hedge",
        "stop_price": "0.00000000",
        "reduce_only": false,
        "post_only": false,
        "reject_post_only": false,
        "mmp": false,
        "source": "api",
        "hidden": false
    }
}


关闭所有仓位。下一个平仓单,该订单数量等于 abs(open_position), 方向跟持仓方向相反。

如果用户不想指定价格price, 输入order_type = 'market'

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 平仓单产品名称
order_type string false "limit" 平仓单订单类型 limit (GTC) 订单类型
price string false "" 平仓单价格

返回数据

字段名称 数据类型 说明
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方订单唯一ID
stop_price string 触发条件价,条件单此参数有效。
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
source string 订单来源
hidden bool 是否隐藏订单

查询未结订单

GET /v1/open_orders

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/open_orders?currency=BTC&category=option&instrument_id=BTC-29MAY20-7500-C&timestamp=1589522687689&signature=89d5a1d929e7baa247021e090f9f634f02a7fc6c82a44c8de3bb04fa6b005a7b" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "order_id": "7610691",
        "created_at": 1589183001000,
        "updated_at": 1589183001000,
        "user_id": "51140",
        "instrument_id": "BTC-29MAY20-7500-C",
        "order_type": "limit",
        "side": "buy",
        "price": "0.08000000",
        "qty": "3.00000000",
        "time_in_force": "gtc",
        "avg_price": "0.00000000",
        "filled_qty": "0.00000000",
        "status": "open",
        "fee": "0.00000000",
        "is_liquidation": false,
        "auto_price": "0.00000000",
        "auto_price_type": "",
        "pnl": "0.00000000",
        "cash_flow": "0.00000000",
        "initial_margin": "0.24000000",
        "taker_fee_rate": "0.00050000",
        "maker_fee_rate": "0.00020000",
        "label": "hedge",
        "stop_price": "0.00000000",
        "reduce_only": false,
        "post_only": false,
        "reject_post_only": false,
        "mmp": false,
        "reorder_index": 1,
        "source": "api",
        "hidden": false,
        "is_um": true
        }
    ]
}

查询未结订单.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
label string false "" 用户方订单ID

返回数据

字段名称 数据类型 说明
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
fee string 手续费
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
pnl string 订单损益
cash_flow string 订单现金流
initial_margin string 订单初始保证金(未结订单)
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方订单ID
stop_price string 触发条件价,条件单此参数有效。
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
reorder_index int64 内部排序使用
source string 订单来源
hidden bool 是否隐藏订单
is_um bool 是否Um模式订单

查询订单记录

GET /v1/orders

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/orders?currency=BTC&category=option&instrument_id=BTC-29MAY20-7500-C&order_id=7718222&start_time=1585270800000&end_time=1589522084000&include_open=true&offset=1&limit=10&timestamp=1589523178651&signature=2092cebba4f082f9c8718344cdad9bed83950b5fe90b3a875b708898bfd89b20" 


返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "order_id": "7718222",
        "created_at": 1589202185000,
        "updated_at": 1589460149000,
        "user_id": "51140",
        "instrument_id": "BTC-29MAY20-7500-C",
        "order_type": "limit",
        "side": "buy",
        "price": "0.08000000",
        "qty": "3.00000000",
        "time_in_force": "gtc",
        "avg_price": "0.00000000",
        "filled_qty": "0.00000000",
        "status": "cancelled",
        "fee": "0.00000000",
        "is_liquidation": false,
        "auto_price": "0.00000000",
        "auto_price_type": "",
        "pnl": "0.00000000",
        "cash_flow": "0.00000000",
        "initial_margin": "",
        "taker_fee_rate": "0.00050000",
        "maker_fee_rate": "0.00020000",
        "label": "hedge",
        "stop_price": "0.00000000",
        "reduce_only": false,
        "post_only": false,
        "reject_post_only": false,
        "mmp": false,
        "reorder_index": 1,
        "source": "api",
        "hidden": false,
        "is_um": true
    }]
}

查询订单记录。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
order_id string false "" 订单ID
label string false "" 用户方订单ID
start_time integer false 起始时间戳
end_time integer false 结束时间戳
include_open boolean false true 是否包含未结订单
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
order_id string 订单ID
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 订单价格
qty string 订单数量
time_in_force string 生效时间
avg_price string 平均成交价
filled_qty string 成交数量
status string 订单状态
fee string 手续费
is_liquidation boolean 是否强平单
auto_price string 自动价格
auto_price_type string 自动价格类型
pnl string 订单损益
cash_flow string 订单现金流
initial_margin string 订单初始保证金(未结订单)
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 用户方订单ID
stop_price string 触发条件价,条件单此参数有效。
reduce_only bool 是否reduce only单
post_only bool 是否post only单
reject_post_only bool 是否reject post only单
mmp bool 是否 mmp单
reorder_index int64 内部排序使用
source string 订单来源
hidden bool 是否隐藏订单
is_um bool 是否Um模式订单

查询条件单记录

GET /v1/stop_orders

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/stop_orders?currency=BTC&instrument_id=BTC-PERPETUAL&status=open&timestamp=1590667739793&signature=14c522605de563064ae36933604225730a8b4e254be8ce58ecc2746f5199d77f" 


返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "stop_order_id": "stop-br7lik3752cq6kouf9ng",
        "created_at": 1590647120000,
        "updated_at": 1590647120000,
        "status": "open",
        "stop_price": "9300.00000000",
        "trigger_type": "last-price",
        "instrument_id": "BTC-PERPETUAL",
        "user_id": "51140",
        "qty": "60.00000000",
        "price": "9200.00000000",
        "side": "buy",
        "type": "stop-limit",
        "time_in_force": "gtc",
        "source": "api",
        "hidden": false
    }]
}

查询条件单记录.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
instrument_id string false "" 产品名称
status string false "" 条件单状态
start_time integer false 起始时间戳
end_time integer false 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
stop_order_id string 止盈止损订单ID (带前缀"stop-")
created_at integer 创建时间戳
updated_at integer 更新时间戳
instrument_id string 产品名称
qty string 订单数量
price string 触发后的订单价格
side string 订单方向
order_type string 订单类型
stop_price string 触发条件价,条件单此参数有效。
time_in_force string 生效时间
status string 条件单状态
trigger_type string 以最新成交价触发
user_id string 用户ID
source string 订单来源
hidden bool 是否隐藏订单

查询用户交易记录

GET /v1/user/trades

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/user/trades?currency=BTC&category=option&instrument_id=BTC-22MAY20-7500-C&order_id=17551020&start_time=1585270800000&end_time=1589522084000&offset=1&limit=10&timestamp=1589523590679&signature=c4788e3a77b6000424b55067f9ba38009b34d12e482b1c80186756857c869bb5" 


返回数据

{
    "code": 0,
    "message": "",
    "data": [{
        "trade_id": "23210268",
        "order_id": "17551020",
        "instrument_id": "BTC-22MAY20-7500-C",
        "qty": "2.00000000",
        "price": "0.17550000",
        "sigma": "0.00000000",
        "underlying_price": "9471.25000000",
        "index_price": "9469.81000000",
        "usd_price": "1661.95165500",
        "fee": "0.00100000",
        "fee_rate": "0.00050000",
        "side": "buy",
        "created_at": 1589521371000,
        "is_taker": true,
        "order_type": "limit",
        "label": "hedge"
    }]
}

查询用户交易记录.

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
category string false "" 产品种类
instrument_id string false "" 产品名称
order_id string false "" 订单ID
start_time integer false 起始时间戳
end_time integer false 结束时间戳
start_id integer false 起始Trade ID
end_id integer false 结束Trade ID
count int false 1 返回条数, max 1000

返回数据

字段名称 数据类型 说明
order_id string 订单ID
trade_id string 交易ID
instrument_id string 产品名称
created_at integer 创建时间戳
order_type string 订单类型
side string 订单方向
price string 成交价格
qty string 成交数量
fee string 手续费
fee_rate string 手续费率
sigma string 隐含波动率(期权订单)
is_taker boolean 是否taker
index_price string 指数价格
underlying_price string 标的价格
usd_price string USD 价格(期权订单)
label string 订单label

查询预估保证金

GET /v1/margins

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/margins?instrument_id=BTC-29MAY20-7500-C&price=0.08&qty=3&timestamp=1588932548594&signature=d642b046b247bf00ba285bb260582aadf33e98d2b47d26479b99cc1a7941f807" 

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "buy_margin": "0.00018326",
        "buy_margin_ccy": "0.00048299",
        "buy_margin_usdt": "19.98670096",
        "sell_margin": "0.0.00087369",
        "sell_margin_ccy": "0.00040010",
        "sell_margin_usdt": "16.55661412",
        "min_sell": "40799.50000000",
        "max_buy": "42042.50000000",
        "usdt_index_price": "41381.19000000"
    }
}

查询预估保证金.

请求参数

字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
price string true "" 订单价格
qty string true "" 订单数量

返回数据

字段名称 数据类型 说明
buy_margin string 预估买单保证金
buy_margin_ccy string UM模式预估买单保证金
buy_margin_usdt string UM模式预估买单保证金, USDT计价 ( = buy_margin_ccy * usdt_index_price)
sell_margin string 预估卖单保证金
sell_margin_ccy string UM模式预估卖单保证金
sell_margin_usdt string UM模式预估卖单保证金, USDT计价 ( = sell_margin_ccy * usdt_index_price)
min_sell string 最小卖出价格
max_buy string 最大买入价格
usdt_index_price string USDT 指数价格

Block Trade


新增 block trade 下单

POST /v1/blocktrades

# <bt_source> should be replaced with real bt_source

curl -X POST "https://betaapi.bitexch.dev/v1/blocktrades" -H "Content-Type: application/json" -H "X-Bit-Access-Key: ak-df074cbc-dbf7-46f9-b07c-f4f51763ac7a"  -d '{"currency": "BTC", "label": "e8db3a92b94c482bb0e30f421415982d", "role": "maker", "counterparty": "1026", "bt_source": "<bt_source>", "trades": [{"instrument_id": "BTC-25SEP20-9000-C", "price": "0.18", "qty": "10", "side": "sell"}, {"instrument_id": "BTC-PERPETUAL", "price": "9300", "qty": "5000", "side": "buy"}], "timestamp": 1594447520876, "signature": "7e8b0e7987fcb282b691d9e87c5afa9af578ed0c464190ca1fa466d18c17adde"}' 


返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "label": "e8db3a92b94c482bb0e30f421415982d",
        "status": "pending"
    }
}

新增 block trade 下单。
Label: block trade唯一标签, 买卖双方用同一个标签ID来标记同一笔交易。
买卖双方调用/v1/blocktrades, 使用同一个标签,订单列表的产品,价格相同,方向相反。
Block trade 请求有效时间为1 分钟, 另一方超过时间没有回应,请求就会超时。
Block trade bt_source 是 Bit.com 指定的来源, 具体请联系Bit.com。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
bt_source string true "" Block trade 来源 (Bit.com 指定的来源)
label string true "" block trade唯一标签
role string true "" 角色: taker/maker
counterparty string true "" 对方的用户ID
trades array true Block trade订单列表
字段名称 数据类型 是否必填 默认值 说明
instrument_id string true "" 产品名称
side string true "" 订单方向: buy/sell
price string true "" 订单价格
qty string true "" 订单数量

返回数据

字段名称 数据类型 说明
label string Block trade 标签
status string Block trade 状态: pending/filled/rejected/expired

查询block trades

GET /v1/blocktrades

# <bt_source> should be replaced with real bt_source

curl -H "X-Bit-Access-Key: ak-df074cbc-dbf7-46f9-b07c-f4f51763ac7a" "https://betaapi.bitexch.dev/v1/blocktrades?currency=BTC&bt_source=<bt_source>&timestamp=1594447524043&signature=12b1090ea6432e71f2f6d01c6f08f0ff30e3765791ebff87b4183964643d61d2" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "block_order_id": "56",
            "label": "8c5d90b6cbd744ceab49d0e66b8fda68",
            "created_at": 1613637677061,
            "updated_at": 1613637678593,
            "user_id": "51140",
            "counterparty": "481554",
            "instrument_id": "BTC-PERPETUAL",
            "side": "buy",
            "price": "51000.00000000",
            "qty": "1000.00000000",
            "fee": "0.00000392",
            "status": "filled",
            "role": "maker",
            "bt_source": "<bt_source>",
            "order_id": "6325142",
            "trade_id": "1299120841",
            "index_price": "51723.49000000",
            "sigma": "0.00000000"
        }   
    ]
}

查询指定用户的block trades信息和状态。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
bt_source string true "" Block trade 来源
instrument_id string false "" 产品名称
label string false "" Block trade标签
start_time integer false 起始时间戳
end_time integer false 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
block_order_id string Block 订单ID
label string Block trade标签
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
counterparty string 对方的用户ID
instrument_id string 产品名称
side string 订单方向
price string 订单价格
qty string 订单数量
fee string 手续费
status string 状态
role string 订单角色 (taker/maker)
bt_source string Block trade 来源
order_id string 场内订单ID
trade_id string 场内成交ID
index_price string 指数价格
sigma string 隐含波动率(期权订单)

查询平台的block trades

GET /v1/platform_blocktrades

# <bt_source> should be replaced with real bt_source

curl -H "X-Bit-Access-Key: ak-df074cbc-dbf7-46f9-b07c-f4f51763ac7a" "https://betaapi.bitexch.dev/v1/platform_blocktrades?currency=BTC&bt_source=<bt_source>&timestamp=1594448745124&signature=39078700dbe556df7f34dd6e0fb444b4ead9ef6ddc8e5b24c76555b6758c68d2" 

返回数据

{
    "code": 0,
    "message": "",
    "data": [
        {
            "block_order_id": "56",
            "label": "8c5d90b6cbd744ceab49d0e66b8fda68",
            "created_at": 1613637677061,
            "updated_at": 1613637678593,
            "user_id": "51140",
            "counterparty": "481554",
            "instrument_id": "BTC-PERPETUAL",
            "side": "buy",
            "price": "51000.00000000",
            "qty": "1000.00000000",
            "fee": "0.00000392",
            "status": "filled",
            "role": "maker",
            "bt_source": "<bt_source>",
            "order_id": "6325142",
            "trade_id": "1299120841",
            "index_price": "51723.49000000",
            "sigma": "0.00000000"
        }   
    ]
}

查询该平台所有相关的block trades信息。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种
bt_source string true "" Block trade 来源
instrument_id string false "" 产品名称
label string false "" Block trade标签
taker string false "" Taker
maker string false "" Maker
start_time integer false 起始时间戳
end_time integer false 结束时间戳
offset int false 1 分页偏移(第一页为1)
limit int false 100 分页大小

返回数据

字段名称 数据类型 说明
block_order_id string Block 订单ID
label string Block trade标签
created_at integer 创建时间戳
updated_at integer 更新时间戳
user_id string 用户ID
counterparty string 对方的用户ID
instrument_id string 产品名称
side string 订单方向
price string 订单价格
qty string 订单数量
fee string 手续费
status string 状态
role string 订单角色 (taker/maker)
bt_source string Block trade 来源
order_id string 场内订单ID
trade_id string 场内成交ID
index_price string 指数价格
sigma string 隐含波动率(期权订单)

查询blocktrade用户信息

GET /v1/user/info

curl -H "X-Bit-Access-Key: ak-77fd5728-e7d4-4174-991a-6e9b8f5887e6" "https://betaapi.bitexch.dev/v1/user/info?timestamp=1613713263340&signature=038be893be10e51b7545abacbf669e7569b7de2dcb2693c33f4aa29c956a611a" 

返回数据

{
    "code": 0,
    "message": "",
    "data": {
        "user_id": "10031"
    }
}

查询用户信息(只需要blocktrade权限).
有"read"权限的API key应该使用GET /v1/accounts.

请求参数

None

返回数据

字段名称 数据类型 说明
user_id string 用户ID

钱包

提现

POST /v1/wallet/withdraw

curl -X POST "https://betaapi.bitexch.dev/v1/wallet/withdraw" -H "Content-Type: application/json" -H "X-Bit-Access-Key: Your Access Key" -d '{"currency": "BTC", "address": "Your address", "amount": "1.2", "pwd": "Your password", "timestamp": 1589523989378, "signature": "signature"}'

Response


{
    "code": 0,
    "message": "",
    "data": {
        "withdraw_id": "b61c2b93-8a25-44d4-9715-023cce61dc50"
    }
}

用于申请提取资金。提现地址首先要在bit.com网站的提现页面 设置为白名单地址。资金密码pwd字段需要通过base64(sha256(pwd))进行编码。例如,假设密码是123456,编码后的密码为“jZae727K08KaOmKSgOaGzww/XVqGr/PKEgIMkjrcbJI=”

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency string true "" 币种, BTC
address string true "" 提现的目标地址
amount string true "" 提现金额
pwd string true "" 资金密码

返回数据

字段名称 数据类型 说明
withdraw_id string 提现订单ID, 可用于后续的查询

查询提现状态

GET /v1/wallet/withdraw

curl -H "X-Bit-Access-Key: Your Access Key" "https://betaapi.bitexch.dev/v1/wallet/withdraw?withdraw_id=b61c2b93-8a25-44d4-9715-023cce61dc50&timestamp=1589522687689&signature=signature"

Response


{
    "code": 0,
    "data": {
        "address": "mfaFpdVCb6UFS5AXUhC8VGXgj9dnJ37nLP",
        "amount": "0.001",
        "code": 0,
        "confirmations": 0,
        "currency": "BTC",
        "fee": "0.00001",
        "state": "unconfirmed",
        "transaction_id": "52e1537002f51acbf5f52b9dfeab6a9e7cc185a669cda2573e768420b0839523",
        "created_at": 1608606000000,
        "updated_at": 1608606000000,
        "is_onchain": true

    },
    "message": ""
}

根据提现订单ID查询提现状态。

请求参数

字段名 类型 是否必填 默认值 说明
withdraw_id String true "" 提现订单ID

返回数据

字段名 类型 说明
code int 错误码,0代表正常,其他值代表失败
state string 提现状态说明
address string 提现目标地址
amount string 提现金额
confirmations int 确认数,如果是内部地址,由于不会上链,一直为0
currency string 币种
fee string 提现手续费
transaction_id string 链上交易hash
created_at int 订单创建时间
updated_at int 订单更新时间
is_onchain bool 订单是否上链

查询提现记录

GET /v1/wallet/withdrawals

curl -H "X-Bit-Access-Key: Your Access Key" "https://betaapi.bitexch.dev/v1/wallet/withdrawals?currency=BTC&count=10&offset=0&timestamp=1589522687689&signature=signature"

Response


{
    "code": 0,
    "data": {
        "count": 2,
        "items": [{
            "address": "mfaFpdVCb6UFS5AXUhC8VGXgj9dnJ37nLP",
            "amount": "0.001",
            "code": 0,
            "confirmations": 0,
            "currency": "BTC",
            "fee": "0.00001",
            "state": "confirmed",
            "transaction_id": "52e1537002f51acbf5f52b9dfeab6a9e7cc185a669cda2573e768420b0839523",
            "created_at": 1608606000000,
            "updated_at": 1608606000000,
            "is_onchain": true
        }, {
            "address": "mfaFpdVCb6UFS5AXUhC8VGXgj9dnJ37nLP",
            "amount": "0.11",
            "code": 13100100,
            "confirmations": 0,
            "currency": "BTC",
            "fee": "0.00001",
            "state": "rejected",
            "transaction_id": "",
            "created_at": 1608606000000,
            "updated_at": 1608606000000,
            "is_onchain": false
        }]
    }
}

查询指定币种的提现记录。

请求参数

字段名称 数据类型 是否必填 默认值 说明
currency String true "" 币种
count int false 10 分页大小,最大50
offset int false 0 分页偏移

返回数据

字段名称 数据类型 说明
code int 错误码,0代表正常,其他值代表失败
state string 提现状态说明
address string 提现目标地址
amount string 提现金额
confirmations int 确认数,如果是内部地址,由于不会上链,一直为0
currency string 币种
fee string 提现手续费
transaction_id string 链上交易哈希
created_at int 订单创建时间
updated_at int 订单更新时间
is_onchain bool 订单是否上链

查询充值记录

GET /v1/wallet/deposits

curl -H "X-Bit-Access-Key: Your Access Key" "https://betaapi.bitexch.dev/v1/wallet/deposits?currency=BTC&count=10&offset=0&timestamp=1589522687689&signature=signature"

Response


{
    "code": 0,
    "data": {
        "count": 1,
        "items": [{
            "address": "mfaFpdVCb6UFS5AXUhC8VGXgj9dnJ37nLP",
            "amount": "0.001",
            "code": 0,
            "confirmations": 0,
            "currency": "BTC",
            "state": "confirmed",
            "transaction_id": "52e1537002f51acbf5f52b9dfeab6a9e7cc185a669cda2573e768420b0839523",
            "created_at": 1608606000000,
            "updated_at": 1608606000000,
            "is_onchain": true
        }]
    }
}

查询指定币种的充值记录。

请求参数

字段名 类型 是否必填 默认值 说明
currency String true "" 币种
count int false 10 分页大小,最大50
offset int false 0 分页偏移

返回数据

字段名称 数据类型 说明
code int 错误码,0代表正常,其他值代表失败
state string 充值状态说明
address string 充值地址
amount string 充值金额
confirmations int 确认数,如果是内部地址,由于不会上链,一直为0
currency string 币种
transaction_id string 链上交易hash
created_at int 订单创建时间
updated_at int 订单更新时间
is_onchain bool 订单是否上链

Websocket 数据订阅

数据订阅基于websocket协议。用户可以在建立websocket连接后发送请求订阅数据。

连接建立后如果30秒内没有订阅任何数据,系统将关闭该连接。

所有订阅数据按以下结构返回。

字段名称 类型 说明
channel string 频道名称
timestamp integer 时间戳(服务器返回时间)
data object 数据内容
module string [inverse, um] 订阅数据所属模块

订阅管理

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-6000-P",
        "BTC-26JUN20-6000-C",
        "BTC-26JUN20-7000-P",
        "BTC-26JUN20-7000-C",
        "BTC-26JUN20-8000-C"
    ],
    "channels":[
        "depth",
        "ticker",
        "kline.5",
        "order",
        "account"
    ],
    "currencies":[
        "BTC"
    ],
    "categories":[
        "option"
    ],
    "interval": "100ms",
    "token":"be4ffcc9-2b2b-4c3e-9d47-68bf062cf651"
}

Response (success)

{
    "channel":"subscription",
    "timestamp":1587921122970,
    "data":{
        "code":0,
        "subscription":[
            "depth",
            "ticker",
            "kline.5"
        ]
    }
}

Response (failure)

{
    "channel":"subscription",
    "timestamp":1587921122970,
    "data":{
        "code":13200302,
        "message":"auth failed: invalid token"
    }
}

websocket连接建立后,用户可以发送请求订阅频道以获取相应的数据推送。频道分为公共频道和私有频道,私有频道首次订阅前需要先获取认证token,填入订阅请求,鉴权通过后就能收到数据推送。

每个频道有不同的订阅参数,订阅时需根据频道订阅要求填写相应的参数,详情参考后面的频道说明。

用户可以通过设置参数interval控制推送频率。当设置为raw时,频道有数据更新立刻就会推送。当设置为100ms时,则会把该频道100ms内的更新聚合后推送。当设置为fixed100ms时,按100ms固定时间间隔进行推送(仅部分频道支持)。

订阅后会收到订阅结果。当订阅请求包含多个频道,而其中部分订阅失败时,将返回两条消息:一条是订阅失败的原因,一条是成功订阅的频道列表。

当不再需要订阅某个频道数据时,用户可以发送取消订阅请求来实现。

请求参数

字段名称 类型 说明
type string [subscribe, unsubscribe]
channels string[] 频道列表
currencies string[] 币种列表
categories string[] 产品种类列表
instruments string[] 产品名称列表
interval string [raw, 100ms, fixed100ms] 默认为raw
token string 订阅私有频道的认证token

关于interval参数设置

返回数据

字段名称 类型 说明
code integer 0表示成功, 非0表示失败
message string 错误消息,订阅失败时返回
subscription string[] 订阅成功的频道列表

获取认证Token

GET /v1/ws/auth

Request

curl -H "X-Bit-Access-Key: ak-ba3bd026-29e6-443b-8eb6-d2ea3b607113" "https://betaapi.bitexch.dev/v1/ws/auth?timestamp=1588996062516&signature=9ed1dd821cc6464d2cfc5bf9614df1f22611c977b513e1ffde864a673b6915f0" 

Response

{
    "code":0,
    "message":"",
    "data":{
        "token":"be4ffcc9-2b2b-4c3e-9d47-68bf062cf651"
    }
}

订阅私有频道需要先通过本接口(REST)获取认证token,然后将其填入websocket的订阅请求。

token只能使用一次,服务器验证后即丢弃,所以没有被盗用风险,重连需要重新申请token。

每个连接只需要鉴权一次,鉴权通过后新的订阅请求无需再填写token(后续private请求中的token会被丢弃,因此不同用户不能共享同一个private websocket连接)。

查询参数

None

返回数据

字段名称 类型 说明
token string 私有频道认证token

心跳

协议标准

根据RFC 6455, websocket协议实现了PING/PONG消息,用以确认websocket连接保持活动状态。

服务器每分钟通过websocket连接向客户端发送PING消息,客户端收到后应答PONG。如果服务器在一分钟内没收到PONG,则认为连接不正常将连接关闭。

客户端也可向服务器发送PING消息,通过检测是否收到PONG,确认该连接数据收发正常。

PING或者PONG都是控制帧。PING消息的opcode为0x9,PONG消息的opcode为0xA。可参考Websocket协议说明

自定义PING/PONG

由于部分客户端封装所限不支持按需发送控制帧,因此在协议标准外提供了一套自定义基于payload的PING/PONG。详细参考“Websocket RPC - PING”

频道目录

频道名称 权限 订阅参数 说明
depth public instruments 市场深度数据的快照和增量变化
order_book.{group}.{depth} public instruments 指定层数的订单簿快照
depth1 public instruments 订单簿的第一层价格
ticker public instruments 市场最新成交价格和最近24小时交易统计信息
kline.{timeframe} public instruments K线数据
trade public instruments 指定产品的最新成交信息
market_trade public categories + currencies 市场上所有期权或期货产品的最新成交信息
index_price public currencies 指定币种对USD交易对的指数价格
mark_price public instruments 指定产品的标记价格
account private currencies 用户的账户信息
um_account private UM账户信息
position private categories + currencies 用户的仓位信息
order private categories + currencies 用户的订单信息
user_trade private categories + currencies 用户的交易信息
mmp_frozen private currencies MMP冻结事件

市场深度频道(depth)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-7000-P"
    ],
    "channels":[
        "depth"
    ],
    "interval": "100ms"
}

Response (snapshot)

{
    "channel":"depth",
    "timestamp":1587929552250,
    "module":"inverse",
    "data":{
        "type":"snapshot",
        "instrument_id":"BTC-26JUN20-7000-P",
        "sequence":9,
        "bids":[
            [
                "0.08000000",
                "0.10000000"
            ]
        ],
        "asks":[
            [
                "0.09000000",
                "0.20000000"
            ]
        ]
    }
}

Response (update)

{
    "channel":"depth",
    "timestamp":1587930311331,
    "module":"inverse",
    "data":{
        "type":"update",
        "instrument_id":"BTC-26JUN20-7000-P",
        "sequence":10,
        "prev_sequence":9,
        "changes":[
            [
                "sell",
                "0.08500000",
                "0.10000000"
            ]
        ]
    }
}

depth频道推送市场深度的快照和增量变化,包括snapshotupdate两种类型的消息。snapshot类型表示当前订单簿的快照,update类型表示深度变更信息。

订阅成功后将首先发送一个快照消息,再发送深度变更消息。当出现异常时会重新发送快照消息。

快照消息包括买价和卖价价格深度,每一层深度由价格和数量组成。

更新消息包含sequenceprev_sequencesequence表示本次更新序号,prev_sequence表示前一次更新序号。如果前一次更新序号等于上一条消息的本次更新序号,则意味着没有消息丢失。

更新消息的变更列表,每一个变更都由方向、价格和数量组成。当数量为0时表示从订单簿中删除该层。

频道信息

频道名称 权限 订阅参数 推送频率
depth public instruments [raw, 100ms]

返回数据

字段名称 类型 说明
type string [snapshot, update]两种类型:快照、深度变更
instrument_id string 产品名称
sequence integer 订单簿更新序号
asks array of [price, quantity] 卖价, price(价格)和quantity(数量)都是string类型。仅快照类型消息返回
bids array of [price, quantity] 买价, price(价格)和quantity(数量)都是string类型。仅快照类型消息返回
prev_sequence integer 前1次消息的更新序号。仅更新类型消息返回
changes array of [side, price, quantity] 深度更新列表。side(方向)、price(价格)、quantity(数量)都是string类型。数量为0表示删除该层。仅更新类型消息返回

订单簿频道(order_book)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-7000-C"
    ],
    "channels":[
        "order_book.10.10"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"order_book.10.10",
    "timestamp":1587930311331,
    "module":"inverse",
    "data":{
        "instrument_id":"BTC-26JUN20-7000-C",
        "sequence":3,
        "timestamp":1587930311330,
        "asks":[
            [
                "0.00300000",
                "0.20000000"
            ]
        ],
        "bids":[
            [
                "0.00200000",
                "0.50000000"
            ],
            [
                "0.00100000",
                "0.30000000"
            ]
        ]
    }
}

order_book频道根据指定的聚合倍数和深度层数,按价格聚合后,推送指定层数的订单簿快照。

订单簿包括买价和卖价深度,每一层深度由价格和数量组成。

频道信息

频道名称 权限 订阅参数 推送频率
order_book.{group}.{depth} public instruments [raw, 100ms,fixed100ms]

订阅order_book频道需要在频道名称中指定聚合倍数group和深度层数depth

group取值:1, 5, 10,100,1000。group表示按最小价格单位进行聚合的倍数,取值1即不聚合。BTC期权产品的最小价格单位为0.0001,那么填入10时,将按照0.001进行聚合。

depth取值:1, 10, 20,100。depth表示返回订单簿的层数。

如果不填写聚合倍数和深度层数,则默认返回不聚合、10层的订单簿,即默认group=1、depth=10。

返回数据

字段名称 类型 说明
instrument_id string 产品名称
sequence integer 订单簿更新序号
timestamp integer 订单簿更新时间戳
asks array of [price, quantity] 卖价, price(价格)和quantity(数量)都是string类型
bids array of [price, quantity] 买价, price(价格)和quantity(数量)都是string类型

一层价格频道(depth1)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-7000-P"
    ],
    "channels":[
        "depth1"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"depth1",
    "timestamp":1587932635873,
    "module":"inverse",
    "data":{
        "instrument_id":"BTC-26JUN20-7000-P",
        "asks":[
            [
                "0.08500000",
                "0.10000000"
            ]
        ],
        "bids":[
            [
                "0.08000000",
                "0.10000000"
            ]
        ]
    }
}

depth1频道推送1层的买价/卖价信息。

频道信息

频道名称 权限 订阅参数 推送频率
depth1 public instruments [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
asks array of [price, quantity] 卖价, price(价格)和quantity(数量)都是string类型。返回0或1层
bids array of [price, quantity] 买价, price(价格)和quantity(数量)都是string类型。返回0或1层

市场交易信息统计频道(ticker)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-5000-C"
    ],
    "channels":[
        "ticker"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"ticker",
    "timestamp":1589126498813,
    "module":"inverse",
    "data":{
        "time":1589126498813,
        "instrument_id":"BTC-26JUN20-5000-C",
        "best_bid":"0.50200000",
        "best_ask":"0.50500000",
        "best_bid_qty":"2.30000000",
        "best_ask_qty":"0.80000000",
        "ask_sigma":"2.22748567",
        "bid_sigma":"2.18964114",
        "last_price":"0.50500000",
        "last_qty":"0.10000000",
        "open24h":"0.50500000",
        "high24h":"0.50500000",
        "low24h":"0.50500000",
        "price_change24h":"",
        "volume24h":"0.10000000",
        "open_interest":"289.50000000",
        "underlying_name":"BTC-26JUN20",
        "underlying_price":"8616.02000000",
        "mark_price":"0.43989364",
        "sigma":"1.29049244",
        "delta":"0.92073799",
        "vega":"4.54807454",
        "theta":"-6.28858194",
        "gamma":"0.00003713",
        "min_sell":"0.38950000",
        "max_buy":"0.49000000"
    }
}

ticker频道推送市场最新成交价格和最近24小时交易统计信息。

频道信息

频道名称 权限 订阅参数 推送频率
ticker public instruments [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
last_price string 最新成交价
last_qty string 最新成交量
open24h string 24小时开盘价
high24h string 24小时最高价
low24h string 24小时最低价
volume24h string 24小时成交量
price_change24h string 24小时价格变动
open_interest string 未平仓量
best_bid string 最佳买入价
best_ask string 最佳卖出价
best_bid_qty string 最佳买入数量
best_ask_qty string 最佳卖出数量
bid_sigma string 买入sigma (期权)
ask_sigma string 卖出sigma (期权)
underlying_name string 标的指数(期权)
underlying_price string 标的指数价格(期权)
funding_rate string 资金费率 (永续)
funding_rate8h string 过去8小时的平均资金费率 (永续)
mark_price string 标记价格
sigma string 标记价格sigma值(期权)
delta string 标记价格delta值(期权)
vega string 标记价格vega值(期权)
theta string 标记价格theta值(期权)
gamma string 标记价格gamma值(期权)
max_buy string 最大买入价
min_sell string 最小卖出价

K线频道(kline)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-PERPETUAL"
    ],
    "channels":[
        "kline.5"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"kline.5",
    "timestamp":1587979850118,
    "module":"inverse",
    "data":{
        "instrument_id":"BTC-PERPETUAL",
        "tick":1587979800000,
        "open":"7737.50000000",
        "low":"7737.50000000",
        "high":"7737.50000000",
        "close":"7737.50000000",
        "volume":"0.00000000"
    }
}

kline频道推送K线数据。如果在当前周期内没有发生过交易,则开盘价、收盘价、最高价、最低价会以前一个周期的收盘价填充。

频道信息

频道名称 权限 订阅参数 推送频率
kline.{timeframe} public instruments [raw, 100ms]

订阅kline频道需要在频道名称中指定K线周期timeframe

resolution取值:1, 3, 5, 15, 30, 60, 120, 240, 360, 720, 1440, 1w, 1m

resolution表示K线的周期,单位是分钟。例如1表示1分钟线,1440表示日线。

返回数据

字段名称 类型 说明
instrument_id string 产品名称
tick integer 统计周期开始时间
open string 开盘价
close string 收盘价
high string 最高价
low string 最低价
volume string 成交量

交易频道(trade)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-6000-P"
    ],
    "channels":[
        "trade"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"trade",
    "timestamp":1588997059735,
    "module":"inverse",
    "data":[
        {
            "trade_id":"2388418",
            "instrument_id":"BTC-26JUN20-6000-P",
            "price":"0.01800000",
            "qty":"0.10000000",
            "side":"buy",
            "sigma":"1.15054346",
            "option_type":"put",
            "is_block_trade":false,
            "created_at":1588997060000
        }
    ]
}

trade频道推送指定产品的最新成交信息。

频道信息

频道名称 权限 订阅参数 推送频率
trade public instruments [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
trade_id string 交易ID
price string 成交价格
qty string 成交数量
side string Taker方向
sigma string 隐含波动率 (期权)
option_type string 期权类型 (期权)
is_block_trade boolean 是否block trade
created_at integer 成交时间戳

市场交易频道(market_trade)

Request

{
    "type":"subscribe",
    "channels":[
        "market_trade"
    ],
    "currencies":[
        "BTC"
    ],
    "categories":[
        "option"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"market_trade",
    "timestamp":1588997059735,
    "module":"inverse",
    "data":[
        {
            "trade_id":"2388418",
            "instrument_id":"BTC-26JUN20-6000-P",
            "price":"0.01800000",
            "qty":"0.10000000",
            "side":"buy",
            "sigma":"1.15054346",
            "option_type":"put",
            "is_block_trade":false,
            "created_at":1588997060000
        }
    ]
}

market_trade频道推送市场上所有期权或期货产品的最新成交信息。

频道信息

频道名称 权限 订阅参数 推送频率
market_trade public categories + currencies [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
trade_id string 交易ID
price string 成交价格
qty string 成交数量
side string Taker方向
sigma string 隐含波动率 (期权)
option_type string 期权类型 (期权)
is_block_trade boolean 是否block trade
created_at integer 成交时间戳

指数价格频道(index_price)

Request

{
    "type":"subscribe",
    "channels":[
        "index_price"
    ],
    "currencies":[
        "BTC"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"index_price",
    "timestamp":1588997560081,
    "module":"inverse",
    "data":{
        "index_name":"BTC_USD",
        "index_price":"9866.66000000"
    }
}

index_price频道推送指定币种对USD的指数价格。

频道信息

频道名称 权限 订阅参数 推送频率
index_price public currencies [raw, 100ms]

返回数据

字段名称 类型 说明
index_name string 指数名称
index_price string 指数价格

标记价格频道(mark_price)

Request

{
    "type":"subscribe",
    "instruments":[
        "BTC-26JUN20-10000-C"
    ],
    "channels":[
        "mark_price"
    ],
    "interval": "100ms"
}

Response

{
    "channel":"mark_price",
    "timestamp":1588997840512,
    "module":"inverse",
    "data":{
        "instrument_id":"BTC-26JUN20-10000-C",
        "mark_price":"0.11006342",
        "sigma":"0.79384700",
        "delta":"0.54298511",
        "vega":"14.25666243",
        "theta":"-11.75126302",
        "gamma":"0.00013900"
    }
}

mark_price频道推送指定产品的标记价格。

频道信息

频道名称 权限 订阅参数 推送频率
mark_price public instruments [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
mark_price string 标记价格
sigma string 标记价格sigma值(期权)
delta string 标记价格delta值(期权)
vega string 标记价格vega值(期权)
theta string 标记价格theta值(期权)
gamma string 标记价格gamma值(期权)

账户信息频道(account)

Request

{
    "type":"subscribe",
    "channels":[
        "account"
    ],
    "currencies":[
        "BTC"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response

{
    "channel":"account",
    "timestamp":1589031930115,
    "module":"inverse",
    "data":{
        "user_id":"53345",
        "currency":"BTC",
        "cash_balance":"9999.94981346",
        "available_balance":"9999.90496213",
        "margin_balance":"9999.94981421",
        "initial_margin":"0.04485208",
        "maintenance_margin":"0.00000114",
        "equity":"10000.00074364",
        "pnl":"0.00746583",
        "total_delta":"0.06207078",
        "account_id":"8",
        "mode":"regular",
        "session_upl":"0.00081244",
        "session_rpl":"0.00000021",
        "option_value":"0.05092943",
        "option_pnl":"0.00737943",
        "option_session_rpl":"0.00000000",
        "option_session_upl":"0.00081190",
        "option_delta":"0.11279249",
        "option_gamma":"0.00002905",
        "option_vega":"4.30272923",
        "option_theta":"-3.08908220",
        "future_pnl":"0.00008640",
        "future_session_rpl":"0.00000021",
        "future_session_upl":"0.00000054",
        "future_session_funding":"0.00000021",
        "future_delta":"0.00955630",
        "created_at":1588997840512,
        "projected_info": {
            "projected_initial_margin": "0.97919888",
            "projected_maintenance_margin": "0.78335911",
            "projected_total_delta": "3.89635553"
        }
    }
}

经典用户,订阅account频道推送用户的账户信息。

频道信息

频道名称 权限 订阅参数 推送频率
account private currencies [raw, 100ms]

返回数据

字段名称 类型 说明
account_id string 账户ID
mode string 风控模式
available_balance string 可用余额
cash_balance string 现金余额
currency string 币种
equity string 权益
initial_margin string 初始保证金
maintenance_margin string 维持保证金
margin_balance string 保证金余额
pnl string 总损益
total_delta string 账户delta总值
session_rpl string 已实现损益
session_upl string 未实现损益
option_value string 期权市值
option_pnl string 期权损益
option_session_rpl string 期权已实现损益
option_session_upl string 期权未实现损益
option_delta string 期权 delta
option_gamma string 期权 gamma
option_vega string 期权 vega
option_theta string 期权 theta
future_pnl string 期货损益
future_session_rpl string 期货已实现损益
future_session_upl string 期货未实现损益
future_session_funding string 期货 funding
future_delta string 期货 delta
user_id string 用户ID
created_at integer 创建时间戳
projected_info object Projected参数

Projected参数是指下次交割/结算后IM/MM/Delta的预测值

字段名称 类型 说明
projected_initial_margin string 下次交割/结算后的初始保证金
projected_maintenance_margin string 下次交割/结算后的维持保证金
projected_total_delta string 下次交割/结算后的Delta

UM账户信息频道(um_account)

Request

{
    "type":"subscribe",
    "channels":[
        "um_account"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response

{
    "channel":"um_account",
    "timestamp":1632439007081,
    "module":"um",
    "data": {
        "user_id": 1,
        "created_at": 1632642549581,
        "usdt_total_collateral": "200.00000000",
        "usdt_total_margin_balance": "190.00000000",
        "usdt_total_available": "80.00000000",
        "usdt_total_initial_margin": "90.00000000",
        "usdt_total_maintenance_margin": "120.00000000",
        "usdt_total_initial_margin_ratio": "0.60000000",
        "usdt_total_maintenance_margin_ratio": "0.60000000",
        "usdt_total_liability": "8060000.00000000",
        "usdt_total_unsettled_amount": "322143.95604395",
        "spot_orders_hc_loss": "30.00000000",
        "details": [
            {
                "currency": "BTC",
                "equity": "100.00000000",
                "liability": "0.00000000",
                "usdt_index_price": "40000.00000000",
                "cash_balance": "100.00000000",
                "margin_balance": "100.00000000",
                "available_balance": "50.00000000",
                "initial_margin": "20.00000000",
                "spot_margin": "30.00000000",
                "maintenance_margin": "80.00000000",
                "potential_liability": "0.00000000",
                "interest": "1.00000000",
                "interest_rate": "0.01000000",
                "pnl": "0.11538462",
                "total_delta": "0.38461538",
                "session_rpl": "10.00000000",
                "session_upl": "0.11538462",
                "option_value": "0.00000000",
                "option_pnl": "0.00000000",
                "option_session_rpl": "0.00000000",
                "option_session_upl": "0.00000000",
                "option_delta": "0.00000000",
                "option_gamma": "0.00000000",
                "option_vega": "0.00000000",
                "option_theta": "0.00000000",
                "future_pnl": "0.11538462",
                "future_session_rpl": "10.00000000",
                "future_session_upl": "0.11538462",
                "future_session_funding": "10.00000000",
                "future_delta": "0.38461538",
                "future_available_balance": "0.00200000",
                "option_available_balance": "0.00200000",
                "unsettled_amount": "9.11538462"
            },
            {
                "currency": "USDT",
                "equity": "-8000000.00000000",
                "liability": "8000000.00000000",
                "usdt_index_price": "1.00000000",
                "cash_balance": "-8000000.00000000",
                "margin_balance": "-8000000.00000000",
                "available_balance": "0.00000000",
                "initial_margin": "0.00000000",
                "spot_margin": "0.00000000",
                "maintenance_margin": "0.00000000",
                "potential_liability": "8000000.00000000",
                "interest": "300.00000000",
                "interest_rate": "0.00500000",
                "pnl": "0.00000000",
                "total_delta": "0.00000000",
                "session_rpl": "0.00000000",
                "session_upl": "0.00000000",
                "option_value": "0.00000000",
                "option_pnl": "0.00000000",
                "option_session_rpl": "0.00000000",
                "option_session_upl": "0.00000000",
                "option_delta": "0.00000000",
                "option_gamma": "0.00000000",
                "option_vega": "0.00000000",
                "option_theta": "0.00000000",
                "future_pnl": "0.00000000",
                "future_session_rpl": "0.00000000",
                "future_session_upl": "0.00000000",
                "future_session_funding": "0.00000000",
                "future_delta": "0.00000000",
                "future_available_balance": "0.00000000",
                "option_available_balance": "0.00000000",
                "unsettled_amount": "-300.00000000"
            }
        ]
    }
}

统一用户,订阅um_account频道推送统一保证金用户的账户信息。

频道信息

频道名称 权限 订阅参数 推送频率
um_account private [raw, 100ms]

返回数据

字段名称 类型 说明
user_id int 用户ID
created_at int 时间戳(查询时刻)
usdt_total_collateral string 账户维度USDT总担保品金额
usdt_total_margin_balance string 账户维度USDT总保证金余额
usdt_total_available string 账户维度USDT总可用余额
usdt_total_initial_margin string 账户维度USDT总初始保证金
usdt_total_maintenance_margin string 账户维度USDT总维持保证金
usdt_total_initial_margin_ratio string 账户维度USDT总初始保证金率,可能会返回"infinity"
usdt_total_maintenance_margin_ratio string 账户维度USDT总维持保证金率,可能会返回"infinity"
usdt_total_liability string 账户维度USDT总负债
usdt_total_unsettled_amount string 账户维度USDT总待结金额
spot_orders_hc_loss string 现货挂单损失
details array of Detail 分币种账户信息
字段名称 类型 说明
currency string 币种
equity string 权益
liability string 负债
usdt_index_price string USDT指数价格
cash_balance string 现金余额
margin_balance string 保证金余额
available_balance string 可用余额
initial_margin string 始初保证金
spot_margin string 现货冻结金额
maintenance_margin string 维持保证金
potential_liability string 潜在负债
interest string 借币利息
interest_rate string 借币利率
pnl string 总损益
total_delta string 账户delta总值
session_rpl string 已实现损益
session_upl string 未实现损益
option_value string 期权市值
option_pnl string 期权损益
option_session_rpl string 期权已实现损益
option_session_upl string 期权未实现损益
option_delta string 期权delta
option_gamma string 期权gamma
option_vega string 期权vega
option_theta string 期权theta
future_pnl string 期货损益
future_session_rpl string 期货已实现损益
future_session_upl string 期货未实现损益
future_session_funding string 期货funding
future_delta string 期货delta
future_available_balance string 期货最大可用余余额
option_available_balance string 期权最大可用余额
unsettled_amount string 待结金额

用户仓位频道(position)

Request

{
    "type":"subscribe",
    "channels":[
        "position"
    ],
    "currencies":[
        "BTC"
    ],
    "categories":[
        "option"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response (option)

{
    "channel":"position",
    "timestamp":1600743533528,
    "module":"inverse",
    "data":[
        {
            "instrument_id":"BTC-30OCT20-14000-P",
            "qty":"-0.20000000",
            "initial_margin":"0.09735673",
            "maintenance_margin":"0.08235673",
            "avg_price":"0.43800000",
            "session_avg_price":"0.43800000",
            "mark_price":"0.33678364",
            "index_price":"10452.57000000",
            "position_pnl":"0.02024327",
            "position_session_upl":"0.02024327",
            "position_session_rpl":"0.00000000",
            "category":"option",
            "roi":"0.23108759",
            "option_delta":"0.18646500",
            "option_gamma":"-0.00001376",
            "option_vega":"-0.88990013",
            "option_theta":"0.65103919",
        },
        {
            "instrument_id":"BTC-30OCT20-14500-P",
            "qty":"-0.10000000",
            "initial_margin":"0.05522940",
            "maintenance_margin":"0.04772940",
            "avg_price":"0.49700000",
            "session_avg_price":"0.49700000",
            "mark_price":"0.40229400",
            "index_price":"10452.57000000",
            "position_pnl":"0.00947060",
            "position_session_upl":"0.00947060",
            "position_session_rpl":"0.00000000",
            "category":"option",
            "roi":"0.19055534",
            "option_delta":"0.08317211",
            "option_gamma":"-0.00000823",
            "option_vega":"-0.85511325",
            "option_theta":"1.00527001",
        }
    ]
}

Response (future)

{
    "channel":"position",
    "timestamp":1600681824660,
    "module":"inverse",
    "data":[
        {
            "instrument_id":"BTC-PERPETUAL",
            "qty":"100.00000000",
            "initial_margin":"0.00018592",
            "maintenance_margin":"0.00013945",
            "avg_price":"10852.50000000",
            "session_avg_price":"10852.50000000",
            "mark_price":"10758.39435000",
            "index_price":"10704.87000000",
            "qty_base":"0.00929507",
            "liq_price":"0.12199202",
            "session_funding":"-0.00000002",
            "position_pnl":"-0.00008060",
            "position_session_upl":"-0.00008060",
            "position_session_rpl":"-0.00000002",
            "category":"future",
            "roi":"-0.43351632",
            "leverage":"50.00000000"
        }
    ]
}

position频道推送用户的仓位信息。

频道信息

频道名称 权限 订阅参数 推送频率
position private categories + currencies [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
qty string 仓位(期权仓位单位为基础币种, 期货仓位单位为USD)
qty_base string 仓位(基础币种) (期货)
avg_price string 平均成交价
position_pnl string 仓位损益
position_session_upl string 仓位未实现损益
position_session_rpl string 仓位已实现损益
index_price string 指数价格
mark_price string 标记价格
initial_margin string 初始保证金
maintenance_margin string 维持保证金
session_avg_price string 会话平均价
session_funding string 会话funding(永续)
category string 产品种类
roi string 回报率
option_delta string 期权delta
option_gamma string 期权gamma
option_vega string 期权vega
option_theta string 期权theta
liq_price string 预估平仓价(期货)
leverage string 杠杆率(期货)

用户订单频道(order)

Request

{
    "type":"subscribe",
    "channels":[
        "order"
    ],
    "currencies":[
        "BTC"
    ],
    "categories":[
        "option"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response

{
    "channel":"order",
    "timestamp":1587994934089,
    "module":"inverse",
    "data":[
        {
            "order_id":"1590",
            "instrument_id":"BTC-1MAY20-8750-P",
            "qty":"0.50000000",
            "filled_qty":"0.10000000",
            "remain_qty":"0.40000000",
            "price":"0.16000000",
            "avg_price":"0.16000000",
            "side":"buy",
            "order_type":"limit",
            "time_in_force":"gtc",
            "created_at":1587870609000,
            "updated_at":1587870609000,
            "status":"open",
            "fee":"0.00002000",
            "cash_flow":"-0.01600000",
            "pnl":"0.00000000",
            "is_liquidation": false,
            "auto_price":"0.00000000",
            "auto_price_type":"",
            "taker_fee_rate": "0.00050000",
            "maker_fee_rate": "0.00020000",
            "label": "hedge",
            "stop_price": "0.00000000",
            "reduce_only": false,
            "post_only": false,
            "reject_post_only": false,
            "mmp": true,
            "reorder_index": 1
        }
    ]
}

order频道推送用户的订单信息。

频道信息

频道名称 权限 订阅参数 推送频率
order private categories + currencies [raw, 100ms]

返回数据

字段名称 类型 说明
instrument_id string 产品名称
order_id string 订单ID
qty string 订单数量
filled_qty string 成交数量
remain_qty string 持有数量
price string 订单价格
avg_price string 平均成交价
side string 订单方向
order_type string 订单类型
time_in_force string 生效时间
status string 订单状态
fee string 手续费
cash_flow string 现金流
pnl string 损益
auto_price string 自动价格
auto_price_type string 自动价格类型
is_liquidation boolean 是否强平单
taker_fee_rate string Taker 手续费率
maker_fee_rate string Maker 手续费率
label string 自定义标签
stop_price string 触发价(止盈止损单)
reduce_only boolean 是否reduce only单
post_only boolean 是否post only单
reject_post_only boolean 是否reject post only单
mmp boolean 是否 mmp单
reorder_index integer 内部排序使用
created_at integer 创建时间戳
updated_at integer 更新时间戳

用户交易频道(user_trade)

Request

{
    "type":"subscribe",
    "channels":[
        "user_trade"
    ],
    "currencies":[
        "BTC"
    ],
    "categories":[
        "option"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response

{
    "channel":"user_trade",
    "timestamp":1588997059737,
    "module":"inverse",
    "data":[
        {
            "trade_id":2388418,
            "order_id":1384232,
            "instrument_id":"BTC-26JUN20-6000-P",
            "qty":"0.10000000",
            "price":"0.01800000",
            "sigma":"1.15054346",
            "underlying_price":"9905.54000000",
            "index_price":"9850.47000000",
            "usd_price":"177.30846000",
            "fee":"0.00005000",
            "fee_rate":"0.00050000",
            "side":"buy",
            "created_at":1588997060000,
            "is_taker":true,
            "order_type":"limit",
            "is_block_trade":false,
            "label": "hedge"
        }
    ]
}

user_trade频道推送用户的交易信息。

频道信息

频道名称 权限 订阅参数 推送频率
user_trade private categories + currencies [raw, 100ms]

返回数据

字段名称 类型 说明
order_id string 订单ID
trade_id string 交易ID
instrument_id string 产品名称
order_type string 订单类型
side string 订单方向
price string 成交价格
qty string 成交数量
fee string 手续费
fee_rate string 手续费率
sigma string 隐含波动性(期权)
is_taker boolean 是否taker
is_block_trade boolean 是否block trade
index_price string 指数价格
underlying_price string 标的价格(期权)
usd_price string USD 价格(自动价格订单)
label string 用户方订单唯一ID
created_at integer 创建时间戳

MMP冻结事件频道(mmp_frozen)

Request

{
    "type":"subscribe",
    "channels":[
        "mmp_frozen"
    ],
    "currencies":[
        "BTC"
    ],
    "interval": "100ms",
    "token":"6d501ded-3c40-4697-b390-218a54b9de19"
}

Response

{
    "channel":"mmp_frozen",
    "timestamp":1599277666000,
    "module":"inverse",
    "data":{
        "currency":"BTC",
        "frozen_until_ms":1599277929000
    }
}

mmp_frozen频道推送MMP冻结事件。

frozen_until_ms 显示冻结状态。
frozen_until_ms > 0: 冻结到指定时间戳,或者手动reset MMP解冻
frozen_until_ms = 0: 冻结直到reset MMP解冻

频道信息

频道名称 权限 订阅参数 推送频率
mmp_frozen private currencies [raw, 100ms]

返回数据

字段名称 类型 说明
currency string 币种
frozen_until_ms integer MMP冻结时间戳

Websocket RPC

公共数据结构

Request

{
    "type":"RPC_name",
    "token":"If3Fy-o5TiOOTfvlmtryR0MTiziutYaYFkH3aRovJWWEXqCAD7CIdnbhGG5bwRqLRrGkOFEOjh0L",
    "params":{
        "param1":"hello"
    }
}

Response

{
    "type":"RPC_name",
    "result":{
        "code":0,
        "message":"",
        "data":{
            "field1":"world"
        }
    }
}

建立websocket连接后,除了数据订阅,还支持发送JSON格式的RPC请求。

首次发送私有请求需要先通过rest接口获取认证token,然后将token作为请求参数填入进行鉴权,详细参考“Websocket 数据订阅 - 获取认证Token”。

请求参数

字段名称 类型 说明
type string 请求类型
token string 私有请求认证token
params object 请求参数

返回数据

字段名称 类型 说明
type string 请求类型
result object 返回结果

result结构

字段名称 类型 说明
code integer 错误码
message string 错误信息
data object 返回数据

PING

Request

{
    "type":"ping",
    "params":{
        "id":123
    }
}

Response

{
    "type":"pong",
    "result":{
        "code":0,
        "message":"",
        "data":{
            "id":123,
            "timestamp":1632295288253
        }
    }
}

用于检测连接收发数据是否正常。客户端发送PING请求,服务器收到后回复PONG并返回收到PING时的时间戳。

请求信息

名称 访问范围
ping public

请求参数

字段名称 类型 是否必须 说明
id integer 可选 客户端自定义的请求ID,服务器回复时将ID回填到PONG消息中

返回数据

字段名称 类型 说明
id integer 客户端自定义请求ID
timestamp integer 服务器收到PING时的时间戳

设置COD (cancel_on_disconnect)

Request

{
    "type":"cancel_on_disconnect",
    "token":"If3Fy-o5TiOOTfvlmtryR0MTiziutYaYFkH3aRovJWWEXqCAD7CIdnbhGG5bwRqLRrGkOFEOjh0L",
    "params":{
        "scope":"connection",
        "enable":true
    }
}

Response

{
    "type":"cancel_on_disconnect",
    "result":{
        "code":0,
        "message":"",
        "data":""
    }
}

基于连接设置开启/关闭COD (Cancel On Disconnect)。开启COD后,当websocket连接断开时,取消用户所有订单。

与rest接口 POST /v1/account_configs/cod 的差异说明:

请求信息

名称 访问范围
cancel_on_disconnect private

请求参数

字段名称 类型 是否必须 说明
scope string 可选 COD生效范围,目前只支持connection
enable bool 必须 true表示开启,false表示关闭

返回数据

None

常量定义

Account Mode

账户模式 描述
classic 经典模式
um 统一保证金模式
migrating-to-um 模式迁移中: 经典到统保
migrating-to-classic 模式迁移中: 统保到经典

Risk mode

风控模式 描述
regular 普通模式
portfolio_margin PM模式(期权/期货组合保证金模式)

Instrument Category

产品种类 描述
option 期权
future 期货(包括永续)

Option type

期权类型 描述
call 看涨期权
put 看跌期权

Order side

订单方向 描述
buy
sell

Order type

订单类型 描述
limit 限价单
market 市价单
stop-limit 止盈止损单(限价)
stop-market 止盈止损单(市价)
trigger-limit 条件单(限价)
trigger-market 条件单(市价)

Order status

订单状态 描述
pending 订单初始状态
open 订单活跃状态
filled 订单全部成交状态
cancelled 订单撤销状态

StopOrder status

条件单状态 描述
open 条件单活跃状态
triggered 条件单已触发状态
cancelled 条件单已撤销状态

Order time in force

订单有效时间 描述
gtc 一直有效
fok 全部成交,否则将被取消
ioc 立即成交可成交的部分,然后取消剩余部分

Order auto price type

自动价格类型 描述
usd 以USD价格下单
implv 以隐含波动率下单

Transaction log type

交易日志类型 描述
deposit 充币
bad-deposit 充币失败
withdraw 提币
withdraw-revert 撤销提币
trade 交易(买/卖)
delivery 交割
settlement 结算
bankruptcy 爆仓
socialized-fund 均摊

Withdrawal state

提币状态 描述
original 请求已接受
pending 等待
rejected 提币被拒绝
confirmed 确认

Deposit state

充币状态 描述
mempool 交易处于mempool中
pending 等待KYT
rejected 充币被拒绝
confirmed 确认
unconfirmed 交易被打包
rollback 交易被回滚

Order source

订单来源 描述
api API
web 网页UI
app 手机APP

Account Mode

账户模式 描述
classic 经典模式
um 统一保证金模式
migrating-to-um 模式迁移中: 经典到统保
migrating-to-classic 模式迁移中: 统保到经典

UM transaction log type

UM交易日志类型 描述
spot-trade-pay 现货交易-支付
spot-trade-recv 现货交易-收入
deri-trade 币本位期权/期货交易
deri-delivery 币本位期权/期货交割
deri-settlement 币本位期权/期货结算
deri-socialized-fund 币本位期权/期货分摊
usdx-trade U本位期权/期货交易
usdx-delivery U本位期权/期货交割
usdx-settlement U本位期权/期货结算
usdx-socialized-fund U本位期权/期货分摊
pay-accrued-interest 支付利息
um-pex-trade-pay 自动卖币
um-pex-trade-recv 自动买币
deposit 充值
bad-deposit 充值失败
withdraw 提币
withdraw-revert 撤销提币
transfer-in 账户-转入
transfer-out 账户-转出

错误码

错误处理

bit.com trading API 说明:


当调用bit.com的交易API时,例如 下单,编辑订单,取消订单,调用者将获得以下四种结果之一:

  1. 调用成功
  2. 调用失败
  3. 接收到响应,但是不能确定操作是成功还是失败
  4. 不能接收到响应

类型3的结果发生在bit.com的前端Web服务器未能及时从撮合引擎收到响应(由于网络问题或超时)时。 响应的形式可以为

  1. HTTP 响应"504 - Gateway Timeout": 表示故障发生在API网关层面
  2. HTTP 响应"200 - OK", 但是 JSON error code = 18500000: 表示 RPC timeout
  3. 其他形式的网络错误(如果故障发生在到达bit.com的网关之前).

当类型3的结果发生时,调用方将无法确定撮合引擎是否已接收/处理/拒绝了所发送的请求。 因此, 调用方必须发起另一个查询请求,以确认订单或帐户的状态。

Bit.com API 错误码列表:

错误码 描述
0 成功(无错误)
18100100 一般错误
18100101 不合法订单请求
18100102 不合法订单方向
18100103 不合法订单价格
18100104 不合法订单数量
18100105 不合法订单类型
18100106 不合法订单时效
18100107 获取仓位错误
18100109 获取Underlying价格失败
18100110 下单错误
18100111 序列化错误
18100112 提交创建订单请求出错
18100113 不合法订单id
18100114 获取订单错误
18100115 订单没有找到
18100116 提交撤销订单请求出错
18100117 不合法订单状态参数
18100119 获取交易记录错误
18100120 不合法创建期权请求
18100121 计算行权价错误
18100122 创建期权错误
18100123 不合法更新期权请求
18100124 不合法到期日
18100125 获取期权错误
18100126 不合法期权状态
18100127 更新期权错误
18100128 获取到期日错误
18100129 不合法交割价
18100130 期权包含有未结订单
18100131 不合法转账请求
18100132 不合法转账数量
18100133 创建转账请求错误
18100134 获取用户交易记录错误
18100135 获取转账错误
18100137 获取账户错误
18100138 获取交易记录错误
18100139 不合法的期权类型
18100141 不合法的货币
18100142 获取Underlying错误
18100143 获取Ticks错误
18100144 获取标记价格错误
18100145 获取Portfolio Margin错误
18100146 更新账户出错
18100147 获取交易日志错误
18100148 审核账户错误
18100149 交割信息错误
18100150 超过账户最大未结订单数目
18100151 超过品种最大未结订单数目
18100152 获取未结订单数目错误
18100153 创建到期日错误
18100154 更新存取Token出错
18100155 不合法的删除期权请求
18100156 删除期权出错
18100157 不合法的配置
18100158 更新配置错误
18100159 获取手续费率出错
18100160 不合法的参数
18100161 获取Orderbook出错
18100162 获取Index错误
18100163 账户信息错误
18100164 获取用户中心转账出错
18100165 不合法的用户
18100166 风险基金账户出错
18100167 风险日志错误
18100168 费用账户错误
18100169 费用日志错误
18100170 获取交割记录出错
18100171 获取风险数据出错
18100172 不合法的市场深度
18100173 到期错误
18100174 获取Orderbook统计出错
18100175 获取结算记录错误
18100176 获取Trading View数据出错
18100177 获取用户出错
18100178 保存数据出错
18100179 获取Funding图表出错
18100180 不合法的撤销订单请求
18100181 获取产品出错
18100183 获取期货产品出错
18100185 不合法的产品
18100186 平仓请求出错
18100187 获取订单保证金出错
18100188 获取限价价格出错
18100189 不合法的stop价格
18100190 获取未结stop order数目出错
18100191 超过最大stop order数目
18100192 不合法的stop价格
18100193 不合法的stop order触发类型
18100194 保存stop order失败
18100195 删除到期日出错
18100196 获取Funding Rate出错
18100197 不合法的更新到期日请求
18100198 更新到期日出错
18100199 余额不足
18100200 不合法的交易类型
18100201 获取指数数据出错
18100202 不合法的参数
18100204 不合法的分页参数
18100205 获取市场统计量出错
18100206 系统账户错误
18100210 不合法的操作员
18100211 获取接管记录出错
18100212 不合法的操作员用户id
18100213 开始接管
18100214 不合法的账户id
18100215 推出接管
18100216 绑定管理员到账户
18100217 解除绑定管理员到账户
18100218 计算组合保证金
18100223 获取接管订单出错
18100224 不合法的修改订单请求
18100225 自动价格错误
18100226 接管切换用户出错
18100227 账户被锁定
18100228 获取爆仓信息出错
18100229 记录爆仓请求出错
18100230 超过最大stop order数目
18100231 不合法的stop order状态
18100232 邮件验证码错误
18100233 电话验证码错误
18100234 Rpc错误: 非活跃订单
18100235 记录爆仓信息出错
18100236 不合法的订单角色
18100237 没有 Block Order 权限
18100238 自成交错误
18100239 不合法的时间
18100240 不合法的 Block Order 请求
18100241 接受 Block Order 出错
18100242 拒绝 Block Order 出错
18100243 计算期权维持保证金出错
18100244 减仓单错误
18100245 Block Trade 服务停止运行
18100246 获取触发价出错
18100247 获取未结订单挂单量出错
18100248 获取仓位出错
18100249 超过期权最大未结订单数目
18100250 超过期货最大未结订单数目
18100251 体验金请求出错
18100252 体验金错误
18100253 获取体验金出错
18100254 抵扣金请求出错
18100255 抵扣金错误
18100256 获取体验金活跃状态出错
18100257 获取账户配置出错
18100258 不合法的用户KYC水平
18100259 体验金重复
18100260 计算仓位出错
18100261 超过账户delta
18100262 不合法的提币请求
18100263 提币出错
18100264 不合法的用户自定义字符串
18100265 不合法的block trade来源
18100266 发送校验码出错
18100267 不合法的校验码
18100268 不合法的数字字符串
18100269 超过最大仓位
18100270 超过最大未结订单总数量
18100271 获取 Block Order出错
18100272 重复的 Blocktrade Key
18100273 创建体验金活跃记录出错
18100274 体验金超额
18100275 不合法的批量下单请求
18100276 批量订单数目错误
18100277 Rpc 批量下单出错
18100278 数据库超时
18100279 不允许接管
18100280 不合法的批量改单请求
18100281 不在未结订单列表
18100282 Rpc 批量改单出错
18100285 Mmp 错误
18100304 不合法的频道
18100305 不合法的类别
18100306 不合法的推送频率
18100401 不合法的地址
18100402 不是白名单地址
18100403 资金秘密错误
18100404 提币订单不存在
18100405 KYT 拒绝
18100406 提币太频繁
18100407 超过提币额度
18100408 提币金额小于最小金额
18100500 交易权限错误
18100501 内部database错误
18100502 内部缓存错误
18100503 内部网络错误
18200300 超过API调用限额
18200301 登陆错误
18200302 鉴权错误, 鉴权码:
17002012: 无访问此api权限
17002011: IP地址错误
17002010: 签名错误
17002014: 时间戳过期
17002006: 内部错误
17002013: 无效 access key
18200303 超过最大连接数
18300300 无参赛
18300301 报名参赛失败
18300302 已报名参赛
18400300 只撤单阶段
18500000 Rpc timeout (需要调用方发查询请求确认结果,见上文)