简介 API 简介 欢迎使用BKEX Global API！ 此文档是BKEX GlobalAPI的唯一官方文档，BKEX GlobalAPI提供的能力会在此持续更新，请大家及时关注。 您可通过点击右上方的语言按钮来切换文档语言。 文档右侧是针对请求参数以及响应结果的示例。 更新订阅 关于API新增、更新、下线等信息BKEX Global会提前发布公告进行通知，建议您关注我们的公告，及时获取相关信息。 您可以点击 这里 查看公告。 联系我们 使用过程中如有问题或者建议，您可选择以下任一方式联系我们： 官方电报 @BKEX_ANGEL。 发送邮件至 [email protected]。 快速入门 接入准备 如需使用API ，请先登录网页端，完成API key的申请和权限配置，再据此文档详情进行开发和交易。 您可以点击 这里 创建 API Key。 每个账号最多可创建5组Api Key，每个Api Key可对应设置读取、交易、提币三种权限。 权限说明如下： 读取权限：读取权限用于对数据的查询接口，例如：订单查询、成交查询等。 交易权限：交易权限用于下单、撤单、划转类接口。 提币权限：提币权限用于创建提币订单、取消提币订单操作。 创建成功后请务必记住以下信息： Access Key API 访问密钥 Secret Key 签名认证加密所使用的密钥（仅申请时可见） 风险提示 ：这两个密钥与账号安全紧密相关，无论何时都请勿将二者同时向其它人透露。API Key的泄露可能会造成您的资产损失（即使未开通提币权限），若发现API Key泄露请尽快删除该API Key。 接口类型 BKEX Global为用户提供两种接口，您可根据自己的使用场景和偏好来选择适合的方式进行查询行情、交易或提现。 REST API REST，即Representational State Transfer的缩写，是目前较为流行的基于HTTP的一种通信机制，每一个URL代表一种资源。 交易或资产提现等一次性操作，建议开发者使用REST API进行操作。 WebSocket API WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信，通过一次简单的握手就可以建立客户端和服务器连接，服务器可以根据业务规则主动推送信息给客户端。 市场行情和买卖深度等信息，建议开发者使用WebSocket API进行获取。 接口鉴权 以上两种接口均包含公共接口和私有接口两种类型。 公共接口可用于获取基础信息和行情数据。公共接口无需认证即可调用。 私有接口可用于交易管理和账户管理。每个私有请求必须使用您的API Key进行签名验证。 接入URLs REST API https://api.bkex.com Websocket Feed wss://api.bkex.com 签名认证 签名说明 API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据）外的私有接口均必须使用您的 API Key 做加密处理，以校验参数或参数值在传输途中是否发生了更改。 每一个API Key需要有适当的权限才能访问相应的接口，每个新创建的API Key都需要分配权限。在使用接口前，请查看每个接口的权限类型，并确认你的API Key有相应的权限。 一个合法的请求所需要的内容： 方法请求地址：即访问服务器地址 api.bkex.com，比如 https://api.bkex.com/v2/u/order/create。 API 访问密钥（X_ACCESS_KEY）：您申请的 API Key 中的 Access Key。 必选和可选参数：每个方法都有一组用于定义 API 调用的必需参数和可选参数。可以在每个方法的说明中查看这些参数及其含义。 签名：加密计算得出的值，用于确保签名有效和未被篡改。 加密方式 规范要计算签名的请求 因为使用 HMAC 进行签名计算时，使用不同内容计算得到的结果会完全不同。所以在进行签名计算前，请先对请求进行规范化处理。下面以查询某订单详情请求为例进行说明： 下单请求URL https://api.bkex.com/v2/u/order/create?volume=0.12&direction=ASK&price=7126.4285&symbol=BTC_USDT 对参数按照ASCII码顺序进行排序 direction=ASK&price=7126.4285&symbol=BTC_USDT&volume=0.12 将排完序的请求参数使用secretKey 进行HMAC SHA256进行加密，得到的结果 550ac73ace8c34372e0e1dd6631e890c7bd16697af8bb4e2908e966b50aba4e0 构造http请求使用 使用 X_ACCESS_KEY 这个header存储access key信息 使用 X_SIGNATURE 这个header存储生成的签名信息 然后发送http请求 枚举定义 交易对 交易对由基础币种和报价币种组成。以交易对 BTC_USDT 为例，BTC 为基础币种，USDT 为报价币种。 账户 不同业务对应需要不同的账户 账户类型包括： WALLET：现货账户,钱包账户 OTC：OTC账户 订单、成交相关ID说明 orderId : 订单的唯一编号 tradeId : 成交的唯一编号 订单类型 买卖方向： BID: 买 ASK: 卖 订单种类: LIMIT : 限价单，该类型订单需指定下单价格，下单数量。 MARKET : 市价单，该类型订单仅需指定下单金额或下单数量，不需要指定价格，订单在进入撮合时，会直接与对手方进行成交，直至金额或数量低于最小成交金额或成交数量为止。 STOP_LIMIT : 止盈止损单，设置高于或低于市场价格的订单，当订单到达触发价格后，才会正式的进入撮合队列。 查询订单排序规则: TIME_ASC :按照时间升序。 TIME_DESC : 按照时间降序。 PRICE_ASC : 按照价格升序。 PRICE_DESC : 按照价格降序。 订单状态 -1 : 计划委托订单未触发，该状态订单为进入撮合队列当中。 0 : 等待成交，该状态订单已进入撮合队列当中。 1 : 已成交。该状态订单不在撮合队列中，订单的全部数量已经被市场成交。 2 : 已撤销。该状态订单不在撮合订单中，此状态订单可能有部分成交数量，且被成功撤销。 3 : 部分成交，该状态订单在撮合队列当中，订单的部分数量已经被市场成交，等待剩余部分成交。 接入说明 接口概览 接口分类 分类链接 概述 基础类 /v2/common/* 基础类接口，包括币种、交易对等接口 行情类 /v2/q/* 公共行情类接口，包括成交、深度、行情等 账户类 /v2/u/account/* 账户类接口，包括账户信息等 钱包类 /v2/u/wallet/* 钱包提现，充提记录等 订单类 /v2/u/order/* 订单类接口，包括下单、撤单、订单查询、成交查询等 限频规则 每个API Key 在1秒之内限制10次 若接口不需要API Key，则每个IP在1秒内限制10次 各别接口有单独的限频规则 超过限频数量，会被封禁5-10秒 比如： 资产订单类接口调用根据用户进行限频：1秒10次 行情类接口调用根据IP进行限频：1秒10次 请求格式 目前只有两种方法：GET和POST GET请求：所有的参数都在路径参数里 POST请求，所有参数以form-data格式发送在请求主体（body）里 返回格式 所有的接口都是JSON格式。在JSON最上层有三个字段：msg, code 和 data。前两个字段表示请求状态和信息，实际的业务数据在data字段里。 以下是一个返回格式的样例： { "msg": "success", "code": "0", "data": // per API response data in nested JSON object } 参数名称 数据类型 描述 msg string API信息返回 code int 接口状态返回，0代表成功 data object 接口返回数据主体 常见错误码 错误码 描述 75 交易价格不正确 76 交易价格精度不对 77 请求参数不正确 1005 余额不足 1801 数量太小 1931 委托数量超过限制 2002 交易对错误 2025 交易方向错误 2027 该交易对当前还未开放下单 2031 数量精度不正确 2033 该交易暂不支持下买单 2034 交易对当前还未开放买单 2035 该交易暂不支持下卖单 2036 交易对当前还未开放卖单 2037 请稍后下单/撤单(被限流) 2041 市价单Price应该为空 2042 交易对计划委托超过限制 2043 计划委托总数超过限制 6006 访问太频繁，请稍后重试(被限流) 7019 无法找到订单，无法取消 7020 无法取消该订单 示例代码 github 示例代码 基础信息 获取所有交易对 此接口返回所有BKEX Global支持的交易对。 curl "https://api.bkex.com/v2/common/symbols" HTTP 请求 GET /v2/common/symbols 请求参数 此接口不接受任何参数。 Response: { "msg": "success", "code": "0", "data": [ { "symbol": "BTC_USDT", "supportTrade": true, "volumePrecision": 4, "pricePrecision": 4, "minimumTradeVolume": 0.001, "tradeSet":"USDT" }, { "symbol": "ETH_USDT", "supportTrade": false, "volumePrecision": 4, "pricePrecision": 4, "minimumTradeVolume": 0.01, "tradeSet":"USDT" } ] } 返回字段 字段名称 数据类型 描述 symbol string 交易对 supportTrade boolean 是否支持交易 volumePrecision integer 交易对下单数量的精度（小数点后位数） pricePrecision integer 交易对下单价格的精度（小数点后位数） minimumTradeVolume decimal 交易对前币种最小下单数量 tradeSet string 交易区 获取所有币种 此接口返回所有BKEX Global支持的币种。 curl "https://api.bkex.com/v2/common/currencys" HTTP 请求 GET /v2/common/currencys 请求参数 此接口不接受任何参数。 Response: { "msg": "success", "code": "0", "data": [ { "currency": "ETH", "maxWithdrawOneDay": 2000, "maxWithdrawSingle": 2000, "minWithdrawSingle": 0.1, "supportDeposit": true, "supportTrade": true, "supportWithdraw": true, "withdrawFee": 0.008 }, { "currency": "BTC", "maxWithdrawOneDay": 100, "maxWithdrawSingle": 100, "minWithdrawSingle": 0.01, "supportDeposit": true, "supportTrade": true, "supportWithdraw": true, "withdrawFee": 0.008 } ] } 返回字段 字段名称 数据类型 描述 currency string 币种 maxWithdrawOneDay decimal 当天提笔最大限额 maxWithdrawSingle decimal 单笔提现最大限额 minWithdrawSingle decimal 单笔提现最小数量 supportDeposit boolean 是否支持充值 supportTrade boolean 是否支持交易 supportWithdraw boolean 是否支持提现 withdrawFee decimal 提现手续费 获取服务器时间戳 此接口返回服务器当前时间戳。即从 UTC 1970年1月1日0时0分0秒0毫秒到现在的总毫秒数。 curl "https://api.bkex.com/v2/common/timestamp" HTTP 请求 GET /v2/common/timestamp 请求参数 此接口不接受任何参数。 Response: { "code": 0, "data": 1588652674630, "msg": "success" } 返回字段 字段名称 数据类型 描述 data long 时间戳 行情数据 K 线数据（蜡烛图） 此接口返回历史K线数据。 HTTP 请求 GET /v2/q/kline curl "https://api.bkex.com/v2/q/kline?period=1m&size=200&symbol=BTC_USDT&from=1529739295000&to=1532331295000" 请求参数 参数 数据类型 是否必须 默认值 描述 取值范围 symbol string true NA 交易对 BTC_USDT period string false 1m 返回数据时间粒度，也就是每根蜡烛的时间区间 1m, 5m, 15m, 30m, 1h, 4h, 6h, 12h, 1d, 1w from long true NA 查询起始时间戳，单位毫秒 1529739295000 to long true NA 查询截止时间戳，单位毫秒 1532331295000 size integer false 500 返回 K 线数据条数 [1, 1000] K线周期以格林威治时间为基准开始计算，例如日K线的周期开始为格林威治时间0时，周期结束时间为格林威治时间次日0时。 Response: { "msg": "success", "code": "0", "data": [ { "symbol": "BTC_USDT", "volume": 12321.1234, "open": 4124.3, "close": 3873.213, "low": 3521.1, "high": 4521.5, "quoteVolume": 71031537.978665, "ts": 1529739295000 } ] } 响应数据 字段名称 数据类型 描述 symbol string 交易对 volume decimal 以基础币种计量的交易量 open decimal 本阶段开盘价 close decimal 本阶段收盘价 low decimal 本阶段最低价 high decimal 本阶段最高价 quoteVolume decimal 以报价币种计量的交易量 ts long 新加坡时间的时间戳，单位毫秒 24小时行情 此接口提供最近24小时的交易对行情信息。 HTTP 请求 GET /v2/q/tickers curl "https://api.bkex.com/v2/q/tickers?symbol=BTC_USDT" 请求参数 参数 数据类型 是否必须 默认值 描述 取值范围 symbol string false NA 交易对 BTC_USDT,ETH_USDT... Response: { "msg": "success", "code": "0", "data": [ { "symbol": "BTC_USDT", "tradeSet": "USDT", "close": 7145.0407, "open": 7145.0407, "high": 7145.0407, "low": 7145.0407, "volume": 3124.1231, "quoteVolume": 23131.847291, "change": 0.12, "ts": 1529739295000 } ] } 响应数据 字段名称 数据类型 描述 symbol string 交易对 tradeSet string 交易区 volume decimal 以基础币种计量的交易量 open decimal 本阶段开盘价 close decimal 本阶段最新价 quoteVolume decimal 本阶段最低价 high decimal 本阶段最高价 vol decimal 以报价币种计量的交易量 change decimal 24小时涨跌幅 ts long 新加坡时间的时间戳，单位毫秒 最新成交价 此接口提供交易对当前最新成交价 HTTP 请求 GET /v2/q/ticker/price curl "https://api.bkex.com/v2/q/ticker/price?symbol=BTC_USDT" 请求参数 参数 数据类型 是否必须 默认值 描述 取值范围 symbol string false NA 交易对 BTC_USDT,ETH_USDT... Response: { "msg": "success", "code": "0", "data": [ { "symbol": "BTC_USDT", "price": 7145.0407 } ] } 响应数据 字段名称 数据类型 描述 symbol string 交易对 price decimal 当前成交价格 交易对深度数据 此接口返回指定交易对的当前深度数据。 HTTP 请求 GET /v2/q/depth curl "https://api.bkex.com/v2/q/depth?symbol=BTC_USDT&depth=20&precision=4" 请求参数 参数 数据类型 必须 默认值 描述 取值范围 symbol string true NA 交易对 BTC_USDT depth integer false 50 返回深度的数量 [1-50] precision integer false 交易对默认精度 价格精度 [1-10] Response: { "msg": "success", "code": "0", "data": { "bid": [ [7964, 0.0678], // [价格, 数量] [7963, 0.9162], ... ], "ask": [ [7979, 0.0736], [7980, 1.0292], ... ] } } 响应数据 字段名称 数据类型 描述 bid object 当前的所有买单 [price, volume] ask object 当前的所有卖单 [price, volume] 最近成交记录 此接口返回指定交易对最新成交记录。 HTTP 请求 GET /v2/q/deals curl "https://api.bkex.com/v2/q/deals?symbol=BTC_USDT&size=20" 请求参数 参数 数据类型 是否必须 默认值 描述 symbol string true NA BTC_USDT size integer false NA [1-50] Response: { "msg": "success", "code": "0", "data": [ { "symbol": "BTC_USDT", "price": 7145.0407, "volume": 0.5344, "direction": "B", "ts": 1529739295000 } ] } 响应数据 字段名称 数据类型 描述 symbol string 交易对 volume decimal 以基础币种为单位的成交量 price decimal 以报价币种为单位的成交价格 direction string 交易方向：“B” 或 “S”, “B” 即买，“S” 即卖 ts long 新加坡时间的时间戳，单位毫秒 账户相关 访问账户相关的接口需要进行签名认证。 API Key权限信息 查询当前API Key的权限信息 HTTP 请求 GET /v2/u/api/info 请求参数 此接口不接受任何参数。 Response: { "msg": "success", "code": "0", "data": { "asset": true, "contract": true, "contractType": 1, "deal": true, "endTime": 1591537150000 } } 响应数据 参数名称 数据类型 例子 描述 asset boolean true 是否可查询资产(钱包账户、法币账户) deal boolean true 是否可委托交易 contract boolean true 是否开通合约相关权限 contractType integer 1 合约权限(0:查询，1:查询和交易) endTime long 1591537150000 api-key过期时间 账户余额 API Key 权限：读取 查询指定币种或全部的余额，支持钱包和OTC账户 HTTP 请求 GET /v2/u/account/balance 请求参数 参数名称 是否必须 类型 描述 默认值 取值范围 currencys false string 币种 NA BTC,ETH... Response: { "msg": "success", "code": "0", "data": { "WALLET": [ { "currency": "BTC", "available": "0.1", "frozen": "0.1", "total": "0.2" }, { "currency": "USDT", "available": "1.2", "frozen": "0", "total": "1.2" } ] } } 响应数据 字段名称 数据类型 描述 WALLET object 钱包账户 账户中的字段 字段名称 数据类型 描述 currency string 币种 available decimal 可用余额 frozen decimal 冻结余额 total decimal 全部余额 账户之间划转 API Key 权限：交易 此接口用于不同账户之间资金划转。 HTTP 请求 POST /v2/u/account/transfer { "currency": "USDT", "volume": 10, "fromSource": "WALLET" "toSource": "OTC" } 请求参数 参数名称 数据类型 是否必需 默认值 描述 取值范围 currency string true NA BTC volume decimal true NA 划转数量 fromSource string true NA 划出来源 WALLET,OTC toSource string true NA 划入目标源 WALLET,OTC Response: { "code": 0 "msg": "success" } 响应数据 参数名称 数据类型 描述 code integer 状态码 msg string 返回信息 --> 充值与提现 访问钱包相关的接口需要进行签名认证。 充币地址查询 API Key 权限：读取 HTTP 请求 GET /v2/u/wallet/address curl "https://api.bkex.com//v2/u/wallet/address?currency=ETH" 请求参数 字段名称 是否必需 类型 字段描述 取值范围 currency true string 币种 ETH,BTC... Response: { "msg": "success", "code": "0", "data": [ { "currency": "BTC", "address": "1m4k2yUKTSrX6SM9FGgvwMybAbYtRVi2N", "memo": "" } ] } 响应数据 字段名称 数据类型 字段描述 currency string 币种 address string 充币地址 memo string 充币地址标签 充值记录 API Key 权限：读取 查询充值记录 HTTP 请求 GET /v2/u/wallet/depositRecord 请求参数 参数名称 是否必须 类型 描述 默认值 取值范围 currency true string 币种 BTC from false long 起始时间戳 1532331295000 to false long 截止时间戳 1532331295000 size false integer 查询记录大小 10 10-100 page false integer 页数 1 Response: { "msg": "success", "code": "0", "data": [ { "id": "117121312313", "currency": "BTC", "hash": "6ea95a124371c685e000b968ace1c024f2d67bf73a97b43cf94ab6572fa529", "volume": 0.1234, "fromAddress": "1LMhQnpvwiiRSn2NPPxaQLVyBzdGcXvi", "toAddress": "1LMhQnpvwiiRSn2NPPxaQLVyBzdGcXvi", "confirmed": 3, "state": 0, "createTime": 1532331295000 } ] } 响应数据 参数名称 数据类型 描述 id string 业务ID currency string 币种 hash string 交易哈希 volume decimal 个数 fromAddress string 起始地址 toAddress string 充值地址 confirmed integer 确认数 state integer 状态 createTime long 发起时间 充值状态定义： 状态 描述 -1 失败 0 已确认 3 确认中 提现记录 API Key 权限：读取 查询提现记录 HTTP 请求 GET /v2/u/wallet/withdrawRecord 请求参数 参数名称 是否必须 类型 描述 默认值 取值范围 currency false string 币种 BTC from false long 起始时间戳 1532331295000 to false long 截止时间戳 1532331295000 size false integer 查询记录大小 10 10-100 page false integer 页数 1 Response: { "msg": "success", "code": "0", "data": [ { "id": "117121312313", "currency": "BTC", "hash": "6ea95a124371c685e000b968ace1c024f2d67bf73a97b43cf94ab6572fa529", "volume": 0.1234, "fromAddress": "1LMhQnpvwiiRSn2NPPxaQLVyBzdGcXvi", "toAddress": "1LMhQnpvwiiRSn2NPPxaQLVyBzdGcXvi", "fee": 0.0001, "state": 0, "createTime": 1532331295000 } ] } 响应数据 参数名称 数据类型 描述 id string 业务ID currency string 币种 hash string 交易哈希 volume decimal 个数 fromAddress string 起始地址 toAddress string 充值地址 fee decimal 手续费数量 state integer 状态 createTime long 发起时间 提现状态定义： 状态 描述 -1 失败 0 已确认 1 已提交 2 已取消 5 等待确认中 现货交易 访问交易相关的接口需要进行签名认证。 下单 API Key 权限：交易 发送一个新订单 HTTP 请求 POST /v2/u/order/create { "volume": 0.1, "price": 7000.12, "direction": "ASK", "symbol": "BTC_USDT", "source": "WALLET", "type": "STOP_LIMIT", "stopPrice": 6900, "operator": "gte", } 请求参数 参数名称 数据类型 是否必需 默认值 描述 symbol string true NA BTC_USDT volume decimal true NA 下单数量 price decimal false NA 下单价格 direction string true NA 下单方向，ASK,BID source string false WALLET 下单来源账户，默认为钱包账户(后续会支持杠杠账户) type string false LIMIT 下单类型，取值可为(LIMIT、LIMIT_MAKER、MARKET、STOP_LIMIT) stopPrice decimal false NA 计划委托订单触发价格 operator string false NA 计划委托订单触发价运算符 gte – greater than and equal (>=), lte – less than and equal ( Response: { "code": 0, "msg": "Create Order Successfully", "data": "20180623123334234234" } 响应数据 code为0，表示下单成功，返回的数据data对象是下单成功后的订单号。 撤销订单 API Key 权限：交易 此接口发送一个撤销订单的请求。 HTTP 请求 POST /v2/u/order/cancel 请求参数 参数名称 是否必须 类型 描述 orderId true string 订单ID Response: { "code": 0, "msg": "success", "data": "201908231244212312123" } 响应数据 code为0，表示撤销成功，data返回订单Id 查询当前未完成订单 API Key 权限：读取 { "symbol": "BTC_USDT", "direction": "ASK", "source": "WALLET", "type": "LIMIT", "sortingWay": "TIME_ASC", "page": 1, "size": 10 } HTTP 请求 GET /v2/u/order/openOrders 请求参数 参数名称 数据类型 是否必需 默认值 描述 symbol string true NA 交易对,BTC_USDT direction string false NA 指定只返回某一个方向的订单，卖为ASK，买为BID source string false WALEET 下单来源账户类型 type string false NA 订单类型 sortingWay string false NA 排序规则,可取值(TIME_ASC、TIME_DESC、PRICE_ASC、PRICE_DESC) page integer false 1 查询页码 size integer false 10 返回订单的数量，最大值100。 Response: { "msg": "success", "code": "0", "data": [ { "id": "201806232342422123123", "symbol": "BTC_USDT", "type": "STOP_LIMIT", "totalVolume": 1.123, "price": "7000.3241", "direction": "ASK", "dealVolume": 0.1, "frozenVolumeByOrder": 1.123, "source": WALLET, "stopPrice": 6900, "operator": ">=", "status": 0, "createdTime": 1530604762277 } ] } 响应数据 字段名称 数据类型 描述 id string 订单id symbol string 交易对, 例如BTC_USDT price string 下单价格 createdTime long 订单创建时间的时间戳，单位毫秒 type string 订单类型 totalVolume decimal 订单下单总数 direction string 下单方向 dealVolume decimal 已成交数量 frozenVolumeByOrder decimal 下单冻结数量 source string 下单来源账户类型 stopPrice decimal 计划委托订单触发价格 operator string 计划委托订单运算符 status string 0:挂单中，1:已完成，2:已撤销，3:部分成交 查询未完成订单详情 API Key 权限：读取 HTTP 请求 GET /v2/u/order/openOrder/detail 请求参数 参数名称 数据类型 是否必需 默认值 描述 orderId string true NA 订单ID Response: { "msg": "success", "code": "0", "data":{ "id": "201806232342422123123", "symbol": "BTC_USDT", "type": "STOP_LIMIT", "totalVolume": 1.123, "price": "7000.3241", "direction": "ASK", "dealVolume": 0.1, "frozenVolumeByOrder": 1.123, "source": "WALLET", "stopPrice": 6900, "operator": ">=", "status": 0, "createdTime": 1530604762277, "updateTime": 1530604762277 } } 响应数据 字段名称 数据类型 描述 id string 订单id symbol string 交易对, 例如BTC_USDT price string 下单价格 createdTime long 订单创建时间的时间戳，单位毫秒 type string 订单类型 totalVolume decimal 订单下单总数 direction string 下单方向 dealVolume decimal 已成交数量 frozenVolumeByOrder decimal 下单冻结数量 source string 下单来源账户类型 stopPrice decimal 计划委托订单触发价格 operator string 计划委托订单运算符 status string 0:挂单中,3:部分成交 createdTime long 挂单时间 updateTime long 最后更新时间 查询历史订单 API Key 权限：读取 { "symbol": "BTC_USDT", "direction": "ASK", "type": "LIMIT", "sortingWay": "TIME_ASC", "filterCancelAll": true, "page": 1, "size": 10, "startTime": 1532331295000, "endTime": 1532331295000 } HTTP 请求 GET /v2/u/order/historyOrders 请求参数 参数名称 数据类型 是否必需 默认值 描述 symbol string true NA 交易对,BTC_USDT direction string false NA 指定只返回某一个方向的订单，卖为ASK，买为BID type string false NA 订单类型 sortingWay string false NA 排序规则,可取值(TIME_ASC、TIME_DESC、PRICE_ASC、PRICE_DESC) filterCancelAll boolean false NA 是否过滤完全没有成交的订单 page integer false 1 查询页码 size integer false 10 返回订单的数量，最大值100。 startTime long false NA 起始时间戳，单位毫秒 endTime long false NA 截止时间戳，单位毫秒 Response: { "msg": "success", "code": "0", "data": [ { "id": "201806232342422123123", "symbol": "BTC_USDT", "type": "STOP_LIMIT", "totalVolume": 1.123, "price": "7000.3241", "direction": "ASK", "dealVolume": 0.1, "frozenVolumeByOrder": 1.123, "dealAvgPrice": 2341, "source": "WALEET", "stopPrice": 6900, "operator": ">=", "createdTime": 1530604762277, "updateTime": 1530604762277, "status": 0 } ] } 响应数据 字段名称 数据类型 描述 id string 订单id symbol string 交易对, 例如BTC_USDT price string 下单价格 type string 订单类型 totalVolume decimal 订单下单总数 direction string 下单方向 dealVolume decimal 已成交数量 frozenVolumeByOrder decimal 下单冻结数量 dealAvgPrice decimal 成交均价 source decimal 下单来源账户类型 stopPrice decimal 计划委托订单触发价格 operator string 计划委托订单运算符 createdTime long 订单创建时间的时间戳，单位毫秒 updateTime long 订单最后修改时间的时间戳，单位毫秒 status string 1:已完成，2:已撤销 批量下单 API Key 权限：交易 一个批量最多20张订单 该接口限制频率1秒1次 [ { "volume": 0.1, "price": 7000.12, "direction": "ASK", "symbol": "BTC_USDT", "source": "WALLET", "type": "STOP_LIMIT", "stopPrice": "6900", "operator": "lte" }, "volume": 0.1, "price": 7000.12, "direction": "ASK", "symbol": "BTC_USDT", "source": "WALEET", "type": "STOP_LIMIT", "stopPrice": "6900", "operator": "lte" } ] HTTP 请求 POST /v2/u/order/batchCreate 请求参数 参数名称 是否必须 类型 描述 默认值 取值范围 orders true string JOSN格式字符串 Response: { "code":0, "msg": "success", "data": { "success": 2, "fail": 0, "results": ["2019062312313131231","2019063123131312313"] } } 响应数据 参数名称 数据类型 描述 success integer 成功数量 fail integer 失败数量 results string 下单成功订单号集合 批量撤销订单 API Key 权限：交易 该接口限制频率1秒1次 此接口同时为多个订单（基于id）发送取消请求。 HTTP 请求 POST /v2/u/order/batchCancel [ "2018062321121231231","2018062321121231232" ] 请求参数 参数名称 是否必须 类型 描述 默认值 取值范围 orders true string JOSN格式字符串,订单ID集合:["2018062321121231231","2018062321121231231"] Response: { "code":0, "msg": "success", "data": { "success": 2, "fail": 0, "results": ["2019062312313131231","2019063123131312313"] } } 响应数据 参数名称 数据类型 描述 success integer 成功数量 fail integer 失败数量 results string 撤单成功订单号集合 合约交易 访问合约交易相关的接口需要进行签名认证。 公共信息接口 测试服务器连通性 API Key 权限：无需签名 HTTP 请求 GET /fapi/v2/server/ping curl "https://fapi.bkex.com/fapi/v2/server/ping" 请求参数 无 Response: { "code": 0, "msg": "success", "data": { "serverTime": 1658368263053 } } 响应数据 参数名称 数据类型 例子 描述 serverTime long 1658368263053 系统时间 获取服务器时间 API Key 权限：无需签名 HTTP 请求 GET /fapi/v2/server/ping curl "https://fapi.bkex.com/fapi/v2/server/time" 请求参数 无 Response: { "code": 0, "msg": "success", "data": { "serverTime": 1658368263053 } } 响应数据 参数名称 数据类型 例子 描述 serverTime long 1658368263053 系统时间 获取所有交易对信息 API Key 权限：无需签名 限制(根据IP限制)：50次/s。 HTTP 请求 GET /fapi/v2/market/symbols curl "https://fapi.bkex.com/fapi/v2/market/symbols" 请求参数 无 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "xrp_usdt", "supportTrade": true, "volumePrecision": 0, "pricePrecision": 4, "marketMiniAmount": "100", "limitMiniAmount": "100" }, { "symbol": "ltc_usdt", "supportTrade": true, "volumePrecision": 1, "pricePrecision": 2, "marketMiniAmount": "0.1", "limitMiniAmount": "0.1" } ] } 响应数据 参数名称 数据类型 例子 描述 symbol tring btc_usdt 交易对 supportTrade boolean true 是否支持交易 volumePrecision int 1 交易对下单数量的精度（小数点后位数） pricePrecision int 2 交易对下单价格的精度（小数点后位数） marketMiniAmount string "0.1", 交易对市价最小下单量 limitMiniAmount string "0.1", 交易对限价最小下单量 获取深度数据 API Key 权限：无需签名 频率限制(根据IP限制)：20次/s HTTP 请求 GET /fapi/v2/market/depth curl "https://fapi.bkex.com/fapi/v2/market/depth?symbol=btc_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true none 交易对 limit query int false none 交易对 默认20，{5, 10, 20, 50,100,200} Response: { "code": 0, "msg": "success", "data": { "bid": [ [ "40522.82", "3.65" ], [ "40521.18", "4.07" ] ], "ask": [ [ "40525.66", "2.82" ], [ "40527.3", "4.49" ] ] } } 响应数据 参数名称 数据类型 例子 描述 bid array ["40522.82", "3.65"] 买方向:[价格，数量] ask array ["40525.66", "2.82"] 卖方向:[价格，数量] 获取深度数据(所有币对) API Key 权限：无需签名 频率限制(根据IP限制)：20次/s HTTP 请求 GET /fapi/v2/market/depthAll curl "https://fapi.bkex.com/fapi/v2/market/depthAll?limit=5" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 limit query int false none 交易对 默认10，{5, 10, 20, 50} Response: { "code": 0, "msg": "success", "data": [ { "symbol": "atom_usdt", "bid": [ [ "9.870000", "2459" ], [ "9.864000", "1332" ] ], "ask": [ [ "9.874000", "1065" ], [ "9.875000", "1331" ] ] }, { "symbol": "uni_usdt", "bid": [], "ask": [] } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 币对名称 bid array ["40522.82", "3.65"] 买方向:[价格，数量] ask array ["40525.66", "2.82"] 卖方向:[价格，数量] 获取k线数据 API Key 权限：无需签名 频率限制(根据IP限制)：20次/s。 HTTP 请求 GET /fapi/v2/market/candle curl "https://fapi.bkex.com/fapi/v2/market/candle?symbol=btc_usdt&period=M1" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true none 交易对 period query string true none 返回数据时间粒度，也就是每根蜡烛的时间区间 取值范围：M1 M5 M15 M30 H1 H4 H6 D1 start query string false none 查询起始时间戳，单位毫秒 end query string false none 查询截止时间戳，单位毫秒 count query string false 默认200 返回 K 线数据条数 取值范围[1, 500] Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "amount": "0.04", "volume": "1618.83", "open": "40488.78", "close": "40469.88", "high": "40488.78", "low": "40469.88", "ts": 1650937980000 }, { "symbol": "btc_usdt", "amount": "0.04", "volume": "1619.55", "open": "40469.36", "close": "40488.78", "high": "40488.95", "low": "40469.36", "ts": 1650937920000 }, { "symbol": "btc_usdt", "amount": "0.02", "volume": "809.35", "open": "40490.47", "close": "40469.36", "high": "40490.47", "low": "40464.03", "ts": 1650937860000 } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 amount string "0.04" 以基础币种计量的交易量 volume string "809.35" 以报价币种计量的交易量 open string "40490.47" 本阶段开盘价 close string "40469.36" 本阶段收盘价 high string "40490.47" 本阶段最高价 low string "40464.03" 本阶段最低价 ts long 1650937860000 本阶段开始的时间戳 获取最新价 API Key 权限：无需签名 频率限制(根据IP限制)：50次/s。 HTTP 请求 GET /fapi/v2/market/ticker/price curl "https://fapi.bkex.com/fapi/v2/market/ticker/price?symbol=btc_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string false NA 交易对；不填，则获取所有币对的数据 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "price": "40557.23" } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 price string "40557.23" 价格 获取ticker数据 API Key 权限：无需签名 频率限制(根据IP限制)：20次/s。 HTTP 请求 GET /fapi/v2/market/tickers curl "https://fapi.bkex.com/fapi/v2/market/tickers?symbol=btc_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string false NA 交易对；不填，则获取所有币对的数据 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "amount":"2553.28", "volume":"60609744.48039", "open":"23775.65", "close":"23745.15", "high":"23852.37", "low":"23561.12", "lastPrice":"23745.15", "lastAmount":"0.06", "lastTime":1659336982046, "change":"-0.12" } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 amount string "0.04" 以基础币种计量的交易量（以滚动24小时计） volume string "809.35" 以报价币种计量的交易量（以滚动24小时计） open string "40490.47" 最近24小时开盘价 close string "40469.36" 最近24小时收盘价 high string "40490.47" 最近24小时最高价 low string "40464.03" 最近24小时最低价 lastPrice string "40469.36" 最新成交价 lastAmount string "0.08" 最新成交价对应的量 lastTime long 1650937860000 最新一笔交易的时间戳 change string "-0.18" 涨跌幅（正负百分比，如-0.18即是跌0.18%） 获取成交历史 API Key 权限：无需签名 1、频率限制(根据IP限制)：20次/s。 2、返回的最大条数是200。 HTTP 请求 GET /fapi/v2/market/deals curl "https://fapi.bkex.com/fapi/v2/market/deals?symbol=btc_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true NA 交易对 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "amount": "0.01", "price": "40469.36", "side": "sell", "time": 1650937919615 }, { "symbol": "btc_usdt", "amount": "0.01", "price": "40464.03", "side": "sell", "time": 1650937892485 } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 amount string "0.01" 以基础币种计量的交易量 price string "40464.03" 以报价币种为单位的成交价格 side string "sell" 交易方向：“sell” 或 “buy”, “buy” 即买，“sell” 即卖 time long 1650937892485 成交时的时间戳 查询标记价格 API Key 权限：无需签名 HTTP 请求 GET /fapi/v2/market/index curl "https://fapi.bkex.com/fapi/v2/market/index?symbol=btc_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string false NA 交易对(如果未发送symbol，则返回全部交易对标记价格) Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "marketPrice": "23296.63" } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 marketPrice string 23296.63 标记价格 查询资金费率 API Key 权限：无需签名 HTTP 请求 GET /fapi/v2/market/fundingRate curl "https://fapi.bkex.com/fapi/v2/market/fundingRate?symbol=eth_usdt&limit=100" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true NA 交易对 startTime query string false NA 开始时间 endTime query string false NA 结束时间 limit query string fase NA 默认值:100 最大值:1000 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "eth_usdt", "rate": "0.0000129", "time": 1658370002127 } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 marketPrice string 0.0000129 资金费率 time long 1658370002127 时间 如果 startTime 和 endTime 都未发送, 返回最近 limit 条数据. 如果 startTime 和 endTime 之间的数据量大于 limit, 返回 startTime + limit情况下的数据。 查询获取风险限额 API Key 权限：无需签名 HTTP 请求 GET /fapi/v2/market/riskLimit curl "https://fapi.bkex.com/fapi/v2/market/riskLimit?symbol=eth_usdt" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true NA 交易对 Response: { "code": 0, "msg": "success", "data": [ { "symbol": "btc_usdt", "minValue": "0", "maxValue": "500000", "maxLeverage": 100, "maintenanceMarginRate": "0.005" } ] } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 minValue string 0 最小仓位价值 maxValue string 5000 最大仓位价值 maxLeverage int 100 最大可用杠杆 maintenanceMarginRate string 0.005 维持保证金率 查询账户余额 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/account/balance curl "https://fapi.bkex.com/fapi/v2/account/balance" 请求参数 无 Response: { "code": 0, "msg": "success", "data": { "balance": "0", "frozen": "0", "margin": "0", "point": "0", "loans": "0", "profit": "0", "unProfit": "0", "unLosses": "0", "coin": "usdt" } } 响应数据 参数名称 数据类型 例子 描述 balance string 0 余额 frozen string 0 挂单冻结 margin string 0 持仓保证金 point string 0 积分 loans string 0 借贷 profit string 0 未实现盈亏 unProfit string 0 浮盈 unLosses string 0 浮亏 coin string usdt 币种 调整开仓杠杆 访问该接口需要进行签名认证。 维护中s HTTP 请求 POST /fapi/v2/account/setLeverage curl "https://fapi.bkex.com/fapi/v2/account/riskLimit" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol body string true NA 交易对 leverage body int true NA 杠杆 1-100 Response: { "code": 0, "msg": "success", "data":{ "symbol": "btc_usdt", "leverage": 100, } } 响应数据 参数名称 数据类型 例子 描述 symbol string btc_usdt 交易对 leverage int 100 杠杆1-100 获取用户持仓 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/account/position curl "https://fapi.bkex.com/fapi/v2/account/position" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true NA 交易对 positionID query string false NA 仓位id Response: { "code": 0, "msg": "success", "data": [ { "positionID": "220621102231380140005", "symbol": "btc_usdt", "side":1, "leverage":20, "price":"10000.101", "amount":"10", "frozenAmount":"1", "margin":"200", "triggerType":1, "spPrice":"0", "slPrice":0, "openProfit":"0", "updatedAt":1661763669950 } ] } 响应数据 参数名称 数据类型 例子 描述 positionID string 220621102231380140005 仓位id symbol string btc_usdt 交易对 side int 1 交易方向:1-买,2-卖 leverage int 20 杠杆 price string 0 成交均价 amount string 1 持仓量 frozenAmount string 0 平仓冻结量 margin string 0 持仓保证金 triggerType int 1 止盈止损触发类型：1-成交价，2-指数价 spPrice string 0 止盈价 slPrice string 0 止损价 openProfit string 0 未实现盈亏 updatedAt int 0 更新时间 spSlModel int 1 止盈止损模式 1-全部止盈止损 2-部分止盈止损 spType int 1 止盈类型 0未设置止盈 1限价 2市价 slType int 1 止损类型 0未设置止损 1限价 2市价 spTriggerPrice string 123.12 止盈委托价 slTriggerPrice string 123.12 止损委托价 <spSlPartData>array部分止盈止损数据 idint220621102231380142311部分止损止盈止损ID triggerTypeint2止盈止损触发类型 spPricestring123.12止盈价 slPricestring123.12止损价 amountstring1.12部分止盈止损数量 spTypeint1止盈类型 0未设置止盈 1限价 2市价 slTypeint1止损类型 0未设置止损 1限价 2市价 spTriggerPricestring123.12止盈委托价 slTriggerPricestring123.12止损委托价 </spSlPartData> 获取账户成交历史 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/account/order curl "https://fapi.bkex.com/fapi/v2/account/order" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string true NA 交易对 startTime query int false NA 开始时间ms endTime query int false NA 结束时间ms，如果startTime 和 endTime 均未发送, 只会返回最近7天的数据。 startTime 和 endTime 的最大间隔为7天 limit query int false 500 返回的结果集数量 默认值:500 最大值:1000 Response: { "code": 0, "msg": "success", "data": [ { "positionID": "220621102231380140005", "symbol": "btc_usdt", "side":1, "leverage":20, "price":"10000.101", "amount":"10", "frozenAmount":"1", "margin":"200", "triggerType":1, "spPrice":"0", "slPrice":0, "openProfit":"0", "updatedAt":1661763669950 } ] } 响应数据 参数名称 数据类型 例子 描述 positionID string 220621102231380140005 仓位id symbol string btc_usdt 交易对 side int 1 方向 1buy 2sell leverage int 20 杠杆 price string 0 成交均价 amount string 1 持仓量 frozenAmount string 0 平仓冻结量 margin string 0 持仓保证金 triggerType int 1 止盈止损触发类型：1-成交价，2-指数价 spPrice string 0 止盈价 slPrice string 0 止损价 openProfit string 0 未实现盈亏 updatedAt int 0 更新时间 查询账户资金账单 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/account/balanceRecord curl "https://fapi.bkex.com/fapi/v2/account/balanceRecord" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string false NA 交易对 event query int false NA 账单类型：1:充值，2:扣款，3:转入，4:转出，9:资金费用，201:开多，202:开空，204:平多，205:平空，206:强平(event字段没有发送，返回所有类型账户损益资金流水) startTime query int false NA 开始时间ms endTime query int false NA 结束时间ms, 如果startTime 和 endTime 均未发送, 只会返回最近7天的数据, 仅保留最近3个月的数据 limit query int false 500 返回的结果集数量 默认值:500 最大值:1000 Response: { "code": 0, "msg": "success", "data": [ { "id": "220621102231380140005", "symbol": "btc_usdt", "event":1, "amount":"100", "coin":"usdt", "note":"", "updatedAt":1661763669950 } ] } 响应数据 参数名称 数据类型 例子 描述 id string 220621102231380140005 交易id symbol string btc_usdt 交易对 event int 1 账单类型：1:充值，2:扣款，3:转入，4:转出，9:资金费用，201:开多，202:开空，204:平多，205:平空，206:强平 amount string 100 金额 coin string usdt 币种 note string 备注 updatedAt int 0 更新时间 用户强平单历史 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/account/orderForced curl "https://fapi.bkex.com/fapi/v2/account/orderForced" 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbol query string false NA 交易对 startTime query int false NA 开始时间ms endTime query int false NA 结束时间ms，如果startTime和endTime均未发送, 只会返回最近7天的数据,startTime和endTime间隔不能大于7天 limit query int false 50 返回的结果集数量 默认值:50 最大值:100 action query int false 4 强平类型:4-强平,5-FOK强平,6-ADL自动减仓,9-穿仓 Response: { "code": 0, "msg": "success", "data": [ { "id": "22052621161573001012345840025", "symbol": "eth_usdt", "type": 2, "action": 6, "side": 1, "positionID": "220526154001021010017", "price": "0", "leverage": 21, "amount": "0.1", "frozen": "0", "filledAmount": "0.1", "filledPrice": "1984.5", "filledValue": "198.45", "triggerType": 2, "spPrice": "0", "slPrice": "0", "createdAt": 1661822066000, "updatedAt": 1653570975733, "state": 1, "profit": "-0.01", "fee": "0.099225", "pointFee": "0", "pointProfit": "0", "closePrice": "0" } ] } 响应数据 参数名称 数据类型 例子 描述 id string 220621102231380140005 订单id symbol string btc_usdt 交易对 type int 1 订单类型:1-限价,2-市价 action int 4 强平类型:4-强平,5-FOK强平,6-ADL自动减仓,9-穿仓 side int 1 交易方向:1-买,2-卖 positionID string 1 仓位ID price string 100 订单价格，限价单才有值 leverage int 20 杠杆 amount string 1 下单量 frozen string 1 冻结保证金 filledAmount string 1 已完成量 filledPrice string 1 成交均价 filledValue string 1 成交价值 triggerType int 1 止盈止损触发类型:1-成交价,2-指数价 spPrice string 1 预设止盈价 slPrice string 1 预设止损价 state int 1 状态:1-正常,2-已完成,3-撤销,4-部分成交,5-部分成交已撤销,6-撤销中 profit string 1 已实现盈亏 fee string 1 手续费 pointFee string 1 积分(赠金)手续费抵扣 pointProfit string 1 积分(赠金)盈亏抵扣 closePrice string 1 破产价 updatedAt int 0 更新时间 createdAt int 0 创建时间 设置仓位模式 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/position/update Request { "positionClass": 2 "recvWindow": 7796, "timestamp": 1662005739, } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 positionClassbodyinttrueNA仓位模式1:分仓 2:合仓 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success" } 响应数据 无 查询仓位模式 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/position/info 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": 2 } 响应数据 参数名称 数据类型 描述 data int 1:分仓 2:合仓 设置止盈止损 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/position/setSpSl Request { "slPrice": "19000", "spPrice": "21500", "isSetSl": true, "isSetSp": true, "positionID": "220715100013671016701", "triggerType": 1, "recvWindow": 32705, "timestamp": 1662005739 } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 slPricebodystringfalseNA止损价 spPricebodystringfalseNA止盈价 isSetSlbodyboolfalseNA是否设置止损 isSetSpbodyboolfalseNA是否设置止盈 positionIDbodystringtrueNA仓位ID triggerTypebodyinttrueNA触发类型1:成交价 2:指数价 spSlModelbodyintfalse1止盈止损模式1:全部止盈止损 2:部分止盈止损 amountbodystringfalseNA部分止盈止损的量(部分止盈止损时使用) spTypebodyintfalseNA止盈类型1:限价 2:市价 slTypebodyintfalseNA止损类型1:限价 2:市价 spTriggerPricebodystringfalseNA止盈委托价 slTriggerPricebodystringfalseNA止损委托价 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "id": "220901120303441011478", "symbol": "btc_usdt", "side": 1, "leverage": 20, "openPrice": "20046.71", "amount": "1", "frozenAmount": "0", "margin": "1002.08", "triggerType": 1, "spPrice": "21500", "slPrice": "19000" } } 响应数据 参数名称 数据类型 描述 id string 仓位id symbol string 交易对 side int 交易方向 1:买 2:卖 leverage int 杠杆 openPrice string 成交均价 amount string 持仓量 frozenAmount string 平仓冻结量 margin string 持仓保证金 triggerType int 止盈止损触发类型 1:成交价 2:指数价 spPrice string 止盈价 slPrice string 止损价 spSlModel int 止盈止损模式 1-全部止盈止损 2-部分止盈止损 spType int 止盈类型 0未设置止盈 1限价 2市价 slType int 止损类型 0未设置止损 1限价 2市价 spTriggerPrice string 止盈委托价 slTriggerPrice string 止损委托价 <spSlPartData>array部分止盈止损数据 idint部分止损止盈止损ID triggerTypeint止盈止损触发类型 spPricestring止盈价 slPricestring止损价 amountstring部分止盈止损数量 spTypeint止盈类型 0未设置止盈 1限价 2市价 slTypeint止损类型 0未设置止损 1限价 2市价 spTriggerPricestring止盈委托价 slTriggerPricestring止损委托价 </spSlPartData> 下单 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/open Request { "customID": "test_customID_01", "symbol": "btc_usdt", "side": 1, "type": 1, "amount": "2", "leverage": 20, "triggerType": 1, "price": "20270.46", "recvWindow": 7796, "timestamp": 1757798285 } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 customIDbodystringtrueNA用户自定义订单号`^[\.A-Z\:/a-z0-9_-]{1,36}$` symbolbodystringtrueNA合约币对 typebodyinttrueNA订单类型1:限价 2:市价 sidebodyinttrueNA交易方向1:买 2:卖 leveragebodyinttrueNA杠杆1 - 100 pricebodystringfalseNA下单价（限价委托使用） amountbodystringtrueNA下单量 triggerTypebodyinttrueNA止盈止损触发类型1:成交价 2:指数价 slPricebodystringfalseNA止损价 spPricebodystringfalseNA止盈价 isSetSlbodyboolfalsefalse是否设置止损 isSetSpbodyboolfalsefalse是否设置止盈 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "orderID": "22090114311747401010000602280" } } 响应数据 参数名称 数据类型 描述 orderID string 订单ID 批量下单 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/batchOpen Request { "items":[ { "customID":"test_customID_002", "symbol":"btc_usdt", "side":1, "type":2, "amount":"2", "leverage":20, "triggerType":1, "openType":1 }, { "customID":"test_customID_003", "symbol":"btc_usdt", "side":1, "type":2, "amount":"2", "leverage":20, "triggerType":1, "openType":1 }, { "customID":"test_customID_004", "symbol":"btc_usdt", "side":1, "type":2, "amount":"2", "leverage":20, "triggerType":1, "openType":1 } ], "recvWindow":7796, "timestamp":1757798285 } 请求参数 参数位置数据类型是否必须默认值描述取值范围 <items>bodyarraytrueNA下单列表1-10 customIDbodystringtrueNA用户自定义订单号`^[\.A-Z\:/a-z0-9_-]{1,36}$` symbolbodystringtrueNA合约币对 typebodyinttrueNA订单类型1:限价 2:市价 sidebodyinttrueNA交易方向1:买 2:卖 leveragebodyinttrueNA杠杆1 - 100 pricebodystringfalseNA下单价（限价委托使用） amountbodystringtrueNA下单量 triggerTypebodyinttrueNA止盈止损触发类型1:成交价 2:指数价 slPricebodystringfalseNA止损价 spPricebodystringfalseNA止盈价 isSetSlbodyboolfalsefalse是否设置止损 isSetSpbodyboolfalsefalse是否设置止盈 </items> recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "success": { "22090114415869401010000602284": "test_customID_002", "22090114415869901010000602285": "test_customID_003", "22090114415870101010000602286": "test_customID_004" }, "fail": {} } } 响应数据 参数名称 数据类型 描述 <success> object 成功集合 map订单ID:自定义ID </success> object <fail> object 失败集合 map自定义ID:错误码 </fail> object 撤销订单 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/cancel Request { "customID": "test_customID_005" "recvWindow": 17807, "timestamp": 1662005739, } 请求参数 四个条件，必须传递其中一个，建议用orderID，多个条件取并集 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringfalseNA合约币对 orderIDbodystringfalseNA订单ID customIDbodystringfalseNA自定义ID positionIDbodystringfalseNA仓位ID recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "success": { "22090115124192801010000602316": "test_customID_005" }, "fail": {} } } 响应数据 参数名称 数据类型 描述 <success> object 成功集合 map订单ID:自定义ID </success> object <fail> object 失败集合 map订单ID:自定义ID </fail> object 批量撤销订单 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/batchCancel Request { "listOrderID": [ "22090115471405601010000602461", "22090115470116001010000602452" ], "recvWindow": 17957, "timestamp": 1662005739 } 请求参数 四个条件，只需要传递其中一个，优先级顺序`symbol > order id > custom id > position id`，建议用order id 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringfalseNA合约币对 listOrderIDbodyarrayfalseNA订单ID列表 listCustomIDbodyarrayfalseNA自定义ID列表 listPositionIDbodyarrayfalseNA仓位ID列表 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "success": { "22090115470116001010000602452": "test_customID_005", "22090115471405601010000602461": "test_customID_006" }, "fail": {} } } 响应数据 参数名称 数据类型 描述 <success> object 成功集合 map订单ID:自定义ID </success> object <fail> object 失败集合 map订单ID:自定义ID </fail> object 平仓 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/close Request { "recvWindow": 5106, "timestamp": 1692005739, "amount": "1", "type": 2, "positionId": "220901161157435012531", "price": "19345.62" } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 amountbodystringtrueNA委托量 pricebodystringfalseNA平仓价（限价使用） typebodyinttrueNA订单类型1:限价 2:市价 positionIDbodystringtrueNA仓位ID recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "orderID": "22090116125693501010000602538" } } 响应数据 参数名称 数据类型 描述 orderID string 订单ID 一键平仓 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/order/closeAll Request { "symbol": "btc_usdt" "recvWindow": 9092, "timestamp": 1662005739, } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringfalseNA合约币对 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "listOrderID": [ "22090117082618701010000602582", "22090117082619401010000602583", "22090117082620301010000602584" ] } } 响应数据 参数名称 数据类型 描述 listOrderID array 订单ID列表 查询挂单信息 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/order/unFinish 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolquerystringfalseNA合约币对 orderIDquerystringfalseNA订单ID customIDquerystringfalseNA自定义ID positionIDquerystringfalseNA仓位ID recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": [ { "id": "22090117251664501010000602602", "customID": "test-customID-01", "symbol": "btc_usdt", "type": 1, "action": 0, "side": 1, "positionID": "220901172516645012603", "price": "19319.44", "leverage": 20, "amount": "1", "frozen": "965.97", "filledAmount": "0", "filledPrice": "0", "filledValue": "", "triggerType": 2, "spPrice": "0", "slPrice": "0", "state": 0, "profit": "", "fee": "", "pointFee": "", "pointProfit": "", "closePrice": "", "triggerPrice": "", "createdAt": 1662024316645, "updatedAt": 1662024316645 } ] } 响应数据 参数名称 数据类型 描述 idstring订单ID customIDstring用户自定义订单号 symbolstring合约币对 typeint订单类型 1限价 2市价 actionint订单事件 0开仓 1平仓 2止损 3止盈 4强平 5FOK强平 6ADL减仓 7加仓 8反向开仓 9穿仓 sideint交易方向 1buy 2sell positionIDstring仓位ID pricestring订单价格，限价单才有值 leverageint杠杆 amountstring下单量 frozenstring冻结保证金 filledAmountstring已完成量 filledPricestring成交均价 filledValuestring成交价值 triggerTypeint止盈止损触发类型 1成交价 2指数价 spPricestring预设止盈价 slPricestring预设止损价 stateint状态 1正常 2已完成 3撤销 4部分成交 5部分成交已撤销 6撤销中 profitstring已实现盈亏（平仓订单使用） feestring手续费 pointFeestring积分(赠金)手续费抵扣 pointProfitstring积分(赠金)盈亏抵扣 closePricestring破产价 triggerPricestring触发价 createdAtint创建时间戳 updatedAtint更新时间戳 查询完结订单详情 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/order/finishedInfo 请求参数 order id和custom id必须传递其中一个，建议使用order id 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolquerystringfalseNA合约币对 orderIDquerystringfalseNA订单ID customIDquerystringfalseNA自定义ID positionIDquerystringfalseNA仓位ID recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "id": "22083115573193301010000601127", "customID": "test_customID_01", "symbol": "btc_usdt", "type": 1, "action": 0, "side": 1, "positionID": "220831155731933011128", "price": "20270.46", "leverage": 20, "amount": "2", "frozen": "0", "filledAmount": "2", "filledPrice": "20270.46", "filledValue": "40540.92", "triggerType": 1, "spPrice": "0", "slPrice": "0", "state": 1, "profit": "0", "fee": "20.27046", "pointFee": "0", "pointProfit": "0", "closePrice": "0", "triggerPrice": "0", "createdAt": 1661932651933, "updatedAt": 1661932651933 } } 响应数据 参数名称 数据类型 描述 idstring订单ID customIDstring用户自定义订单号 symbolstring合约币对 typeint订单类型 1限价 2市价 actionint订单事件 0开仓 1平仓 2止损 3止盈 4强平 5FOK强平 6ADL减仓 7加仓 8反向开仓 9穿仓 sideint交易方向 1buy 2sell positionIDstring仓位ID pricestring订单价格，限价单才有值 leverageint杠杆 amountstring下单量 frozenstring冻结保证金 filledAmountstring已完成量 filledPricestring成交均价 filledValuestring成交价值 triggerTypeint止盈止损触发类型 1成交价 2指数价 spPricestring预设止盈价 slPricestring预设止损价 stateint状态 1正常 2已完成 3撤销 4部分成交 5部分成交已撤销 6撤销中 profitstring已实现盈亏（平仓订单使用） feestring手续费 pointFeestring积分(赠金)手续费抵扣 pointProfitstring积分(赠金)盈亏抵扣 closePricestring破产价 triggerPricestring触发价 createdAtint创建时间戳 updatedAtint更新时间戳 查询历史订单列表 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/order/finished 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolsquerystringfalseNA币对 startTimequeryintfalse90天前开始时间戳 endTimequeryintfalse当前时间戳结束时间戳 pageIndexqueryinttrueNA页码大于0 pageSizequeryinttrueNA每页条数1 - 50 recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "total": 126, "page": 1, "data": [ { "id": "22090117082620301010000602584", "customID": "test-customID-01", "symbol": "btc_usdt", "type": 2, "action": 1, "side": 2, "positionID": "220901170710987012573", "price": "0", "leverage": 20, "amount": "3", "frozen": "0", "filledAmount": "3", "filledPrice": "19928.02", "filledValue": "59784.06", "triggerType": 2, "spPrice": "0", "slPrice": "0", "state": 1, "profit": "-36.65", "fee": "29.89203", "pointFee": "0", "pointProfit": "0", "closePrice": "0", "triggerPrice": "0", "createdAt": 1662023306204, "updatedAt": 1662023306204 } ] } } 响应数据 参数名称 数据类型 描述 totalint总条数 pageint当面页码 <data>array数据块 idstring订单ID customIDstring用户自定义订单号 symbolstring合约币对 typeint订单类型 1限价 2市价 actionint订单事件 0开仓 1平仓 2止损 3止盈 4强平 5FOK强平 6ADL减仓 7加仓 8反向开仓 9穿仓 sideint交易方向 1buy 2sell positionIDstring仓位ID pricestring订单价格，限价单才有值 leverageint杠杆 amountstring下单量 frozenstring冻结保证金 filledAmountstring已完成量 filledPricestring成交均价 filledValuestring成交价值 triggerTypeint止盈止损触发类型 1成交价 2指数价 spPricestring预设止盈价 slPricestring预设止损价 stateint状态 1正常 2已完成 3撤销 4部分成交 5部分成交已撤销 6撤销中 profitstring已实现盈亏（平仓订单使用） feestring手续费 pointFeestring积分(赠金)手续费抵扣 pointProfitstring积分(赠金)盈亏抵扣 closePricestring破产价 triggerPricestring触发价 createdAtint创建时间戳 updatedAtint更新时间戳 </data> 计划委托下单 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/entrust/add Request { "customID":"test-CustomID-02", "amount": "5", "symbol": "btc_usdt", "side": 1, "triggerPrice": "20646.59", "price": "20646.59", "leverage": 20, "triggerType": 2, "spSlTriggerType": 1, "recvWindow": 66, "timestamp": 1662005739 } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 customIDbodystringtrueNA用户自定义订单号`^[\.A-Z\:/a-z0-9_-]{1,36}$` symbolbodystringtrueNA合约币对 sidebodyinttrueNA交易方向1:买 2:卖 triggerTypebodyinttrueNA计划委托触发类型1:成交价 2:指数价 triggerPricebodystringtrueNA触发价格 amountbodystringtrueNA下单量 pricebodystringtrueNA委托价格 leveragebodyinttrueNA杠杆1 - 100 spSlTriggerTypebodyinttrueNA止盈止损触发类型1最新价 2指数价 slPricebodystringfalseNA止损价 spPricebodystringfalseNA止盈价 isSetSlbodyboolfalsefalse是否设置止损 isSetSpbodyboolfalsefalse是否设置止盈 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "id": "22090120553294601010000600015", "symbol": "btc_usdt", "leverage": 20, "triggerType": 2, "triggerPrice": "20646.59", "status": 1, "side": 1, "price": "20646.59", "startPrice": "20019.75", "amount": "5", "spSlTriggerType": 1, "spPrice": "0", "slPrice": "0", "isSetSp": false, "isSetSl": false, "frozen": "5161.64", "createdAt": 1662036932946, "updatedAt": 1662036932946 } } 响应数据 参数名称 数据类型 描述 idstring委托订单ID symbolstring合约币对 sideint交易方向 1buy 2sell triggerTypeint计划委托触发类型 1成交价 2指数价 triggerPricestring触发价格 statusint状态 1待委托 2已委托 3用户撤消 4系统撤消 amountstring下单量 pricestring委托价格 startPricestring触发下单的价格 leverageint杠杆 spSlTriggerTypeint止盈止损触发类型 slPricestring止损价 spPricestring止盈价 isSetSlbool是否设置止损 isSetSpbool是否设置止盈 frozenstring冻结保证金 createdAtint创建时间戳 updatedAtint更新时间戳 取消计划委托 访问该接口需要进行签名认证。 维护中 HTTP 请求 POST /fapi/v2/entrust/cancel Request { "symbol": "btc_usdt", "entrustID": "22090120553294601010000600015" "recvWindow": 7472, "timestamp": 1662005739, } 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringtrueNA币对 entrustIDbodystringfalseNA委托订单ID customIDbodystringfalseNA用户自定义单号 recvWindowbodyintfalse5000时间滑动窗口(秒)1 - 60000 timestampbodyinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": [ "22090120553294601010000600015" ] } 响应数据 参数名称 数据类型 描述 data array 取消的委托订单ID列表 查询未完成的计划委托列表 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/entrust/unFinish 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringfalseNA币对 recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": [ { "id": "22090121233844901010000600016", "symbol": "btc_usdt", "leverage": 20, "triggerType": 2, "triggerPrice": "20646.59", "status": 1, "side": 1, "price": "20646.59", "startPrice": "19963.5", "amount": "5", "spSlTriggerType": 1, "spPrice": "0", "slPrice": "0", "isSetSp": false, "isSetSl": false, "frozen": "5161.64", "createdAt": 1662038618449, "updatedAt": 1662038618449 } ] } 响应数据 参数名称 数据类型 描述 <data>array计划委托列表 idstring委托订单ID symbolstring合约币对 sideint交易方向 1buy 2sell triggerTypeint计划委托触发类型 1成交价 2指数价 triggerPricestring触发价格 statusint状态 1待委托 2已委托 3用户撤消 4系统撤消 amountstring下单量 pricestring委托价格 startPricestring触发下单的价格 leverageint杠杆 spSlTriggerTypeint止盈止损触发类型 slPricestring止损价 spPricestring止盈价 isSetSlbool是否设置止损 isSetSpbool是否设置止盈 frozenstring冻结保证金 createdAtint创建时间戳 updatedAtint更新时间戳 </data> 查询已完成的计划委托列表 访问该接口需要进行签名认证。 维护中 HTTP 请求 GET /fapi/v2/entrust/finished 请求参数 参数 位置 数据类型 是否必须 默认值 描述 取值范围 symbolbodystringfalseNA币对 pageIndexqueryinttrueNA页码大于0 pageSizequeryinttrueNA每页条数1 - 50 recvWindowqueryintfalse5000时间滑动窗口(秒)1 - 60000 timestampqueryinttrueNA时间戳 Response: { "code": 0, "msg": "success", "data": { "total": 16, "page": 1, "data": [ { "id": "22090120553294601010000600015", "symbol": "btc_usdt", "leverage": 20, "triggerType": 2, "triggerPrice": "20646.59", "status": 3, "side": 1, "price": "20646.59", "startPrice": "20019.75", "amount": "5", "spSlTriggerType": 1, "spPrice": "0", "slPrice": "0", "isSetSp": false, "isSetSl": false, "frozen": "5161.64", "createdAt": 1662036932947, "updatedAt": 1662037987010 } ] } } 响应数据 参数名称 数据类型 描述 totalint总条数 pageint当面页码 <data>array计划委托列表 idstring委托订单ID symbolstring合约币对 sideint交易方向 1buy 2sell triggerTypeint计划委托触发类型 1成交价 2指数价 triggerPricestring触发价格 statusint状态 1待委托 2已委托 3用户撤消 4系统撤消 amountstring下单量 pricestring委托价格 startPricestring触发下单的价格 leverageint杠杆 spSlTriggerTypeint止盈止损触发类型 slPricestring止损价 spPricestring止盈价 isSetSlbool是否设置止损 isSetSpbool是否设置止盈 frozenstring冻结保证金 createdAtint创建时间戳 updatedAtint更新时间戳 </data> Websocket币币行情数据 简介 接入URL 行情请求地址 wss://api.bkex.com 例子 Socket.io Demo <script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/1.7.4/socket.io.js"></script> const socket = io('https://api.bkex.com/quotation'); socket.on('connect', function (data) {  socket.emit("subKlineByRange", {   "symbol": "BTC_USDT,ETH_USDT,LTC_USDT",   "period": "240",   "from": 1567136369,   "to": 1588735346,   "no": "157430756955441803"  }); }); Native WebScoket Demo var pingPong = null; ws = new WebSocket("wss://api.bkex.com/socket.io/?EIO=3&transport=websocket"); ws.onopen = function() {pingPong = setInterval(function () { ws.send('2');}, 20 * 1000)}; ws.onmessage = function(e) { if(e.data === '40') {     ws.send('40/quotation')}   else if(e.data === '40/quotation'){     ws.send('42/quotation,["subOrderDepth",{"symbol": "BTC_USDT","number": 50}]')}   else {} }; K线数据 主题订阅 subKlineByRange 订阅请求 [ "subKlineByRange", { "symbol": "BTC_USDT,ETH_USDT", "period": "240", "from": 1567136369, "to": 1574307629, "no": "157430756955441833" } ] 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对(多交易对以','分隔) BTC_USDT,ETH_USDT... period string true K线周期 ’1’, '5', '15', '30', '60', '240', '360', '720', '1D', '1W’， 数字代表分钟, 1D代表：1天, 1W 代表：1周 from long true 起始时间戳,单位秒 to long true 截止时间戳,单位秒 no string true 标记号 全量Response [ "symbolKlineByRange", { "no": "157430756955441833", "noMore": false, "list":[ { "volume": 194.2213, "close": 8765.4543, "quoteVolume": 31295.7543, "high": 8942.4962, "low": 8312.3154, "open": 8532.8129, "ts": 1574307629 }] } ] 增量Response [ "qSymbolKLine", { "volume": 194.2213, "close": 8765.4543, "vol": 31295.7543, "high": 8942.4962, "quoteVolume": 8312.3154, "open": 8532.8129, "ts": 1574307629 } ] 响应数据 字段 数据类型 描述 no string 标记号，返回和参数一致 noMore boolean 是否还有更多数据，false为有 list object 全量数据集合 数据字段列表 字段 数据类型 描述 volume decimal 成交量 open decimal 开盘价 close decimal 收盘价 low decimal 最低价 high decimal 最高价 quoteVolume decimal 成交额 订单深度行情数据 主题订阅 subOrderDepth 订阅参数 [ "subOrderDepth", { "symbol": "BTC_USDT,ETH_USDT", "number": 50 } ] 参数 参数 数据类型 是否必需 缺省值 描述 取值范围 symbol string true NA 交易对(多交易对以','分隔) BTC_USDT,ETH_USDT... number integer true 50 深度数量 [1-50] Response [ "quotationOrderDepth", { "symbol": BTC_USDT, "ts": 1577254059571, "asks": [ ["7148.0994","0.0021"],// [价格, 数量] ["7148.0994","0.0021"], ... ], "bids":[ ["7148.0994","0.0021"], ["7148.0994","0.0021"], ... ] } ] 数据字段列表 字段 数据类型 描述 symbol string 交易对 ts long 时间戳，单位毫秒 asks object 当前的所有卖单[价格,数量] bids object 当前所以买单[价格,数量] 成交明细 主题订阅 quotationDealConnect 此主题提供最新成交逐笔明细。 订阅参数 [ "quotationDealConnect", { "symbol": "BTC_USDT,ETH_USDT", "number": 50 } ] 参数 参数 数据类型 是否必需 缺省值 描述 取值范围 symbol string true NA 交易对(多交易对以','分隔) BTC_USDT,ETH_USDT... number integer true 50 数量 [1-50] 全量Response [ "quotationAllDeal", [{ "symbol": BTC_USDT, "price": 7145.0806, "volume": 0.1662, "direction": "B", "ts": 1577254059571 }] ] 数据字段列表 字段 数据类型 描述 symbol string 交易对 price decimal 成交价格 volume decimal 成交数量 direction string 成交方向，B为买，S为卖 ts long 成交时间戳 增量Response [ "quotationListDeal", [{ "symbol": BTC_USDT, "price": 7145.0806, "volume": 0.1662, "direction": "B", "ts": 1577254059571 }] ] 24小时行情 主题订阅 subQuotationSymbol 订阅参数 [ "subQuotationSymbol", { "symbol": "BTC_USDT,ETH_USDT" } ] 参数 参数 数据类型 是否必需 缺省值 描述 取值范围 symbol string false NA 交易对(多交易对以','分隔) BTC_USDT,ETH_USDT... Response [ "qPairsUpdateStats", [{ "symbol": BTC_USDT, "close": 7145.0806, "open": 7123.0407, "high": 7167.1034, "low": 7105.5237, "volume": 4214.5321, "quoteVolume": 94285313.4451, "change": 0.12 }] ] 数据更新字段列表 字段 数据类型 描述 symbol string 交易对 close decimal 24小时收盘价 volume decimal 24小时成交量 open decimal 24小时开盘价 low decimal 24小时最低价 high decimal 24小时最高价 quoteVolume decimal 24小时成交额 change decimal 24小时涨跌幅 Websocket币币用户数据 简介 订阅用户相关数据需要进行签名认证。签名说明 接入URL 请求地址 wss://api.bkex.com 例子 Socket.io Demo <script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/1.7.4/socket.io.js"></script> const socketUser = io('https://api.bkex.com/account'); socketUser.on('connect', function (data) {  socketUser.emit('userLogin', {   "signature": "XXXXX",   "accessKey": "XXXXX",   "timestamp": 1589199182739   });  }); socketUser.on('userLogin', function (data) {  if(data.code==0){   socketUser.emit("subUserAccountInfo");   socketUser.emit("subUserOrderDeal");  } }); Native WebScoket Demo var pingPong = null; ws = new WebSocket("wss://api.bkex.com/socket.io/?EIO=3&transport=websocket"); ws.onopen = function() {pingPong = setInterval(function () { ws.send('2');}, 20 * 1000)}; ws.onmessage = function(e) {   if(e.data === '40') {     ws.send('40/account')}   else if(e.data === '40/account'){     ws.send('42/account,["userLogin",{"signature":"93c4f85c396eeff4c0472a31439b98bec7168338f8fad44ef54b4f5b3f6b3e2f","accessKey":"64ff07234e19363cf15ca8dae1fa35e734a7842e1fef820ba7fbc94d5cffa45d","timestamp":1588663088781}]')}   else {} }; websocket用户登录 事件名 userLogin 参数 [ "userLogin", { "signature": "93c4f85c396eeff4c0472a31439b98bec7168338f8fad44ef54b4f5b3f", "accessKey": "xxxxxxxxxx19363cf15ca8dae1fa35e734a7842e1fef820ba7fbc94d5c", "timestamp": 1588663088781 } ] 请求参数 字段 数据类型 描述 accessKey string api key timestamp long 时间戳 signature string 签名字符串 登录需要进行签名认证。签名说明 签名参数为 timestamp 例： 签名参数字符串：timestamp=1588663088781 使用secretKey 进行HMAC SHA256进行加密，得到的结果：93c4f85c396eeff4c0472a31439b98bec7168338f8fad44ef54b4f5b3f Response [ "userLogin", { "code": 0, "msg": "success" } ] 响应信息 如果登录信息验证通过会返回成功消息（code=0，msg='success'）; 如果验证不通过会返回对应错误信息。 用户余额变更订阅 主题订阅 subUserAccountInfo 订阅参数 [ "subUserAccountInfo" ] Response [ "subUserAccountInfo", [ { "avAfterChange": "201.100000", "availableChange": "0.100000", "currency": "BTC", "frAfterChange": "0.000000", "frozenChange": "0.000000", "time": 1588667153068, "type": "TRADE_DEAL_BUYER" }, { "avAfterChange": "1991120.234380", "availableChange": "0.000000", "currency": "USDT", "frAfterChange": "0.000000", "frozenChange": "-807.251420", "time": 1588667153068, "type": "TRADE_DEAL_BUYER" } ] ] 数据更新字段列表 字段 数据类型 描述 avAfterChange string 变更后可用余额 availableChange string 可用余额变更量 currency string 币种 frAfterChange string 变更后冻结余额 frozenChange string 冻结余额变更量 time long 时间戳 type string 余额变更类型 余额变更类型： TRADE_DEAL_BUYER:交易中买家余额变更 TRADE_DEAL_SELLER:交易中卖家余额变更 TRADE_DEAL_BUYER_FEE:交易中买家手续费变更 TRADE_DEAL_SELLER_FEE:交易中卖家手续费变更 用户订单变更订阅 主题订阅 subUserOrderDeal 订阅参数 [ "subUserOrderDeal" ] Response [ "subUserOrderDeal", { "dealVolume": "0.1000", "fee": "0.00000000", "feeCurrency": "BKK", "id": "2020050516255306842000020", "orderId": "2020050516255281242000020", "orderSide": "BID", "price": "8072.5142", "symbol": "BTC_USDT", "tradeTime": 1588667153068 } ] 数据更新字段列表 字段 数据类型 描述 dealVolume string 成交量 fee string 手续费 feeCurrency string 手续费币种 id string 成交ID orderId string 订单id orderSide string 订单方向(BID:买入,ASK:卖出) price string 单价 symbol string 交易对 tradeTime long 成交时间 Websocket合约行情数据 接入URL 合约行情数据请求地址 wss://fapi.bkex.com/fapi/v2/ws 心跳消息 当用户的Websocket客户端连接到Websocket服务器后，服务器会定期（当前设为1分钟）向其发送ping消息。 当用户的Websocket客户端接收到此心跳消息后，应返回pong消息。 当Websocket服务器连续两次发送了`ping`消息却没有收到任何一次`pong`消息返回后，服务器将主动断开与此客户端的连接。 订阅消息 Request {"event":"sub","topic":"btc_usdt.5deep,btc_usdt.index"} 成功建立与Websocket服务器的连接后，Websocket客户端发送请求以订阅特定主题，消息格式统一，可同时订阅多个，以','分隔。 {"event":"sub","topic":"topic1,topic2..."} Response { "type":"sub", "ts":1658133356074, "data":{ "topic":"btc_usdt.5deep,btc_usdt.index", "status":"ok" } } 成功订阅后，Websocket客户端将收到确认。 {"type":"sub","ts":1658133356074,"data":{"topic":"topic1,topic2...","status":"ok"}} 之后, 一旦所订阅的主题有更新，Websocket客户端将收到服务器推送的更新消息（push）。 取消订阅 Request {"event":"unsub","topic":"btc_usdt.5deep,btc_usdt.index"} 订阅成功后可以取消订阅。消息格式格式统一，可同时取消订阅多个，以','分隔。 {"event":"unsub","topic":"topic1,topic2..."} Response { "type":"unsub", "ts":1658133356074, "data":{ "topic":"btc_usdt.5deep,btc_usdt.index", "status":"ok" } } 成功取消订阅后，Websocket客户端将收到确认。 {"type":"unsub","ts":1658133356074,"data":{"topic":"topic1,topic2...","status":"ok"}} 之后, 将不再收到该主题的推送消息。 推送有限档深度 此主题发送最新市场深度快照。快照频率为每500毫秒1次。目前支持5档,10档,20档。 主题订阅 $symbol.$depth Request {"event":"sub","topic":"btc_usdt.5deep"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... depth string true 深度类型 5deep,10deep,20deep Response { "type":"btc_usdt.5deep", "ts":1658133356423, "data": { "symbol":"btc_usdt", "asks":[ "22283.880000", "1.91", "22284.060000", "0.08", "22284.440000", "0.11", "22284.620000", "0.06", "22284.640000", "1.24" ], "bids":[ "22283.200000", "1060", "22283.000000", "790", "22282.280000", "80", "22282.240000", "1150", "22282.210000", "940" ] } } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> object 数据块 symbol string 币对 asks array 卖方 [price, size] bids array 买方 [price, size] </data> 推送增量深度 深度变化时推送 主题订阅 $symbol.updateDepth Request {"event":"sub","topic":"btc_usdt.updateDepth"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... Response { "type":"btc_usdt.5deep", "ts":1658133356423, "data":{ "symbol":"btc_usdt", "asks":[ "22283.880000", "1.91" ], "bids":[ "22283.200000", "1060", ] } } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> object 数据块 symbol string 币对 asks array 卖方 [price, size] bids array 买方 [price, size] </data> Symbol的Ticker信息 symbol 24小时完整ticker信息 主题订阅 $symbol.ticker Request {"event":"sub","topic":"btc_usdt.ticker"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... Response { "type":"btc_usdt.ticker", "ts":1659319399003, "data": { "symbol":"btc_usdt", "amount":"2553.28", "volume":"60609744.48039", "open":"23775.65", "close":"23745.15", "high":"23852.37", "low":"23561.12", "lastPrice":"23745.15", "lastAmount":"0.06", "lastTime":1659336982046, "change":"-0.12" } } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> object 数据块 symbol string 币对 amount string以基础币种计量的交易量（以滚动24小时计） volume string以报价币种计量的交易量（以滚动24小时计） open string 最近24小时开盘价 close string 最近24小时收盘价 high string 最近24小时最高价 low string 最近24小时最低价 lastPrice string 最新成交价 lastAmount string 最新成交价对应的量 lastTime long 最新一笔交易的时间戳 change string 涨跌幅（正负百分比，如-0.18即是跌0.18%） </data> 最新标记价格 最新标记的价格 主题订阅 $symbol.index Request {"event":"sub","topic":"btc_usdt.index"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... 返回数据 Request { "type":"btc_usdt.index", "ts":1658139156030, "data":{ "symbol":"btc_usdt", "price":"22227.673", "time":1658139156278 } } 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> object 数据块 symbolstring币对 pricestring标记价格 timelong事件时间 </data> object K线/蜡烛图 K线stream逐秒推送所请求的K线种类(最新一根K线)的更新 K线/蜡烛图间隔: 订阅Kline需要提供间隔参数，最短为分钟线，最长为周线。支持以下间隔: M -> 分钟; H -> 小时; D -> 天; W -> 周 主题订阅 $symbol.candle.$period Request {"event":"sub","topic":"btc_usdt.candle.M1"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... period string true 周期 M1,M5,M15,M30,H1,H2,H4,H6,D1,W1 Response { "type": "btc_usdt.candle.M1", "ts": 1662360553440, "data": [ "473.15", "9355628.808", "19771.14", "19778.09", "19769.17", "19778.06", "1662360540000" ] } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> array 数据块 string总成交量 string总成交额 string开盘价 string最高价 string最低价 string收盘价 string所属区间的时间戳(毫秒) </data> array 成交明细 主题订阅 $symbol.trade Request {"event":"sub","topic":"btc_usdt.trade"} 订阅参数 参数 数据类型 是否必需 描述 取值范围 symbol string true 交易对 ada_usdt,bch_usdt,btc_usdt... Response { "type": "btc_usdt.trade", "ts": 1662361313562, "data": [ "19788.12", "1", "15.06", "1662361313094" ] } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> array 数据块 string价格 string交易方向 1.买 2.卖 string成交数量 string成交时间戳 </data> array Websocket合约用户数据 接入URL 合约用户数据请求地址 wss://fapi.bkex.com/fapi/v2/ws 心跳消息 当用户的Websocket客户端连接到Websocket服务器后，服务器会定期（当前设为1分钟）向其发送ping消息。 当用户的Websocket客户端接收到此心跳消息后，应返回pong消息。 当Websocket服务器连续两次发送了`ping`消息却没有收到任何一次`pong`消息返回后，服务器将主动断开与此客户端的连接。 用户认证 维护中 Request {"event":"auth","accessKey":"bdc8e5ed9813cc1d00fd5d564f27e7e2696d0a9cbd70644e297ed71bb8265ea2"} Response { "type": "auth", "ts": 1662364280888, "data": "ok" } 要接受用户变更推送之前，需要申请一个access key。 使用access key进行认证，成功后，再进行对应的主题订阅，用户数据在发生变化后才能收到对应的消息推送。 未认证成功或者access key没有对应主题的权限，进行用户数据的主题订阅是无效的。 订阅消息 维护中 Request {"event":"sub","topic":"btc_usdt.5deep,btc_usdt.index"} 成功建立与Websocket服务器的连接后，Websocket客户端发送请求以订阅特定主题，消息格式统一，可同时订阅多个，以','分隔。 {"event":"sub","topic":"topic1,topic2..."} Response { "type":"sub", "ts":1658133356074, "data":{ "topic":"btc_usdt.5deep,btc_usdt.index", "status":"ok" } } 成功订阅后，Websocket客户端将收到确认。 {"type":"sub","ts":1658133356074,"data":{"topic":"topic1,topic2...","status":"ok"}} 之后, 一旦所订阅的主题有更新，Websocket客户端将收到服务器推送的更新消息（push）。 取消订阅 维护中 Request {"event":"unsub","topic":"btc_usdt.5deep,btc_usdt.index"} 订阅成功后可以取消订阅。消息格式格式统一，可同时取消订阅多个，以','分隔。 {"event":"unsub","topic":"topic1,topic2..."} Response { "type":"unsub", "ts":1658133356074, "data":{ "topic":"btc_usdt.5deep,btc_usdt.index", "status":"ok" } } 成功取消订阅后，Websocket客户端将收到确认。 {"type":"unsub","ts":1658133356074,"data":{"topic":"topic1,topic2...","status":"ok"}} 之后, 将不再收到该主题的推送消息。 账户更新 维护中 主题订阅 user.balance 需要“查询”权限 Request {"event":"sub","topic":"user.balance"} 订阅参数 无 Response { "type":"user.balance", "ts":1662365636378, "data":{ "balance":"6120140.06", "frozen":"0", "margin":"1002.79", "point":"0", "loans":"", "profit":"-327.08", "unProfit":"0", "unLosses":"-327.08", "coin":"usdt" } } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> object 数据块 balancestring余额 frozenstring挂单冻结 marginstring持仓保证金 pointstring积分(赠金) loansstring借贷 profitstring未实现盈亏 unProfitstring浮盈 unLossesstring浮亏 coinstring币种 </data> object 持仓更新 维护中 主题订阅 user.position 需要“委托”权限 Request {"event":"sub","topic":"user.position"} 订阅参数 无 Response { "type":"user.position", "ts":1662366937145, "data":[ { "positionID":"220902151914127013061", "symbol":"btc_usdt", "side":1, "leverage":20, "price":"20056.67", "amount":"1", "frozenAmount":"0", "margin":"1002.7981", "triggerType":2, "spPrice":"", "slPrice":"", "openProfit":"", "updatedAt":1662103154185 } ] } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> array 数据块 positionIDstring仓位id symbolstring币对 sideint方向 1.买 2.卖 leverageint杠杆 pricestring成交均价 amountstring持仓量 frozenAmountstring平仓冻结量 marginstring持仓保证金 triggerTypeint止盈止损触发类型 spPricestring止盈价 slPricestring止损价 openProfitstring未实现盈亏 updatedAtint更新时间 spSlModel int 止盈止损模式 1-全部止盈止损 2-部分止盈止损 spType int 止盈类型 0未设置止盈 1限价 2市价 slType int 止损类型 0未设置止损 1限价 2市价 spTriggerPrice string 止盈委托价 slTriggerPrice string 止损委托价 <spSlPartData>array部分止盈止损数据 idint部分止损止盈止损ID triggerTypeint止盈止损触发类型 spPricestring止盈价 slPricestring止损价 amountstring部分止盈止损数量 spTypeint止盈类型 0未设置止盈 1限价 2市价 slTypeint止损类型 0未设置止损 1限价 2市价 spTriggerPricestring止盈委托价 slTriggerPricestring止损委托价 </spSlPartData> </data> array 订单更新 维护中 主题订阅 user.order 需要“委托”权限 Request {"event":"sub","topic":"user.order"} 订阅参数 无 Response { "type":"user.order", "ts":1662367922965, "data":[ { "id":"22090516520341901010000604204", "customID":"", "symbol":"btc_usdt", "type":2, "action":1, "side":2, "positionID":"220905163537440014195", "price":"0", "leverage":20, "amount":"1.2", "frozen":"0", "filledAmount":"0", "filledPrice":"0", "filledValue":"", "triggerType":2, "spPrice":"0", "slPrice":"0", "state":0, "profit":"", "fee":"", "pointFee":"", "pointProfit":"", "closePrice":"", "triggerPrice":"", "createdAt":1662367923419, "updatedAt":0 } ] } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> array 数据块 idstring订单ID customIDstring用户自定义订单号 symbolstring合约币对 typeint订单类型 1限价 2市价 actionint订单事件 0开仓 1平仓 2止损 3止盈 4强平 5FOK强平 6ADL减仓 7加仓 8反向开仓 9穿仓 sideint交易方向 1buy 2sell positionIDstring仓位ID pricestring订单价格，限价单才有值 leverageint杠杆 amountstring下单量 frozenstring冻结保证金 filledAmountstring已完成量 filledPricestring成交均价 filledValuestring成交价值 triggerTypeint止盈止损触发类型 1成交价 2指数价 spPricestring预设止盈价 slPricestring预设止损价 stateint状态 1正常 2已完成 3撤销 4部分成交 5部分成交已撤销 6撤销中 profitstring已实现盈亏（平仓订单使用） feestring手续费 pointFeestring积分(赠金)手续费抵扣 pointProfitstring积分(赠金)盈亏抵扣 closePricestring破产价 triggerPricestring触发价 createdAtint创建时间戳 updatedAtint更新时间戳 </data> array 计划委托 维护中 主题订阅 user.entrust 需要“委托”权限 Request {"event":"sub","topic":"user.entrust"} 订阅参数 无 Response { "type":"user.entrust", "ts":1662369267825, "data":[ { "id":"22090517074500101010000600018", "symbol":"btc_usdt", "leverage":20, "triggerType":2, "triggerPrice":"19730.96", "status":1, "side":1, "price":"19700.96", "startPrice":"", "amount":"1", "spSlTriggerType":0, "spPrice":"0", "slPrice":"0", "isSetSp":false, "isSetSl":false, "frozen":"", "createdAt":1662368865001, "updatedAt":1662368865001 } ] } 返回数据 字段 数据类型 描述 typestring订阅的topic ts long 时间戳 <data> array 数据块 idstring委托订单ID symbolstring合约币对 sideint交易方向 1buy 2sell triggerTypeint计划委托触发类型 1成交价 2指数价 triggerPricestring触发价格 statusint状态 1待委托 2已委托 3用户撤消 4系统撤消 amountstring下单量 pricestring委托价格 startPricestring触发下单的价格 leverageint杠杆 spSlTriggerTypeint止盈止损触发类型 slPricestring止损价 spPricestring止盈价 isSetSlbool是否设置止损 isSetSpbool是否设置止盈 frozenstring冻结保证金 createdAtint创建时间戳 updatedAtint更新时间戳 </data> array