- 入门指引
- 做市商项目
- API概述
- 资金账户API
- 币币API
- 币币杠杆API
- 交割合约API
- 所有合约持仓信息
- 单个合约持仓信息
- 所有币种合约账户信息
- 单个币种合约账户信息
- 获取合约币种杠杆倍数
- 设定合约币种杠杆倍数
- 账单流水查询
- 下单
- 批量下单
- 撤销指定订单
- 批量撤销订单
- 获取订单列表
- 获取订单信息
- 获取成交明细
- 设置合约币种账户模式
- 市价全平
- 撤销所有平仓挂单
- 获取合约挂单冻结数量
- 委托策略下单
- 委托策略撤单
- 获取委托单列表
- 获取当前手续费费率
- 增加/减少保证金
- 公共-获取合约信息
- 公共-获取深度数据
- 公共-获取全部ticker信息
- 公共-获取某个ticker信息
- 公共-获取成交数据
- 公共-获取K线数据
- 公共-获取指数信息
- 公共-获取法币汇率
- 公共-获取预估交割价
- 公共-获取平台总持仓量
- 公共-获取当前限价
- 公共-获取标记价格
- 公共-获取强平单
- 公共-获取历史结算/交割记录
- 永续合约API
- 所有合约持仓信息
- 单个合约持仓信息
- 所有币种合约账户信息
- 单个币种合约账户信息
- 获取某个合约的用户配置
- 设定某个合约的杠杆
- 账单流水查询
- 下单
- 批量下单
- 撤单
- 批量撤单
- 获取所有订单列表
- 获取订单信息
- 获取成交明细
- 获取合约挂单冻结数量
- 委托策略下单
- 委托策略撤单
- 获取委托单列表
- 获取账户手续费费率
- 市价全平
- 撤销所有平仓挂单
- 公共-获取合约信息
- 公共-获取深度数据
- 公共-获取全部ticker信息
- 公共-获取某个ticker信息
- 公共-获取成交数据
- 公共-获取K线数据
- 公共-获取指数信息
- 公共-获取法币汇率
- 公共-获取平台总持仓量
- 公共-获取当前限价
- 公共-获取强平单
- 公共-获取合约资金费率
- 公共-获取合约标记价格
- 公共-获取合约历史资金费率
- 期权合约API
- 指数 API
- 获取系统升级状态
- RestAPI 错误码
- WebsocketAPI
- 更新日志
- 常见问题
- 创建我的APIkey
- OpenID开发文档说明
__
__
中文
此文档为用户提供了一整套简单而又强大的开发工具，旨在帮助用户快速、高效地将交易功能整合到自己的应用当中。
接口是提供服务的基础，API分为账户、交易和行情三类。开发者在网站创建账号后，可以根据自身需求建立不同权限的API，并利用API进行自动交易或者提现。
账户和交易API需要身份验证，提供下单、撤单，查询订单和帐户信息等功能。行情API提供市场的行情数据，所有行情接口都是公开的。
如果api返回值里出现文档上没有的字段，则意味着这些字段即将被弃用，请使用文档上的字段。
步骤：开发者如需使用API ，请先申请v3API key等信息 点击申请API key，然后根据此文档详情进行开发交易，使用过程中如有问题或者建议请及时反馈。 可参考SDK(点击跳转SDK详情页面)
为用户提供两种调用接口的方式，开发者可根据自己的使用场景和偏好选择适合自己的方式来查询行情、进行交易或提现。
REST，即Representational State Transfer的缩写，是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，正得到越来越多网站的采用。其优点如下：
- 在RESTful架构中，每一个URL代表一种资源；
- 客户端和服务器之间，传递这种资源的某种表现层；
- 建议开发者使用REST API进行币币交易或者资产提现等操作;
- 客户端通过四个HTTP指令，对服务器端资源进行操作，实现"表现层状态转化"；
HTTP/2 支持
HTTP/2 是最新版本的HTTP 协议，通过多路复用等方式对HTTP/1.1 进行了改进，在一些场景下提高了性能：
1）目前全站支持通过HTTP/1.1 与HTTP/2 协议访问；
2）对于支持的客户端，HTTP/2 是自动生效的，不需要另外进行调整；
3）对于使用较旧浏览器或程序库的客户，会保持兼容性，使用HTTP/1.1；
WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信，使得数据可以快速地双向传播。通过一次简单的握手就可以建立客户端和服务器连接，服务器根据业务规则可以主动推送信息给客户端。其优点如下：
- 客户端和服务器进行数据传输时，请求头信息比较小，大概2个字节;
- 客户端和服务器皆可以主动地发送数据给对方；
- 不需要多次创建TCP请求和销毁，节约宽带和服务器的资源。 强烈建议开发者使用WebSocket API获取市场行情和买卖深度等信息。
如需帮助请添加微信号：ApiSupport 备注：API+姓名+ok账号，拉你进API问题交流群
欢迎优秀的做市商参与长期做市项目。申请条件：用户等级 VIP2 及以上且账户资产价值>=20BTC
提 供以下信息发送邮件至： lpservice@okex.com
1、账户信息；
2、除邮箱外的有效联系方式；
3、提供其他交易平台maker交易量截图证明（比如30天内成交量，或者VIP等级等）；
邮 件里需注明所申請的做市商类别 (可多选):
• OKEx 现货做市商申请
• OKEx 交割合约做市商申请
• OKEx 永续合约做市商申请
为鼓励做市商为平台提供更好的流动性，可以享受更优的交易手续费，同时也承担相应的做市责任。具体做市责任及手续费申请成功后提供相关资料。
*OKEx保留对做市商项目的最终解释权
做市商项目不支持VIP、交易量相关活动以及任何形式的返佣活动
市场概况和基础信息
OKE账户分为资金账户、交易账户和其他账户，其中交易账户包括币币账户、币币杠杆账户、交割合约账户、永续合约账户、期权合约账户和法币账户，其他账户包括余币宝账户和挖矿账户。为了用户更方便地管理资产和控制风险，每个账户内资产是独立且可以相互划转的，若用户需要进行币币或合约交易，需要通过资金划转接口将资产划转到相应的币币或合约账户才能进行交易。
资金划转接口： POST /api/account/v3/transfer 可以将某一账户中的资产划转到其他账户(如币币账户、交割合约账户等）:
①由于币币杠杆、交割合约和永续合约又分为标的货币和交易货币(合约交易中叫做保证金)，因此在进行交易时，用户可以将资产从币币杠杆账户的某一杠杆币对的指定币种下划转到交割合约、永续合约的某一合约账户的相同币种下(如可将ETH从ETH/USDT杠杆账户划转到ETH/USD交割合约账户)。
②交割合约账户和永续合约账户中，币本位合约账户中只能转入标的货币如BTC、ETH等作为保证金，USDT合约账户中只能转入USDT作为保证金。
以下分别是各个账户的介绍和API提供的接口：
1）资金账户
资金账户是管理出入金的账户，显示的是用户当前资金账户中的资产，空投、糖果、以及活动奖励也会发送至您的资金账户(领取需要您去web端操作)。通过充币，可以将资产充入用户的资金账户；通过提币，可以将资产提至用户个人钱包或其他平台。
GET/api/account/v3/wallet 和 GET/api/account/v3/wallet/<currency>
分别可以查询资金账户内所有币种和单个币种的余额、冻结、和可用额度。
2）币币账户
币币账户是进行币币交易的资产账户，显示的是用户当前币币账户中的资产。要进行币币交易，需将资产划转至币币账户中，币币账户中的资产可以用于币币交易区的所有交易对。
GET/api/spot/v3/accounts和GET/api/spot/v3/accounts/<currency>
分别可以查询币币账户内所有币种和单个币种的余额、冻结、和可用额度。
3）杠杆账户
杠杆账户是进行杠杆交易的资产账户，显示的是用户当前杠杠账户中的资产。杠杆账户是分币对的独立账户，各杠杆币对的资产互相独立，风险分币对控制。要进行某个币对的杠杆交易，需将资产转至该币对的杠杆账户中的标的货币或交易货币，且支持同币种不同杠杆币对账户之间直接划转(如可将ETH从ETH/USDT杠杆账户划转到ETH/BTC杠杆账户)。
GET/api/margin/v3/accounts 可以查询币币杠杆账户内所有币种的余额、冻结、可用额度和风险率等信息。
4）交割合约账户
交割合约账户是进行交割合约交易的资产账户，显示的是用户当前交割合约账户中的资产。根据保证金类型，交割合约分为USDT保证金交割合约和币本位保证金交割合约。两种合约下，每个标的货币对应的合约都有独立的交易账户，单独核算收益和风险。币本位合约账户中只能转入标的货币如BTC、ETH等作为保证金，USDT合约账户中只能转入USDT作为保证金。
GET/api/futures/v3/accounts和GET/api/futures/v3/accounts/<underlying>分别可以查询交割合约账户内所有合约和单个合约的账户权益、账户余额、已实现盈亏、未实现盈亏等信息。
5）永续合约账户
永续合约账户是进行永续合约交易的资产账户，显示的是用户当前永续合约账户中的资产。根据保证金类型，永续合约分为USDT保证金永续合约和币本位保证金永续合约。两种合约下，每个标的货币对应的合约都有独立的交易账户，单独核算收益和风险。币本位合约账户中只能转入标的货币如BTC、ETH等作为保证金，USDT合约账户中只能转入USDT作为保证金。
GET/api/swap/v3/accounts和GET/api/swap/v3/<instrument_id>/accounts
分别可以查询永续合约账户内所有合约和单个合约的账户权益、账户余额、已实现盈亏、未实现盈亏等信息。
6）期权合约账户
期权合约账户是进行期权合约交易的资产账户，显示的是用户当前期权合约的账户资产。目前，OKEx上线了BTC期权，用户可以在期权合约账户中以BTC进行交易。
GET/api/option/v3/accounts/<underlying>
可以查询期权合约账户内BTC合约的账户权益、账户余额、已实现盈亏、未实现盈亏等信息。
7）法币账户
法币账户是进行法币交易的资产账户，显示的是用户当前法币账户中的资产。用户可用法定货币按照一定的价格兑换为数字货币，兑换后的数字货币资产将存于法币账户中。
POST /api/account/v3/transfer
可以将资产从法币账户划转到其他账户(如币币账户、交割合约账户），或从其他账户划转到法币账户，目前暂无支持法币余额查询或法币交易的接口。
8）余币宝账户
余币宝账户是使用余币宝服务的资产账户，显示的是用户当前余币宝账户的资产。用户将资产转入余币宝账户中，系统即自动开始为用户计算收益，用户将资产转出余币宝，则停止计算收益。
POST /api/account/v3/transfer
可以将资金从余币宝账户划转到其他账户(如币币账户、交割合约账户等），或从其他账户划转到余币宝账户，目前暂无其他如查询余币宝余额等数据的接口。
9）挖矿账户
挖矿账户是用于OKEx矿池挖矿服务的资产账户，显示的是用户当前挖矿账户的资产余额。用户可以用挖矿账户中的余额参与锁仓挖矿等产品，用户在OKEx矿池中的挖矿收益也会打入挖矿账户中的相应币种。
POST /api/account/v3/transfer
可以将资金从挖矿账户划转到其他账户(如币币账户、交割合约账户等），或从其他账户划转到挖矿账户，目前暂无其他如查询挖矿收益等数据的接口。
10）借贷账户
借贷账户是使用C2C借贷服务的资产账户，显示的是用户当前借贷账户的资产。用户将资产转入借贷账户中，用户可将资产用于借贷和投资。
POST /api/account/v3/transfer
可以将资金从借贷账户划转到其他账户(如币币账户、交割合约账户等），或从其他账户划转到借贷账户，目前暂无其他借贷功能的接口。
| 是 否可资金划转 | 是 否可交易 | 业 务是否支持API接口
---|---|---|---
资 金账户 | 是 | 否 | 是
币 币账户 | 是 | 是 | 是
币 币杠杆账户 | 是 | 是 | 是
交 割合约账户 | 是 | 是 | 是
永 续合约账户 | 是 | 是 | 是
期 权合约账户 | 是 | 是 | 是
法 币账户 | 是 | 是 | 否
余 币宝账户 | 是 | 否 | 否
挖 矿账户 | 是 | 否 | 否
借 贷账户 | 是 | 否 | 否
从账户结构上讲，OKEx又分为主账户和子账户，一个主账户下可以申请个多个子账户，子账户是附属于OKEx主账户的一种账户类型。子账户具有独立的帐号和密码，可以通过主账户分权限管理，将部分资产划转到子账户中，即可独立于主账户进行币币、杠杆、合约、期权等交易。子账户不具备提现功能，可以将子账户的资金划转至主账户，然后通过主账户提现。
子账户不仅可以继承主账户的费率等级和KYC信息，而且主账户和子账户的请求次数独立计算，增加用户交易频率的同时更方便管理。
POST /api/account/v3/transfer
可以将资金从主账户划转到子账户的币币、交割合约等账户，但从子账户划转到主账户时，只能从子账户的资金账户划转到主账户的资金账户。
GET/api/account/v3/sub-account 可以获取子账户中各个账户里的余额、冻结和可用额度等信息。
| 是 否可资金划转 | 是 否可交易 | 是 否独立账号密码 | 是 否独立请求频率 | 是 否独立费率标准 |
是 否独立KYC信息
---|---|---|---|---|---|---
主账户 | 是 | 是 | 是 | 是 | 是 | 是
子账户 | 是（限制如上所述） | 是 | 是 | 是 | 否，同主账户 | 否，同主账户
1 ）币种
币种是指能够转入转出的基本单位，如BTC,ETH,EOS等。
2 ）币对
币对是由交易货币和计价货币组成。以BTC/USDT 为例，BTC 为交易货币，USDT 为计价货币，币对主要在币币交易区和杠杆交易区使用。
3 ）合约ID
合约ID是合约交易的基本单位，其中包括标的货币、保证金类型和交割日期。以BTC- USD-190328为例，BTC为标的货币，USD为保证金类型，190328为交割日期是2019年3月28日。根据保证金类型的不同，可分USD保证金和USDT保证金。
1 ）order_id
订单编号，每个业务线的同一币对下的订单ID是唯一的。
2 ）client_oid
客户自定义编号，为下单时的非必填参数，格式是字母（区分大小写）+数字 或者 纯字母（区分大小写），1-32位字符，建议用户定义的client_oid不要重复，否则多个order_id对应同一个client_oid时，查询将返回最近一个order_id
3 ）trade_id
成交的唯一编号
4 ）ledger_id
账单流水的唯一编号
1 ）limit
限价委托规定了用户愿意买的最高价格或愿意卖的最低价格。用户在设定限价后，市场会以达到对有利方向的价格优先成交。
2 ）market
市价委托类型订单仅需指定下单金额或下单数量，不需要指定价格，订单在进入撮合时，会直接与对手方进行成交，直至金额或数量低于最小成交金额或成交数量为止。市价委托同样受限价机制限制。
3 ）Post only
默认是"只做Maker（Post only）"，不会立刻在市场成交，保证用户始终为Maker；如果委托会立即与已有委托成交，那么该委托会被取消。
4 ）FillOrKill
如果你的委托被设置为"全部成交或立即取消（FillOrKill）"，该委托只会立即全部成交，否则将被取消。
5 ）ImmediatelOrCancel
如果你的委托被设置为"立即成交并取消剩余（ImmediatelOrCancel）"，任何未被成交的部分将被立即取消。
6 ）止盈止损委托
预先设置限价/市价委托及其触发价格，当市场上的最新成交价达到预设的触发价格时，系统将委托送入市场。
7 ）跟踪委托
在行情发生较大幅度回调的情况下，将客户事先设定的委托送入市场的策略。当市场的最新价格达到投资者设定该策略后最高（最低）市场价格的（1±客户设定回调幅度）后，即会触发客户设定的策略，将客户事先设定的委托以市价送入市场中。
8 ）冰山委托
投资者在进行大额交易时，为避免对市场造成过大冲击，将大单委托自动拆为多笔委托，根据当前的最新买一/卖一价格和客户设定的价格策略自动进行小单委托，在上一笔委托被全部成交或最新价格明显偏离当前委托价时，自动重新进行委托。
9 ）时间加权委托
客户希望大额交易BTC时，为避免过大冲击成本，通过策略将大单拆细为多个小额委托，根据最新的对手方委托量自动选择委托量，主动与对手方成交进行连续买入的策略。
1）失败：该状态订单由于余额不足等原因不能校验通过进入撮合队列；
2）等待成交：该状态订单已进入撮合队列当中；
3）部分成交：该状态订单在撮合队列当中，订单的部分数量已经被市场成交，等待剩余部分成交；
4）完全成交：该状态订单在撮合队列当中已与对手方完全成交；
5）下单中：该状态订单正在下单的过程中，因订单最终需挂在撮合队列中才真正下单成功，所以此状态为中间过渡态；
6）撤单中：该状态订单正在被撤销的过程中，因订单最终需在撮合队列中剔除才会被真正撤销，所以此状态为中间过渡态。
本章节主要为撮合引擎的细节分以下四个方面：
- 成交价
- 订单生命周期
- 币币交易限价规则
- 合约交易限价规则
OKEx撮合系统撮合订单的优先级按照价格优于时间的优先级来撮合，优先撮合价格更有优势的订单。当价格一致时按照下单时间顺序撮合，先下单的先撮合。
比如深度列表中目前有3笔挂单等待成交，分别为1: 9900USDT买1BTC，2: 10100USDT买2BTC，3: 9900USDT买1.5BTC。他们是按时间顺序1-2-3进入撮合系统的，根据价格优先，系统优先撮合订单2，根据时间优先，1跟3优先撮合1。所以系统撮合顺序是2-1-3。
订单撮合时成交价将按maker挂单价格成交，而非taker吃单价格。
例如：A用户在10000USDT挂了1BTC的买单，然后B用户以8000USDT的价格下了1BTC的卖单，因为A用户的订单先进入撮合系统挂在深度列表上，所以以A的价格为准，最终这笔订单最终以10000USDT成交。
订单进入撮合引擎后是"等待成交"状态；
如果一个订单被撮合而全部成交，那么它会变成"完全成交"状态；
一个订单被撮合可能出现部分成交，那么它的状态会变成"部分成交"状态，并且继续留在撮合队列中进行撮合；
一个未成交订单撤单成功，，那么它的状态会变成"已撤销"状态；
发起撤销到完成撤销的过程中有一个过程状态"撤单中"；
被撤销或者全部成交的订单将被从撮合队列中剔除。
为了防止用户下错大单造成市场异常波动和个人资金损失，OKEx币币交易设置了FOK限价规则：如果用户在币币交易所下的市价单/限价单可以与当前买卖盘内订单直接成交，那么系统会判断成交深度对应的价格与同方向盘口价的偏差是否超出5%。如果超过，则此订单将被系统立即全数撤销，否则此订单正常进行撮合。
例如：某用户在XRP/BTC交易区下了100BTC的市价买单(此时卖一价为0.00012)，系统判断订单完成成交后最新成交价为0.0002。此时，(0.0002-0.00012)/0.00012=66.7%>5%，用户的这笔市价买单将被立即撤销，不会和买卖盘内订单进行撮合。
一 、交割合约限价机制调整为：
新合约生成10分钟内：最高价=现货指数（1+5%），最低价=现货指数（1-5%）。
合约生成了10分钟后：
最高限价=Min【 Max（Index，Index _1.03+ 过去十分钟溢价均值），Index_1.25】；
最低限价=Max【Min（Index，Index _0.97+ 过去十分钟溢价均值），Index_0.75】；
二 、永续合约限价机制调整为：
新合约生成10分钟内：最高价=现货指数（1+0.5%），最低价=现货指数（1-0.5%）。
合约生成了10分钟后：
最高限价=Min【 Max（Index，Index _1.01+ 过去十分钟溢价均值），Index_1.02】；
最低限价=Max【Min（Index，Index _0.99+ 过去十分钟溢价均值），Index_0.98】；
注：
Index：现货指数价格
过去十分钟溢价均值计算如下：
获取合约、现货指数的过去10分钟的1分钟K线数据，计算每分钟的（开盘价+收盘价）／2，并计算合约及指数的差，对过去10分钟的差值取平均值。
以上规则，适用于所有币种合约（包含USDT合约与币本位合约），合约开平仓都受限制，若开多或平空，当委托价高于最高价，则将触发限价；若开空或平多，当委托价低于最低价，则将触发限价。
本章节主要为费用的细节分以下两个方面：
- 交易费用
- 充/提币费用
OKEx采用maker-taker收费规则，为鼓励挂单，maker挂单成交的手续费会比taker吃单成交的手续费低。
同时，为了鼓励成交，OKEx推出阶梯手续费政策，根据你前30天的累计交易量划分不同的手续费等级，成交量越高，手续费等级越高，手续费越低。
除了手续费优惠，OKEx还为提供流动性的专业用户提供了市商计划。参与市商计划后，只要您能够提供稳定的深度以及盘口点差，即可获得Maker手续费返还。
详情请查看(点击跳转至费率详情页面)
OKEx不收取任何充币/提币费用，提现数字货币的过程中产生的矿工手续费需要用户自己承担。
OKEx的数据库和服务器运行在香港。为了最大限度地减少API访问延迟，建议您使用与香港通讯通畅的服务器。
本章节主要为请求的细节分以下三个方面：
- 介绍
- 错误
- 成功
REST API提供账户管理、行情查询和交易功能。
REST API终端URL https://www.okex.com/
同时OKEx还提供了WebSocket流，订阅WebSocket可以获取行情数据的推送。
WS 地址：wss://real.okex.com:8443/ws/v3
所有请求基于Https协议，请求头信息中Content-Type需要统一设置为:'application/json'
请使用大陆以外的ip地址访问OKEx的API，强烈建议使用香港阿里云服务器。
如果你的服务器在AWS,可以尝试使用我们AWS的网关，有可能会获得更快的速度。
Rest API终端URL：https://aws.okex.com/
WebSocket地址 :wss://awspush.okex.com:8443/ws/v3
不建议用户通过网络代理的方式请求OKEx的api，会造成较高延迟和网络稳定差。
除非特殊说明，错误请求都通过HTTP 4xx或者状态码进行返回，返回内容还将包含错误原因、参数信息。您的HTTP库应配置为非2xx请求提供消息主体，以便您可以从主体读取消息字段。
| 400 | Bad Request -- Invalid request fotmat |
|---|---|
| 401 | Unauthorized -- Invalid API Key |
| 403 | Forbidden -- You do not have access to the requested resource |
| 404 | Not Found |
| 500 | Internal Server Error -- We had a problem with our server |
HTTP状态码200表示成功响应，并可能包含内容。如果响应含有内容，则将显示在相应的返回内容里面。
OKEx对返回数组的有些REST请求使用游标分页。游标分页允许在当前结果页面之前和之后获取结果，并且非常适合实时数据。端点如/ trades，/ fills，/ orders，默认返回最新100项。要检索更多结果，后续请求应根据先前返回的数据指定要分页的方向。
before和after游标可以通过响应头OK-BEFORE和OK-AFTER。在初始请求之后发出页面请求时，您的请求应使用这些游标值。
例 GET /api/spot/v3/orders?before=2&limit=30
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| after | String | |
请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id、ledger_id或trade_id等 |
||
| before | String | |
请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id、ledger_id或trade_id等 |
||
| limit | String | 分页返回的结果集数量，最大为100，不填默认返回100条 |
游标之前和之后 将before光标引用在结果页中的第一项和after光标引用了一组结果的最后一个数据。
headers将包含一个OK- BEFORE标头，该标头将返回光标id，以便在当前页面的下一个页面请求中使用。之前的页面是一个较新的页面，而不是在按时间顺序排列之前发生的页面。 响应还将包含一个OK- AFTER标头，该标头将返回光标id，以便在此页面之后的页面的下一个请求中使用。之后的页面是较旧的页面，而不是按时间顺序排在此页面之后的页面。
1、GET /api/futures/v3/orders/BTC-USD-190628?state=2（返回合约BTC- USD-190628的最近100条全部成交订单）
2、GET /api/futures/v3/orders/BTC-USD-190628?state=2&limit=20（返回合约BTC- USD-190628的最近20条全部成交订单）
3、GET /api/futures/v3/orders/BTC- USD-190628?state=2&after=2512669605501952&limit=20（返回合约order_id=2512669605501952更旧的20条全部成交订单，不包括2512669605501952）
4、GET /api/futures/v3/orders/BTC- USD-190628?state=2&before2512669605501952&limit=20（返回合约order_id=2512669605501952更新的20条全部成交订单，不包括2512669605501952）
本章节主要为标准规范的细节分以下三个方面：
- 时间戳
- 数字
- ID
除非另外指定，API中的所有时间戳均以毫秒为单位返回，符合ISO 8601标准。请确保您可以解析ISO 8601格式。
2014-11-06T10:34:47.123Z
为了保持跨平台时精度的完整性，十进制数字作为字符串返回。建议您在发起请求时也将数字转换为字符串以避免截断和精度错误。
整数（如交易编号和顺序）不加引号。
除非另有说明，大多数标识符是UUID。当提出一个需要UUID的请求时，以下两个形式（有和没有破折号）都被接受。
132fb6ae-456b-4654-b4e0-d681ac05cea1或者132fb6ae456b4654b4e0d681ac05cea1
本章节主要为接口类型的细节分以下两个方面：
- 公共接口
- 私有接口
公共接口可用于获取配置信息和行情数据。公共请求无需认证即可调用。
私有接口可用于订单管理和账户管理。每个私有请求必须使用规范的验证形式进行签名。
私有接口需要使用您的API key进行验证。您可以在这里生成API key。
本章节主要为访问限制的细节分以下两个方面：
- REST API
- WebSocket
当访问超过频率限制时，将返回429状态：请求太频繁。
如果传入有效的API key 用user id限速；如果没有则拿公网IP限速。
限速规则：各个接口上有单独的说明，如果没有一般接口限速为 6次/秒。
特殊说明：批量下单时，若下4个币对，每个币对10个订单时，计为一次请求。
WebSocket将每个命令类型限制为每秒50条命令。
本章节主要为验证的细节分以下五个方面：
- 生成API Key
- 发起请求
- 签名
- 时间戳
- 获取服务器时间
在对任何请求进行签名之前，您必须通过OKEx网站创建一个API Key。创建API Key后，您将获得3个必须记住的信息：
- API Key
- SecretKey
- Passphrase
API Key和SecretKey将由OKEx随机生成和提供，Passphrase将由您提供以确保API访问的安全性。OKEx将存储Passphrase加密后的哈希值进行验证，但如果您忘记Passphrase，则无法恢复，请您通过OKEx网站重新生成新的API Key。
所有REST请求头都必须包含以下内容：
OK-ACCESS-KEY字符串类型的API Key。
OK-ACCESS-SIGN使用base64编码签名(请参阅签名)。
OK-ACCESS-TIMESTAMP发起请求的时间戳。
OK-ACCESS-PASSPHRASE您在创建API密钥时指定的Passphrase。
所有请求都应该含有application/json类型内容，并且是有效的JSON。
OK-ACCESS-SIGN的请求头是对timestamp + method + requestPath + body字符串(+表示字符串连接)，以及secretKey，使用HMAC SHA256方法加密，通过BASE64编码输出而得到的。
例如：sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp + 'GET' + '/users/self/verify', secretKey))
其中，timestamp的值与OK-ACCESS- TIMESTAMP请求头相同，必须是UTC时区Unix时间戳的十进制秒数格式或ISO8601标准的时间格式，精确到毫秒。。
method是请求方法，字母全部大写：GET/POST。
requestPath是请求接口路径。例如：/orders?before=2&limit=30
body是指请求主体的字符串，如果请求没有主体(通常为GET请求)则body可省略。例如：{"product_id":"BTC- USD-0309","order_id":"377454671037440"}
secretKey为用户申请API Key时所生成。例如：22582BD0CFF14C41EDBF1AB98506286D'
public enum ContentTypeEnum {
APPLICATION_JSON("application/json"),
APPLICATION_JSON_UTF8("application/json; charset=UTF-8"),
// The server does not support types
APPLICATION_FORM("application/x-www-form-urlencoded; charset=UTF-8"),;
private String contentType;
ContentTypeEnum(String contentType) {
this.contentType = contentType;
}
public String contentType() {
return contentType;
}
}
public enum HttpHeadersEnum {
OK_ACCESS_KEY("OK-ACCESS-KEY"),
OK_ACCESS_SIGN("OK-ACCESS-SIGN"),
OK_ACCESS_TIMESTAMP("OK-ACCESS-TIMESTAMP"),
OK_ACCESS_PASSPHRASE("OK-ACCESS-PASSPHRASE"),
OK_FROM("OK-FROM"),
OK_TO("OK-TO"),
OK_LIMIT("OK-LIMIT"),;
private String header;
HttpHeadersEnum(String header) {
this.header = header;
}
public String header() {
return header;
}
}
import com.okcoin.commons.okex.open.api.config.APIConfiguration;
import com.okcoin.commons.okex.open.api.constant.APIConstants;
import com.okcoin.commons.okex.open.api.enums.ContentTypeEnum;
import com.okcoin.commons.okex.open.api.enums.HttpHeadersEnum;
import com.okcoin.commons.okex.open.api.exception.APIException;
import com.okcoin.commons.okex.open.api.utils.DateUtils;
import com.okcoin.commons.okex.open.api.utils.HmacSHA256Base64Utils;
import okhttp3.*;
import okio.Buffer;
public class APIHttpClient {
private APIConfiguration config;
private APICredentials credentials;
public APIHttpClient(APIConfiguration config, APICredentials credentials) {
this.config = config;
this.credentials = credentials;
}
public OkHttpClient client() {
OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder();
clientBuilder.connectTimeout(this.config.getConnectTimeout(), TimeUnit.SECONDS);
clientBuilder.readTimeout(this.config.getReadTimeout(), TimeUnit.SECONDS);
clientBuilder.writeTimeout(this.config.getWriteTimeout(), TimeUnit.SECONDS);
clientBuilder.retryOnConnectionFailure(this.config.isRetryOnConnectionFailure());
clientBuilder.addInterceptor((Interceptor.Chain chain) -> {
Request.Builder requestBuilder = chain.request().newBuilder();
String timestamp = DateUtils.getUnixTime();
requestBuilder.headers(headers(chain.request(), timestamp));
Request request = requestBuilder.build();
if (this.config.isPrint()) {
printRequest(request, timestamp);
}
return chain.proceed(request);
});
return clientBuilder.build();
}
private Headers headers(Request request, String timestamp) {
Headers.Builder builder = new Headers.Builder();
builder.add(APIConstants.ACCEPT, ContentTypeEnum.APPLICATION_JSON.contentType());
builder.add(APIConstants.CONTENT_TYPE, ContentTypeEnum.APPLICATION_JSON_UTF8.contentType());
builder.add(APIConstants.COOKIE, getCookie());
if (StringUtils.isNotEmpty(this.credentials.getSecretKey())) {
builder.add(HttpHeadersEnum.OK_ACCESS_KEY.header(), this.credentials.getApiKey());
builder.add(HttpHeadersEnum.OK_ACCESS_SIGN.header(), sign(request, timestamp));
builder.add(HttpHeadersEnum.OK_ACCESS_TIMESTAMP.header(), timestamp);
builder.add(HttpHeadersEnum.OK_ACCESS_PASSPHRASE.header(), this.credentials.getPassphrase());
}
return builder.build();
}
private String getCookie() {
StringBuilder cookie = new StringBuilder();
cookie.append(APIConstants.LOCALE).append(this.config.getI18n().i18n());
return cookie.toString();
}
private String sign(Request request, String timestamp) {
String sign;
try {
sign = HmacSHA256Base64Utils.sign(timestamp, method(request), requestPath(request),
queryString(request), body(request), this.credentials.getSecretKey());
} catch (IOException e) {
throw new APIException("Request get body io exception.", e);
} catch (CloneNotSupportedException e) {
throw new APIException("Hmac SHA256 Base64 Signature clone not supported exception.", e);
} catch (InvalidKeyException e) {
throw new APIException("Hmac SHA256 Base64 Signature invalid key exception.", e);
}
return sign;
}
private String url(Request request) {
return request.url().toString();
}
private String method(Request request) {
return request.method().toUpperCase();
}
private String requestPath(Request request) {
String url = url(request);
url = url.replace(this.config.getEndpoint(), APIConstants.EMPTY);
String requestPath = url;
if (requestPath.contains(APIConstants.QUESTION)) {
requestPath = requestPath.subString(0, url.lastIndexOf(APIConstants.QUESTION));
}
if(this.config.getEndpoint().endsWith(APIConstants.SLASH)){
requestPath = APIConstants.SLASH + requestPath;
}
return requestPath;
}
private String queryString(Request request) {
String url = url(request);
String queryString = APIConstants.EMPTY;
if (url.contains(APIConstants.QUESTION)) {
queryString = url.subString(url.lastIndexOf(APIConstants.QUESTION) + 1);
}
return queryString;
}
private String body(Request request) throws IOException {
RequestBody requestBody = request.body();
String body = APIConstants.EMPTY;
if (requestBody != null) {
Buffer buffer = new Buffer();
requestBody.writeTo(buffer);
body = buffer.readString(APIConstants.UTF_8);
}
return body;
}
}
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;
import java.util.List;
interface FuturesMarketAPI {
@GET("/api/futures/v3/products/{instrument_id}/candles")
Call<JSONArray> getProductCandles(@Path("instrument_id") String productId, @Query("start") String start, @Query("end") String end, @Query("granularity") String granularity);
}
import com.alibaba.fastjson.JSONArray;
import com.okcoin.commons.okex.open.api.bean.futures.result.*;
import com.okcoin.commons.okex.open.api.client.APIClient;
import com.okcoin.commons.okex.open.api.config.APIConfiguration;
import com.okcoin.commons.okex.open.api.service.futures.FuturesMarketAPIService;
public class FuturesMarketAPIServiceImpl implements FuturesMarketAPIService {
private APIClient client;
private FuturesMarketAPI api;
public FuturesMarketAPIServiceImpl(APIConfiguration config) {
this.client = new APIClient(config);
this.api = client.createService(FuturesMarketAPI.class);
}
@Override
public JSONArray getProductCandles(String productId, long start, long end, long granularity) {
return this.client.executeSync(this.api.getProductCandles(productId, String.valueOf(start), String.valueOf(end), String.valueOf(granularity)));
}
}
import okhttp3.Headers;
import okhttp3.OkHttpClient;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import retrofit2.Call;
import retrofit2.Response;
import retrofit2.Retrofit;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
public class APIClient {
/**
* Synchronous send request
*/
public <T> T executeSync(Call<T> call) {
try {
Response<T> response = call.execute();
if (this.config.isPrint()) {
printResponse(response);
}
int status = response.code();
String message = new StringBuilder().append(response.code()).append(" / ").append(response.message()).toString();
if (response.isSuccessful()) {
return response.body();
} else if (APIConstants.resultStatusArray.contains(status)) {
HttpResult result = JSON.parseObject(new String(response.errorBody().bytes()), HttpResult.class);
result.setStatusCode(status);
throw new APIException(result.message());
} else {
throw new APIException(message);
}
} catch (IOException e) {
throw new APIException("APIClient executeSync exception.", e);
}
}
}
public class FuturesAPIBaseTests extends BaseTests {
public APIConfiguration config() {
APIConfiguration config = new APIConfiguration();
config.setEndpoint("https://www.okex.com/");
config.setApiKey("");
config.setSecretKey("");
config.setPassphrase("");
config.setPrint(true);
config.setI18n(I18nEnum.ENGLISH);
return config;
}
String productId = "BTC-USD-180928";
}
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONArray;
import com.okcoin.commons.okex.open.api.bean.futures.result.*;
import com.okcoin.commons.okex.open.api.service.futures.FuturesMarketAPIService;
import com.okcoin.commons.okex.open.api.service.futures.impl.FuturesMarketAPIServiceImpl;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
public class FuturesMarketAPITests extends FuturesAPIBaseTests {
private FuturesMarketAPIService marketAPIService;
@Before
public void before() {
config = config();
marketAPIService = new FuturesMarketAPIServiceImpl(config);
}
@Test
public void testGetProductCandles() {
long start = System.currentTimeMillis();
long end = System.currentTimeMillis() + 2000L;
JSONArray array = marketAPIService.getProductCandles(productId, 1530323640000L, 0, 180L);
toResultString(LOG, "Product-Candles", array);
}
}
package okex
import (
"bytes"
"errors"
"fmt"
"io/ioutil"
"net/http"
"strconv"
"Strings"
"time"
)
type Client struct {
Config Config
HttpClient *http.Client
}
type ApiMessage struct {
Message String `json:"message"`
}
/*
Get a http client
*/
func NewClient(config Config) *Client {
var client Client
client.Config = config
timeout := config.TimeoutSecond
if timeout <= 0 {
timeout = 30
}
client.HttpClient = &http.Client{
Timeout: time.Duration(timeout) * time.Second,
}
return &client
}
/*
Send a http request to remote server and get a response data
*/
func (client *Client) Request(method String, requestPath String,
params, result interface{}) (response *http.Response, err error) {
config := client.Config
// uri
endpoint := config.Endpoint
if Strings.HasSuffix(config.Endpoint, "/") {
endpoint = config.Endpoint[0:len(config.Endpoint)-1]
}
url := endpoint + requestPath
// get json and bin styles request body
var jsonBody String
var binBody = bytes.NewReader(make([]byte, 0))
if params != nil {
jsonBody, binBody, err = ParseRequestParams(params)
if err != nil {
return response, err
}
}
// get a http request
request, err := http.NewRequest(method, url, binBody)
if err != nil {
return response, err
}
// Sign and set request headers
timestamp := IsoTime()
preHash := PreHashString(timestamp, method, requestPath, jsonBody)
sign, err := HmacSha256Base64Signer(preHash, config.SecretKey)
if err != nil {
return response, err
}
Headers(request, config, timestamp, sign)
if config.IsPrint {
printRequest(config, request, jsonBody, preHash)
}
// send a request to remote server, and get a response
response, err = client.HttpClient.Do(request)
if err != nil {
return response, err
}
defer response.Body.Close()
// get a response results and parse
status := response.StatusCode
message := response.Status
body, err := ioutil.ReadAll(response.Body)
if err != nil {
return response, err
}
if config.IsPrint {
printResponse(status, message, body)
}
response.Header.Add(ResultJsonString, String(body))
if status >= 200 && status < 300 {
if body != nil && result != nil {
err := JsonBytes2Struct(body, result)
if err != nil {
return response, err
}
}
return response, nil
} else if status == 400 || status == 401 || status == 500 {
if body != nil {
var apiMessage ApiMessage
err := JsonBytes2Struct(body, &apiMessage)
if err != nil {
return response, err
}
message = strconv.Itoa(status) + " " + apiMessage.Message
}
return response, errors.New(message)
} else {
return response, errors.New(message)
}
return response, nil
}
type Config struct {
// Rest api endpoint url. eg: http://www.okex.com/
Endpoint String
// The user's api key provided by OKEx.
ApiKey String
// The user's secret key provided by OKEx. The secret key used to sign your request data.
SecretKey String
// The Passphrase will be provided by you to further secure your API access.
Passphrase String
// Http request timeout.
TimeoutSecond int
// Whether to print API information
IsPrint bool
// Internationalization @see file: constants.go
I18n String
}
func (client *Client) GetFuturesProductCandles(productId String, start, end, granularity int64) ([][] float64, error) {
var candles [][] float64
params := NewParams()
params["start"] = Int642String(start)
params["end"] = Int642String(end)
params["granularity"] = Int642String(granularity)
requestPath := BuildParams(FuturesPathPrefix+"products/"+productId+"/candles", params)
_, err := client.Request(GET, requestPath, nil, &candles)
return candles, err
}
func NewTestClient() *Client {
// Set OKEX API's config
var config Config
config.Endpoint = "https://www.okex.com/"
config.ApiKey = ""
config.SecretKey = ""
config.Passphrase = ""
config.TimeoutSecond = 45
config.IsPrint = false
config.I18n = ENGLISH
client := NewClient(config)
return client
}
import "testing"
const (
productId = "BTC-USD-180928"
currency = "BTC"
)
func TestGetFuturesProductCandles(t *testing.T) {
start := int64(0)
end := int64(0)
candles, err := NewTestClient().GetFuturesProductCandles(productId, start, end, 180)
if err != nil {
t.Error(err)
}
FmtPrintln(GUnitTest+"Futures product candles: ", candles)
}
String OKEXAPI::GetSign(String timestamp, String method, String requestPath, String body) {
String sign;
unsigned char * mac = NULL;
unsigned int mac_length = 0;
String data = timestamp + method + requestPath + body;
String key = m_config.SecretKey;
int ret = HmacEncode("sha256", key.c_str(), key.length(), data.c_str(), data.length(), mac, mac_length);
sign = base64_encode(mac, mac_length);
return sign;
}
String OKEXAPI::Request(const String &method, const String &requestPath, const String ¶ms) {
/************************** set request method ***************************/
http_request request;
request.set_method(method);
/************************** set request uri ***************************/
uri_builder builder;
builder.append_path(requestPath);
request.set_request_uri(builder.to_uri());
/************************** set request headers ***************************/
char * timestamp = new char[32];
timestamp = GetTimestamp(timestamp, 32);
String sign = GetSign(timestamp, method, builder.to_String(), params);
request.headers().clear();
request.headers().add(U("OK-ACCESS-KEY"), m_config.ApiKey);
request.headers().add(U("OK-ACCESS-SIGN"), sign);
request.headers().add(U("OK-ACCESS-TIMESTAMP"), timestamp);
request.headers().add(U("OK-ACCESS-PASSPHRASE"), m_config.Passphrase);
request.headers().add(U("Accept"), U("application/json"));
request.headers().set_content_type(U("application/json; charset=UTF-8"));
request.headers().add(U("Cookie"),U("locale="+m_config.I18n));
/************************** set request body ***************************/
request.set_body(params,"application/json; charset=UTF-8");
/************************** get response ***************************/
http_response response;
String str;
http_client client(m_config.Endpoint);
response = client.request(request).get();
str = response.extract_String(true).get();
delete []timestamp;
return str;
}
String GetSpotOrdersExample() {
OKEXAPI okexapi;
/************************** set config **********************/
struct Config config;
config.Endpoint = "https://www.okex.com";
config.SecretKey = "";
config.ApiKey = "";
config.Passphrase = "";
okapi.SetConfig(config);
/************************** set parameters **********************/
String method(GET);
map<String,String> m;
m.insert(make_pair("productId", "BTC-USD"));
m.insert(make_pair("status", "all"));
/************************** request and response **********************/
String request_path = BuildParams("/api/spot/v3/orders", m);
return okexapi.Request(method, request_path);
}
String AddSpotOrderExample() {
OKEXAPI okexapi;
/************************** set config **********************/
struct Config config;
config.Endpoint = "https://www.okex.com";
config.SecretKey = "";
config.ApiKey = "";
config.Passphrase = "";
okapi.SetConfig(config);
/************************** set parameters **********************/
value obj;
obj["size"] = value::number(1);
obj["price"] = value::number(8);
obj["side"] = value::String("buy");
obj["instrument_id"] = value::String("BTC-USD");
/************************** request and response **********************/
String params = obj.serialize();
return okexapi.Request(POST, "/api/spot/v3/orders", params);
}
}
import hmac
import base64
import requests
import json
CONTENT_TYPE = 'Content-Type'
OK_ACCESS_KEY = 'OK-ACCESS-KEY'
OK_ACCESS_SIGN = 'OK-ACCESS-SIGN'
OK_ACCESS_TIMESTAMP = 'OK-ACCESS-TIMESTAMP'
OK_ACCESS_PASSPHRASE = 'OK-ACCESS-PASSPHRASE'
APPLICATION_JSON = 'application/json'
# signature
def signature(timestamp, method, request_path, body, secret_key):
if str(body) == '{}' or str(body) == 'None':
body = ''
message = str(timestamp) + str.upper(method) + request_path + str(body)
mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), digestmod='sha256')
d = mac.digest()
return base64.b64encode(d)
# set request header
def get_header(api_key, sign, timestamp, passphrase):
header = dict()
header[CONTENT_TYPE] = APPLICATION_JSON
header[OK_ACCESS_KEY] = api_key
header[OK_ACCESS_SIGN] = sign
header[OK_ACCESS_TIMESTAMP] = str(timestamp)
header[OK_ACCESS_PASSPHRASE] = passphrase
return header
def parse_params_to_str(params):
url = '?'
for key, value in params.items():
url = url + str(key) + '=' + str(value) + '&'
return url[0:-1]
# Example Request
# set the request url
base_url = 'https://www.okex.com'
request_path = '/api/account/v3/currencies'
# set request header
header = get_header('your_api_key', signature('timestamp', 'GET', request_path, 'your_secret_key'), 'timestamp', 'your_passphrase')
# do request
response = requests.get(base_url + request_path, headers=header)
# json
print(response.json())
# [{
# "id": "BTC",
# "name": "Bitcoin"，
# "deposit": "1",
# "withdraw": "1",
# "withdraw_min":"0.000001btc"
# }, {
# "id": "ETH",
# "name": "Ethereum",
# "deposit": "1",
# "withdraw": "1"，
# "withdraw_min":"0.0001eth"
# }
# …
# ]
########################################################
# take order
base_url = 'https://www.okex.com'
request_path = '/api/spot/v3/orders'
# request params
params = {'type': 'market', 'side': 'buy', 'instrument_id': 'usdt_okb', 'size': '10', 'client_oid': '',
'price': '10', 'funds': ''}
# request path
request_path = request_path + parse_params_to_str(params)
url = base_url + request_path
# request header and body
header = get_header('your_api_key', signature('timestamp', 'POST', request_path, 'your_secret_key'), 'timestamp', 'your_passphrase')
body = json.dumps(params)
# do request
response = requests.post(url, data=body, headers=header)
#########################################################
# get order info
base_url = 'https://www.okex.com'
request_path = '/api/spot/v3/orders'
params = {'status':'all', 'instrument_id': 'okb_usdt'}
# request path
request_path = request_path + parse_params_to_str(params)
url = base_url + request_path
# request header and body
header = get_header('your_api_key', signature('timestamp', 'GET', request_path, 'your_secret_key'), 'timestamp', 'your_passphrase')
# do request
response = requests.get(url, headers=header)
OK-ACCESS-TIMESTAMP请求头必须是UTC时区Unix时间戳的十进制秒数格式或ISO8601标准的时间格式，精确到毫秒
时间戳和服务器时间前后相差30秒以上的请求将被系统视为过期并拒绝。如果您认为服务器和API服务器之间存在较大的时间偏差，那么我们建议您使用获取服务器时间的接口来查询API服务器时间。
获取API服务器的时间。此接口为公共接口，不需要身份验证。
GET /api/general/v3/time
| 参数名 | 描述 |
|---|---|
| iso | ISO8601标准的时间格式 |
| epoch | UTC时区Unix时间戳的十进制秒数格式 |
{
"iso": "2015-01-07T23:47:25.201Z",
"epoch": 1420674445.201
}
在您开启OKEx交易之前，可以在我们提供的测试网站上模拟交易，测试API接口相关功能，并调试您的代码交易逻辑。
测试网站目前支持的业务线为：交割合约，期权交易。
测试网站逐渐会开放的业务线为：币币交易，币币杠杆，永续合约。
测试网站的API交易功能所需的APIkey，需要在[这里](https://testnet.okex.com/account/my- api)进行创建APIkey，测试网创建APIkey的流程与OKEx一致。
测试网站域名如下：
RestAPI Url ：https://testnet.okex.com
Websocket 地址: wss://real.okex.com:8443/ws/v3?brokerId=181
测试网的登陆账户与OKEx登录账户是互通的，如果您已经有okex账户，可以直接登录。如果没有，请进点击这里进行注册。
以下步骤开启API模拟交易：
注 册okex账户-->登录测试网-->领取测试币-->创建测试网APIkey---->开始模拟交易
测试网站，用户可以通过API请求交割合约和期权的所有接口，包括基本合约信息、市场行情信息、账户余额信息、持仓信息、订单信息等，详细接口功能请查看测试网的 API文档。
资金账户主账户与交易账户/子账户之间的资金划转，获取充值地址，提现等功能。
获取资金账户所有资产列表，查询各币种的余额、冻结和可用等信息。
GET/api/account/v3/wallet
GET/api/account/v3/wallet
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 币种，如BTC |
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用余额 |
[
{
"available":"37.11827078",
"balance":"37.11827078",
"currency":"ETH",
"hold":"0"
},
{
"available":"0",
"balance":"0",
"currency":"BTC",
"hold":"0"
}
]
获取资金账户单个币种的余额、冻结和可用等信息。
GET/api/account/v3/wallet/<currency>
GET/api/account/v3/wallet/XMR
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用余额 |
| currency | String | 币种，如BTC |
[{
"balance":"300.00000000",
"available":"300.00000000",
"currency":"BTC",
"hold":"0.00000000"
}]
OKEx站内在资金账户、交易账户和子账户之间进行资金划转。
POST /api/account/v3/transfer
POST /api/account/v3/transfer{"currency":"usdt","amount":1.5,"from":6,"to":3,"to_instrument_id":"btc- usdt"}（usdt从资金账户划转到交割btc-usdt合约账户）
POST /api/account/v3/transfer{"currency":"usdt","amount":1.5,"from":3,"to":1,"instrument_id":"btc- usdt"}（usdt从交割btc-usdt合约账户划转到币币账户）
POST /api/account/v3/transfer{"currency":"btc","amount":1.5,"from":6,"to":3}（btc从资金账户划转到交割btc- usd合约账户）
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种，如usdt |
| amount | String | 是 | 划转数量 |
| type | String | 是 | |
0:母/子账户中各个账户之间划转 |
|||
1:母账户转子账号 |
|||
2:子账户转母账号 默认为0 |
|||
| from | String | 是 | 转出账户 |
1:币币账户 |
|||
3:交割合约 |
|||
4:法币账户 |
|||
5:币币杠杆账户 |
|||
6:资金账户 |
|||
8:余币宝账户 |
|||
9:永续合约账户 |
|||
12:期权合约 |
|||
14:挖矿账户 |
|||
17:借贷账户 |
|||
| to | String | 是 | 转入账户 |
1:币币账户 |
|||
3:交割合约 |
|||
4:法币账户 |
|||
5:币币杠杆账户 |
|||
6:资金账户 |
|||
8:余币宝账户 |
|||
9:永续合约账户 |
|||
12:期权合约 |
|||
14:挖矿账户 |
|||
17:借贷账户 |
|||
| sub_account | String | 否 | 子账号登录名，type为1、2、时，sub_account为必填项 |
| instrument_id | String | 否 | 杠杆转出币对 或者 usdt保证金合约转出的underlying，如：`btc- |
| usdt`，仅限已开通杠杆币对或者合约的underlying。 | |||
| to_instrument_id | String | 否 | 杠杆转入币对 或者 usdt保证金合约转入的underlying，如：`btc- |
| usdt`，仅限已开通杠杆币对或者合约的underlying。 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| transfer_id | String | 划转ID |
| currency | String | 划转币种 |
| from | String | 转出账户 |
| amount | String | 划转量 |
| to | String | 转入账户 |
| result | Boolean | 划转结果。若是划转失败，将给出错误码提示 |
from或to指定为3或5时，instrument_id为必填项。
{
"transfer_id": "754147",
"currency": "ETC",
"from": "6",
"amount": "0.1",
"to": "1",
"result": true
}
POST /api/account/v3/withdrawal
POST /api/account/v3/withdrawal{"amount":1,"fee":0.0005,"trade_pwd":"123456","destination":4,"currency":"btc","to_address":"17DKe3kkkkiiiiTvAKKi2vMPbm1Bz3CMKw"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种 |
| amount | String | 是 | 数量 |
| destination | String | 是 | 提币到 |
3:OKEx; 4:数字货币地址; 68:币全CoinAll;89:OKEx Korea; |
|||
90:4A交易平台;104:MY1EX;107:BFEX;108:99EX; |
|||
113:ETHEX.COM以太坊交易所;116:雷爵爾交易所; 125:PICKCOIN;136:FT交易所; |
|||
152:xFutures; 153:Float SV; 158:理想国;161:币爱交易所; |
|||
163:BOOMEX; 172:币可富; 173:VVCOIN; 174:Huoblock; |
|||
175:JIAMIX; 176:币海; 177:币尚; 178:七十三街交易所) |
|||
| to_address | String | 是 | |
认证过的数字货币地址、邮箱或手机号。某些数字货币地址格式为:地址+标签，例：ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456 |
|||
| trade_pwd | String | 是 | 交易密码 |
| fee | String | 是 | 网络手续费≥0，提币到数字货币地址所需网络手续费可通过提币手续费接口查询 |
关于标签：某些币种如xrp充币时同时需要一个充值地址和标签(又名tag/memo/payment_id/标签等)，标签是一种保证您的充币地址唯一性的数字串，与充币地址成对出现并一一对应。请您务必遵守正确的充值步骤，在提币时输入完整信息，否则将面临丢失币的风险！
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 提币币种 |
| amount | String | 提币数量 |
| withdraw_id | String | 提币申请ID |
| result | Boolean | 提币申请结果。若是提现申请失败，将给出错误码提示 |
{
"amount":"0.1",
"withdrawal_id":"67485",
"currency":"btc",
"result":true
}
查询资金账户账单流水，可查询最近一个月的数据。
GET/api/account/v3/ledger
GET/api/account/v3/ledger?type=2¤cy=btc&after=9260348&limit=10
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 否 | 币种，如BTC ，不填时返回所有的账单流水 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id等 |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id等 |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| type | String | 否 | 1: 充值 |
2: 提现 |
|||
13: 撤销提现 |
|||
18: 转入交割合约账户 |
|||
19: 交割合约账户转出 |
|||
20: 转入子账户 |
|||
21: 子账户转出 |
|||
28: 领取 |
|||
29: 转入指数交易区 |
|||
30: 指数交易区转出 |
|||
31: 转入法币账户 |
|||
32: 法币账户转出 |
|||
33: 转入币币杠杆账户 |
|||
34: 币币杠杆账户转出 |
|||
37: 转入币币账户 |
|||
38: 币币账户转出 |
|||
41: 点卡抵扣手续费 |
|||
42: 购买点卡 |
|||
43: 点卡转让 |
|||
44: 撤销点卡转让 |
|||
47: 系统冲正 |
|||
48: 活动得到 |
|||
49: 活动送出 |
|||
50: 预约得到 |
|||
51: 预约扣除 |
|||
52: 发红包; 53: 抢红包 |
|||
54: 红包退还 |
|||
55: 转入永续合约账户 |
|||
56: 永续合约账户转出 |
|||
57: 转入余币宝 |
|||
58: 余币宝转出 |
|||
59: 套保账户转出; |
|||
60: 转入套保账户 |
|||
61: 兑换 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| ledger_id | String | 账单ID |
| currency | String | 币种 |
| balance | String | 余额 |
| amount | String | 变动数量 |
| typename | String | 账单类型 |
| fee | String | 手续费 |
| timestamp | String | 账单创建时间 |
[
{
"amount":"-0.00100941",
"balance":"0",
"currency":"BTC",
"fee":"0",
"ledger_id":"9260348",
"timestamp":"2018-10-19T01:12:21.000Z",
"typename":"To: spot account"
},
{
"amount":"0.00051843",
"balance":"0.00100941",
"currency":"BTC",
"fee":"0",
"ledger_id":"8987285",
"timestamp":"2018-10-12T11:01:14.000Z",
"typename":"Get from activity"
}
]
获取各个币种的充值地址，包括曾使用过的老地址。
GET/api/account/v3/deposit/address
GET/api/account/v3/deposit/address?currency=eos
| 参数 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种，如BTC |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| address | String | 充值地址 |
| tag | String | 部分币种提币需要标签，若不需要则不返回此字段 |
| memo | String | 部分币种提币需要标签，若不需要则不返回此字段 |
| payment_id | String | 部分币种提币需要此字段，若不需要则不返回此字段 |
| currency | String | 币种，如BTC |
| to | String | 转入账户 |
0:子账户 |
||
1:币币 |
||
3:合约 |
||
4:C2C |
||
5:币币杠杆 |
||
6:资金账户 |
||
8:余币宝 |
||
9:永续合约 |
||
12:期权 |
IOTA充值地址不能重复使用！在向IOTA地址发起充值后，再次充值到此相同地址将不会被确认到账。
某些币充值到账，需要同时填写OKEx返回的充值地址和一个tag/payment_id/memo。如果未遵守正确的充值步骤，币会丢失！
[
{
"address": "okbtothemoon",
"memo": "971668",
"currency": "eos",
"to": 6
}
]
按照btc或法币计价单位，获取账户总资产的估值。
GET/api/account/v3/asset-valuation
GET/api/account/v3/asset-valuation?account_type=1&valuation_currency=btc
| 参数 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| account_type | String | 否 | 获取某一个业务线资产估值。0.预估总资产 |
| 1.币币账户 | |||
| 3.交割账户 | |||
| 4.法币账户 | |||
| 5.币币杠杆 | |||
| 6.资金账户 | |||
| 8. 余币宝账户 | |||
| 9.永续合约 | |||
| 12.期权 | |||
| 14.挖矿账户 | |||
| 15.交割usdt保证金账户 | |||
| 16.永续usdt保证金账户 | |||
| 默认为0，查询总资产 | |||
| valuation_currency | String | 否 | 按照某一个法币为单位的估值，只能是下列之一 |
| " BTC USD CNY JPY KRW RUB " | |||
| 默认以 BTC 为单位 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| valuation_currency | String | 按照某一个法币为单位的估值，如BTC |
| balance | String | 预估资产 |
| timestamp | String | 数据返回时间 |
| account_type | String | 账户类型 |
{
"account_type": "0",
"balance": 0.00878181,
"valuation_currency": "BTC",
"timestamp": "2019-12-09 10:28:23"
}
母账户获取子账户的各个账户里的资金余额信息。
GET/api/account/v3/sub-account
GET/api/account/v3/sub-account?sub-account=Test
| 参数 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| sub-account | String | 是 | 子账户账户名 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| balance | String | 账户余额 （可用余额和冻结余额的总和） |
| hold | String | 冻结（不可用） |
| available | String | 可用余额 --币币和资金 |
| equity | String | 账户权益 --交割和永续 |
| max_withdraw | String | 可划转数量 |
| currency | String | 币种，如BTC |
| sub_account | String | 账户名 |
| asset_valuation | String | 以btc为单位 账户资产总估值 |
| account_type | String | 子账户里的 账户类型 |
| 1.币币账户 | ||
| 3.交割账户 | ||
| 4.法币账户 | ||
| 5.币币杠杆 | ||
| 6.资金账户账户 | ||
| 8. 余币宝账户 | ||
| 9.永续合约账户 | ||
| 12.期权账户 | ||
| 14.挖矿账户 |
{
"data": {
"sub_account": "Test",
"asset_valuation": 0.00003463,
"account_type:futures": [
{
"balance": 0.00000245,
"max_withdraw": 0.00000245,
"currency": "BTC",
"underlying": "BTC_USD",
"equity": 0.00000245
},
{
"balance": 1.053473,
"max_withdraw": 1.053473,
"currency": "XRP",
"underlying": "XRP_USD",
"equity": 1.053473
}
],
"account_type:spot": [
{
"balance": 0.000312544038152,
"max_withdraw": 0.000312544038152,
"available": 0.000312544038152,
"currency": "USDT",
"hold": 0
}
]
}
}
查询最近所有币种的提币记录，为最近100条记录。
GET/api/account/v3/withdrawal/history
GET/api/account/v3/withdrawal/history
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 币种 |
| amount | String | 数量 |
| timestamp | String | 提币申请时间 |
| from | String | 提币地址（如果收币地址是OKEx平台地址，则此处将显示用户账户） |
| to | String | 收币地址 |
| tag | String | 部分币种提币需要标签，若不需要则不返回此字段 |
| payment_id | String | 部分币种提币需要此字段，若不需要则不返回此字段 |
| memo | String | 部分币种提币需要此字段，若不需要则不返回此字段 |
| txid | String | 提币哈希记录（内部转账将不返回此字段） |
| fee | String | 提币手续费 |
| status | String | 提现状态 |
-3:撤销中 |
||
-2:已撤销 |
||
-1:失败 |
||
0:等待提现 |
||
1:提现中 |
||
2:已汇出 |
||
3:邮箱确认 |
||
4:人工审核中 |
||
5:等待身份认证 |
||
| withdrawal_id | String | 提币申请ID |
此处的from显示的是用户OKEx账户，并不等于区块链上实际的发币地址，如果提币到OKEx则to显示为OKEx账户，此时将不返回txid
返回所有币种最近100条提币记录，若想查询更多请分币对查询。
注意此处显示的最新提币记录可能还没有在区块上打包成功，若此处有提币记录而实际未到账，请耐心等待
[
{
"amount":"0.094",
"withdrawal_id": "4703879",
"fee":"0.01000000eth",
"txid":"0x62477bac6509a04512819bb1455e923a60dea5966c7caeaa0b24eb8fb0432b85",
"currency":"ETH",
"from":"13426335357",
"to":"0xA41446125D0B5b6785f6898c9D67874D763A1519",
"timestamp":"2018-04-22T23:09:45.000Z",
"status":"2"
},
{
"amount":"0.01",
"withdrawal_id": "4703879",
"fee":"0.00000000btc",
"txid":"",
"currency":"BTC",
"from":"13426335357",
"to":"13426335357",
"timestamp":"2018-05-17T02:43:08.000Z",
"status":"2"
}
]
查询单个币种的提币记录。
GET/api/account/v3/withdrawal/history/<currency>
GET/api/account/v3/withdrawal/history/btc
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| amount | String | 数量 |
| currency | String | 币种 |
| timestamp | String | 提币申请时间 |
| from | String | 提币地址（如果收币地址是OKEx平台地址，则此处将显示用户账户） |
| to | String | 收币地址 |
| tag | String | 部分币种提币需要标签，若不需要则不返回此字段 |
| payment_id | String | 部分币种提币需要此字段，若不需要则不返回此字段 |
| memo | String | 部分币种提币需要此字段，若不需要则不返回此字段 |
| txid | String | 提币哈希记录（内部转账将不返回此字段） |
| fee | String | 提币手续费和对应币种，如0.00000009btc |
| status | String | 提现状态 |
-3:撤销中 |
||
-2:已撤销 |
||
-1:失败 |
||
0:等待提现 |
||
1:提现中 |
||
2:已汇出 |
||
3:邮箱确认 |
||
4:人工审核中 |
||
5:等待身份认证 |
||
| withdrawal_id | String | 提币申请ID |
此处的from显示的是用户OKEx账户，并不等于区块链上实际的发币地址，如果提币到OKEx则to也显示为OKEx账户，此时将不OKEx账户，此时将不返回txid
返回所有币种最近100条提币记录，若想查询更多请分币对查询。 注意此处显示的最新提币记录可能还没有在区块上打包成功，若此处有提币记录而实际未到账，请耐心等待
[
{
"amount":"0.01105486",
"withdrawal_id": "4703879",
"fee":"0.00000000btc",
"txid": "66602e279569ba319a929f5bda731d228962bc67cd89dfa0d432d82722681d66",
"currency": "BTC",
"from":"13426335357",
"to":"13426335357",
"timestamp":"2018-09-30T02:49:29.000Z",
"status":"2"
},
{
"amount":"0.01144408",
"withdrawal_id": "4703859",
"fee":"0.00000000btc",
"txid": "66602e279569ba319a929f5bda731d228962456475467d89dfa0d432d82722681d66",
"currency": "BTC",
"from":"13426335357",
"to":"13426335357",
"timestamp":"2018-09-18T00:44:56.000Z",
"status":"2"
}
]
获取所有币种的充值记录，为最近一百条数据（一年内）。
GET/api/account/v3/deposit/history
GET/api/account/v3/deposit/history
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 币种名称，如：btc |
| amount | String | 充值数量 |
| from | String | 充值地址，只显示内部账户转账地址，不显示区块链充值地址 |
| to | String | 到账地址 |
| txid | String | 区块转账哈希记录 |
| timestamp | String | 充值到账时间 |
| status | String | 充值状态 |
0:等待确认 |
||
1:确认到账 |
||
2:充值成功 |
||
| deposit_id | String | 充值记录D |
[
{
"amount":"0.01044408",
"txid":"1915737_3_0_0_WALLET",
"currency":"BTC",
"from": "13801825426",
"to":"",
"timestamp":"2018-09-30T02:45:50.000Z",
"status":"2"
"deposit_id": "4703879",
},
{
"amount":"491.6784211",
"txid":"1744594_3_184_0_WALLET",
"currency":"OKB",
"from": "",
"to":"",
"timestamp":"2018-08-21T08:03:10.000Z",
"status":"2"
"deposit_id": "4703809",
},
{
"amount":"223.18782496",
"txid":"6d892c669225b1092c780bf0da0c6f912fc7dc8f6b8cc53b003288624c",
"currency":"USDT",
"from": "",
"to":"39kK4XvgEuM7rX9frgyHoZkWqx4iKu1spD",
"timestamp":"2018-08-17T09:18:40.000Z",
"status":"2"
"deposit_id": "4703779",
}
]
获取单个币种的充值记录，最多可查询最近三个月的数据。
GET/api/account/v3/deposit/history/<currency>
GET/api/account/v3/deposit/history/btc
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的deposit_id等 |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的deposit_id等 |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| amount | String | 充值数量 |
| from | String | 充值地址，只显示内部账户转账地址，不显示区块链充值地址 |
| to | String | 此笔充值到账地址 |
| txid | String | 区块转账哈希记录 |
| timestamp | String | 充值到账时间 |
| currency | String | 币种名称，如btc |
| status | String | 充值状态 |
0:等待确认 |
||
1:确认到账 |
||
2:充值成功 |
||
| deposit_id | String | 充值记录D |
[
{
"amount":"0.0835",
"txid":"6d892c669225b1092c780bf0da0c6f912fc3e8f997dc8f6b8cc53b003288624c",
"currency":"BTC",
"from":"13800138000"
"to":"39kK4XvgEuM7rX9frgyHoZkWqx4iKu1spD",
"timestamp":"2018-06-09T07:57:09.000Z",
"status":"2"
"deposit_id": "4703879",
},
{
"amount":"0.01",
"txid":"590426_1_0_WALLET",
"currency":"BTC",
"from":""
"to":"",
"timestamp":"2018-05-30T01:33:40.000Z",
"status":"2"
"deposit_id": "4708879",
}
]
获取平台所有币种列表。并非所有币种都可被用于交易。在ISO 4217标准中未被定义的币种代码可能使用的是自定义代码。
GET/api/account/v3/currencies
GET/api/account/v3/currencies
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 币种名称，如btc |
| name | String | 币种中文名称，不显示则无对应名称 |
| can_deposit | String | 是否可充值，0表示不可充值，1表示可以充值 |
| can_withdraw | String | 是否可提币，0表示不可提币，1表示可以提币 |
| min_withdrawal | String | 币种最小提币量 |
[
{
"can_deposit":"1",
"can_withdraw":"1",
"currency":"BTC",
"min_withdrawal":"0.01",
"name":""
},
{
"can_deposit":"1",
"can_withdraw":"1",
"currency":"LTC",
"min_withdrawal":"0.1",
"name":""
}
]
查询提现到数字货币地址时，建议网络手续费信息。手续费越高，网络确认越快。
GET/api/account/v3/withdrawal/fee
GET/api/account/v3/withdrawal/fee?currency=btc
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 否 | 币种，不填则返回所有 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 币种 |
| min_fee | String | 最小提币手续费数量 |
| max_fee | String | 最大提币手续费数量 |
[
{
"currency":"BTC",
"max_fee":"0.02",
"min_fee":"0.0005"
},
{
"currency":"LTC",
"max_fee":"0.2",
"min_fee":"0.001"
},
{
"currency":"ETH",
"max_fee":"0.2",
"min_fee":"0.01"
}
]
币币交易的行情信息，账户信息，订单操作，订单查询，账单明细查询。
说明：因为要和老版本做兼融，实际有些接口返回参数会有多余，请以文档中返回参数说明为准。
例如币币账户信息接口返回frozen，hold和holds参数值相同，以hold为准；
获取币币账户资产列表(仅展示拥有资金的币对)，查询各币种的余额、冻结和可用等信息。
GET/api/spot/v3/accounts
GET/api/spot/v3/accounts
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| currency | String | 币种 |
| balance | String | 余额 |
| id | String | 账户 id |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易的数量 |
当你下市价单或限价单时，订单所需的资金将被冻结。这部分数量将不能被用于其他订单或者资金划转。资金将一直被冻结直至订单被成交或者取消。
[
{
"frozen":"0",
"hold":"0",
"id": "",
"currency":"BTC",
"balance":"0.0049925",
"available":"0.0049925",
"holds":"0"
},
{
"frozen":"0",
"hold":"0",
"id": "",
"currency":"USDT",
"balance":"226.74061435",
"available":"226.74061435",
"holds":"0"
},
{
"frozen":"0",
"hold":"0",
"id": "",
"currency":"EOS",
"balance":"0.4925",
"available":"0.4925",
"holds":"0"
}
]
获取币币账户单个币种的余额、冻结和可用等信息。
GET/api/spot/v3/accounts/<currency>
GET/api/spot/v3/accounts/btc
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| currency | String | [ 必填 ] 币种 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| currency | String | 币种 |
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易的数量 |
| id | String | 账户id |
{
"frozen":"0",
"hold":"0",
"id":"",
"currency":"BTC",
"balance":"0.0049925",
"available":"0.0049925",
"holds":"0"
}
列出账户资产流水。账户资产流水是指导致账户余额增加或减少的行为。流水会分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他记录。 本接口能查询最近3个月的数据。
GET/api/spot/v3/accounts/<currency>/ledger
GET/api/spot/v3/accounts/btc/ledger?limit=3&after=2500723297813504
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| currency | String | 是 | 币种 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id等 |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id等 |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| type | String | No | 1.充值 2.提现 7.买入 8.卖出 18.交割合约转 19.转出至交割合约 20.转入子账户21.转出至子账户 |
| 22.返手续费 25.otc买入 26.otc卖出 29.转出至资金账户 30.资金账户转入 31.转出至法币 32.法币转入 33.转出至杠杆 | |||
| 34.杠杆转入 35.借币 36.还币 37.市商计划送出38.市商计划返还 39.券商手续费转入 40.券商手续费转出 41.点卡抵扣币币手续费 | |||
| 42.购买点卡 43.点卡转让 44.市商计划额外送出 45.市商计划返还 46.币币账户转入 47.转出 币币账户 48.转出至组合 49.组合转入 | |||
| 50.挖矿扣除 51.挖矿所得 52.收益倍增 53.鼓励金分配 55.余币宝转入 56.转出至余币宝 57.永续合约转入 58.转出至永续合约 | |||
| 59.还糖果 60.点卡抵扣杠杆手续费 61.转出至套保账户 62.套保账户转入 63.点卡抵扣杠杆利息 64.矿池账户转入 65.转出至矿池账户 | |||
| 66.转出至期权账户 67.期权账户转入 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单ID |
| balance | String | 余额 |
| currency | String | 币种 |
| amount | String | 变动数量 |
| type | String | 流水来源 |
| timestamp | String | 账单创建时间 |
| details | String | |
如果type是trade或者fee，则会有该details字段将包含order，instrument信息,如果type是transfer，则会有该details字段将包含from，to信息 |
||
| order_id | String | 交易的ID |
| instrument_id | String | 交易的币对 |
| from | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| to | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
以下内容是参数名type的枚举值
| 流水来源类型 | 描述 |
|---|---|
| transfer | 资金转入/转出 |
| trade | 交易产生的资金变动 |
| rebate | 返佣 |
[
{
"timestamp":"2019-03-18T07:26:50.000Z",
"ledger_id":"3995466151",
"created_at":"2019-03-18T07:26:50.000Z",
"currency":"BTC",
"amount":"0.0009985",
"balance":"0.0049925",
"type":"trade",
"details":{
"instrument_id":"BTC-USDT",
"order_id":"2500723297813504",
"product_id":"BTC-USDT"
}
},
{
"timestamp":"2019-03-18T07:26:50.000Z",
"ledger_id":"3995466150",
"created_at":"2019-03-18T07:26:50.000Z",
"currency":"BTC",
"amount":"0.0009985",
"balance":"0.003994",
"type":"trade",
"details":{
"instrument_id":"BTC-USDT",
"order_id":"2500723297223680",
"product_id":"BTC-USDT"
}
},
{
"timestamp":"2019-03-18T07:08:25.000Z",
"ledger_id":"3995334780",
"created_at":"2019-03-18T07:08:25.000Z",
"currency":"BTC",
"amount":"0.0009985",
"balance":"0.0029955",
"type":"trade",
"details":{
"instrument_id":"BTC-USDT",
"order_id":"2500650881647616",
"product_id":"BTC-USDT"
}
}
]
币币交易提供限价单和市价单和高级限价单下单模式。只有当您的账户有足够的资金才能下单。
一旦下单，您的账户资金将在订单生命周期内被冻结。被冻结的资金以及数量取决于订单指定的类型和参数。
POST /api/spot/v3/orders
POST /api/spot/v3/orders{"type": "limit", "side": "buy", "instrument_id": "BTC-USDT", "size":"0.001", "client_oid": "oktspot79", "price": "4638.51", "notional": "", "order_type": "3"}
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| type | String | 否 | |
limit或market（默认是limit）。当以market（市价）下单，order_type只能选择0（普通委托） |
|||
| side | String | 是 | buy 或 sell |
| instrument_id | String | 是 | 币对名称 |
| order_type | String | 否 | 参数填数字 |
0：普通委托（order type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| price | String | 是 | 价格 |
| size | String | 是 | 买入或卖出的数量 |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| size | String | 是 | 卖出数量，市价卖出时必填size |
| notional | String | 是 | 买入金额，市价买入时必填notional |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| result | Boolean | 下单结果。若是下单失败，将给出错误码提示 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
client_oid
client_oid用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询出最新的一条数据。
instrument_id
instrument_id必须是有效的币对。币对列表可通过/ instruments接口获取。
type
下单时，您可以指定订单类型。您指定的订单类型将决定是否需要其他订单参数以及撮合引擎如何执行您的订单。如果type没有指定，订单类型将默认为limit。限价单既是默认订单类型，也是基本订单类型。限价单需要指定price和size。size是买入或卖出交易货币的数量，price表示每个交易货币相对计价货币的价格。限价单会按指定价格或更好的价格成交。根据市场条件，卖单可以按照指定价格或者更高价格来成交，买单可以按照指定价格或更低价格成交。如果限价单不能立即成交，那么限价单将进入深度列表，直到被另一个新订单成交或被用户撤单。
市价单不同于限价单，因为它们不提供价格控制。市价单提供了一种不必指定价格，而以固定数量的货币进行买入或者卖出的方式。市价单下单后会立即撮合，而不会被挂入深度列表。市价单总是吃单方taker并按taker收取手续费用。(注：如果你计划买入卖出的数量巨大时，将会对价格产生巨大影响，此时不推荐使用市价单)
price
price表示买入或卖出的价格。价格必须是价格步长tick_size的倍数。价格步长tick_size是价格的最小增量，可通过instruments接口获取。
size
size表示买入或卖出交易货币的数量。数量必须大于min_size。size_increment是交易货币数量的最小增量。上述参数都可通过instruments接口获取。
举例：假设 okb/usdt
的min_size是10，size_increment是0.0001。那么不能交易9.9个okb，但是可以交易10.0001个okb
notional
notional表示被用于市价买入的计价货币的数量，市价买入时必填。例如，在BTC-USDT交易时，市价单指定5000 USDT表示将花费5000
USDT购买BTC。
hold
对于限价买单，系统将冻结计价货币的数量 = 限定价格 x
买入数量。对于限价卖单，系统将冻结你想卖出的交易货币的数量。对于市价买单，notional数量的计价货币将被冻结。对于市价卖单，size数量的交易货币将被冻结。如果您取消部分成交或未成交的订单，剩余资金将被解除冻结。
订单生命周期
HTTP请求将在订单被拒绝（资金不足，参数无效等）或下单成功（由匹配引擎接受）时作出响应。一个200响应表示该订单被接收并且进入撮合。进入撮合的订单可以部分或全部立即成交（取决于价格和市场条件）。部分成交的时候将把订单的剩余数量继续进行撮合。完全成交的订单将进入已成交状态。
监听行情数据的用户建议使用client_oid字段以便在接受到的信息中标识对应的数据。
响应
成功接受的订单将被分配一个订单ID。订单是否成功接受取决于撮合引擎是否接受。 未成交的订单不会过期，并将保持撮合状态，直到被成交或取消。
{
"client_oid":"oktspot79",
"error_message": "",
"error_code": "0",
"order_id":"2510789768709120",
"result":true
}
下指定币对的多个订单（每次只能下最多4个币对且每个币对可批量下10个单）
POST /api/spot/v3/batch_orders
POST /api/spot/v3/batch_orders[{"client_oid":"ww20180728","instrument_id":"btc- usdt","side":"sell","type":"limit","size":"0.001","price":"10001","margin_trading ":"1"},{"client_oid":"w20180728","instrument_id":"btc- usdt","side":"sell","type":"limit","size":"0.001","price":"10002","margin_trading ":"1"}]
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| type | String | 否 | |
limit或market（默认是limit），当以market（市价）下单，order_type只能选择0（普通委托） |
|||
| side | String | 是 | buy 或 sell |
| instrument_id | String | 是 | 币对名称 |
| order_type | String | 否 | 参数填数字 |
0：普通委托（order_type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| price | String | 是 | 价格 |
| size | String | 是 | 买入或卖出的数量 |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| size | String | 否 | [ 非必填 ] 卖出数量，市价卖出必填size |
| notional | String | 否 | [ 非必填 ] 买入金额，市价买入时必填notional |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| result | Boolean | 下单结果。若是下单失败，将给出错误码提示。 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
每次最多4个币对且每个币对最多10个订单，建议用户调用批量撤单接口后，再调用获取订单列表接口确认已撤销成功。
{
"btc_usdt":[
{
"client_oid":"oktspot80",
"error_code":"0",
"error_message":"",
"order_id":"2510832677159936",
"result":true
},
{
"client_oid":"oktspot81",
"error_code":"0",
"error_message":"",
"order_id":"2510832677225472",
"result":true
},
{
"client_oid":"oktspot82",
"error_code":"0",
"error_message":"",
"order_id":"2510832677225473",
"result":true
}
]
}
撤销之前下的未完成订单。
POST /api/spot/v3/cancel_orders/<order_id> or <client_oid>
2018-10-12T07:34:30.223ZPOST/api/spot/v3/cancel_orders/a123{"instrument_id":"btc- usdt"}
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 提供此参数则撤销指定币对的相应订单，如果不提供此参数则返回错误码 |
| client_oid | String | 否 | order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单 , |
| 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 | |||
| order_id | String | 否 | order_id和client_oid必须且只能选一个填写，订单ID |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| result | Boolean | 撤单申请结果。若是撤单失败，将给出错误码提示 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
order_id和client_oid必须且只能选一个填写
使用client_oid撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
如果订单无法取消（已经成交或已取消），那么返回的报错内容里将显示相应的原因。
{
"client_oid": "order123",
"error_message": "",
"error_code": "0",
"order_id": "4407638476788736",
"result": true
}
撤销指定的某一种或多种币对的未完成订单（每次只能下最多4个币对且每个币对可批量下10个单）。
POST /api/spot/v3/cancel_batch_orders
2018-10-12T07:30:49.664ZPOST /api/spot/v3/cancel_batch_orders[{"instrument_id":"btc- usdt","client_oids":["a123","a1234"]},{"instrument_id":"eth- usdt","client_oids":["a12345","a123456"]}]
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| order_ids | List | 否 | order_id和client_oid必须且只能选一个填写，订单ID |
| client_oids | List | 否 | |
order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单，类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符 |
|||
| instrument_id | String | 是 | 币种 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| instrument_id | String | 币种，如btc-usdt |
| result | Boolean | 撤单申请结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
批量撤单时候，要么都是order_id要么都是client_oid，否则会提示错误
使用client_oid批量撤单时，目前只支持一个币对下撤一个client_oid
，一次4个币对，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
使用order_id撤单时，每次最多4个币对且每个币对最多10个订单，建议用户调用批量撤单接口后，再调用获取订单列表接口确认已撤销成功。
{
"btc-usdt":[
{
"result":true,
"client_oid":"a123",
"error_message": "",
"error_code": "0",
"order_id": "2510832677225473"
},
{
"result":true,
"client_oid":"a1234",
"error_message": "",
"error_code": "0",
"order_id": "2510832677225474"
}
],
"eth-usdt":[
{
"result":true,
"client_oid":"a12345",
"error_message": "",
"error_code": "0",
"order_id": "2510832677225475"
},
{
"result":true,
"client_oid":"a123456",
"error_message": "",
"error_code": "0",
"order_id": "2510832677225476"
}
]
}
列出您当前的订单信息（本接口能查询最近3个月订单信息）。这个请求支持分页，并且按委托时间倒序排序和存储，最新的排在最前面。
GET/api/spot/v3/orders
2019-03-18T07:49:43.306ZGET/api/spot/v3/orders?instrument_id=BTC- USDT&state=-2&after=2500723297223680
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| state | String | 是 | 订单状态 |
-2:失败 |
|||
-1:撤单成功 |
|||
0:等待成交 |
|||
1:部分成交 |
|||
2:完全成交 |
|||
3:下单中 |
|||
4:撤单中 |
|||
6: 未完成（等待成交+部分成交） |
|||
7:已完成（撤单成功+完全成交） |
|||
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 用户设置的订单ID |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| type | String | limit或market（默认是limit） |
| side | String | buy 或 sell |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| state | String | 订单状态 |
-2：失败 |
||
-1：撤单成功 |
||
0：等待成交 |
||
1：部分成交 |
||
2：完全成交 |
||
3：下单中 |
||
4：撤单中 |
||
| price_avg | String | 成交均价 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
如果订单在其生命周期内没有任何成交，其记录可能被清除。这表示订单详细信息将不可用本接口来获取。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
[
{
"client_oid":"oktspot76",
"created_at":"2019-03-18T07:26:49.000Z",
"filled_notional":"3.9734",
"filled_size":"0.001",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2500723297813504",
"order_type":"0",
"price":"4013",
"price_avg": "4013",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"filled",
"state":"-2",
"timestamp":"2019-03-18T07:26:49.000Z",
"type":"limit"
},
{
"client_oid":"oktspot75",
"created_at":"2019-03-18T07:26:49.000Z",
"filled_notional":"3.9734",
"filled_size":"0.001",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2500723297223680",
"order_type":"0",
"price":"4013",
"price_avg": "4013",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"filled",
"state": "-2",
"timestamp":"2019-03-18T07:26:49.000Z",
"type":"limit"
},
{
"client_oid":"oktspot74",
"created_at":"2019-03-18T07:08:24.000Z",
"filled_notional":"3.9768",
"filled_size":"0.001",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2500650881647616",
"order_type":"0",
"price":"4016.8",
"price_avg": "4013",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"staus":"filled",
"state": "-2",
"timestamp":"2019-03-18T07:08:24.000Z",
"type":"limit"
}
]
列出您当前所有的订单信息。这个请求支持分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。
GET/api/spot/v3/orders_pending
2018-09-12T07:51:51.138ZGET/api/spot/v3/orders_pending?limit=2&instrument_id=BTC- USDT&after=2500723297223680
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 用户设置的订单ID |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| instrument_id | String | 币对名称 |
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| state | String | 订单状态 |
0:等待成交 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母类型 ，1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
本接口只能查询所有未成交或者部分成交的订单
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
[
{
"client_oid":"oktspot86",
"created_at":"2019-03-20T03:28:14.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2511109744100352",
"order_type":"0",
"price":"3594.7",
"price_avg":"",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T03:28:14.000Z",
"type":"limit"
},
{
"client_oid":"oktspot85",
"created_at":"2019-03-20T03:28:10.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2511109459543040",
"order_type":"0",
"price":"3594.9",
"price_avg":"",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T03:28:10.000Z",
"type":"limit"
}
]
通过订单ID获取单个订单信息。可以获取近3个月订单信息。已撤销的未成交单只保留2个小时。
GET/api/spot/v3/orders/<order_id>
或
GET/api/spot/v3/orders/<client_oid>
2018-09-12T07:54:01.582ZGET/api/spot/v3/orders/23356?instrument_id=BTC-USDT
或
2018-09-12T07:54:01.582ZGET/api/spot/v3/orders/2e3356?instrument_id=BTC-USDT
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | [ 必填 ] 币对 |
| order_id | String | [ 非必填 ] 订单ID ,order_id和client_oid必须且只能选一个填写 |
| client_oid | String | [ 非必填 ] order_id和client_oid必须且只能选一个填写.由您设置的订单ID来识别您的订单 ， |
| 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| state | String | 订单状态 |
-2:失败 |
||
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
||
| price_avg | String | 成交均价 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写）类型1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
如果订单在其生命周期内没有任何成交，其记录可能被清除，则响应可能因为没有相应的匹配而返回状态码404。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
{
"client_oid":"oktspot70",
"created_at":"2019-03-15T02:52:56.000Z",
"filled_notional":"3.8886",
"filled_size":"0.001",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2482659399697408",
"order_type":"0",
"price":"3927.3",
"price_avg":"3927.3",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"filled",
"state":"2",
"timestamp":"2019-03-15T02:52:56.000Z",
"type":"limit"
}
获取最近的成交明细表。这个请求支持分页，并且按成交时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他记录。 本接口能查询最近3月的数据。
GET/api/spot/v3/fills
2018-09-12T07:56:11.922ZGET/api/spot/v3/fills?order_id=23212&instrument_id=btc- usdt&limit=2&after=2&before=4
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| order_id | String | 否 | 订单ID，不填写order_id，返回当前instrument_id下的所有订单成交明细 |
| instrument_id | String | 是 | 币对名称 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单ID |
| trade_id | String | 成交ID |
| instrument_id | String | 币对名称 |
| price | String | 成交价格 |
| size | String | 成交数量 |
| order_id | String | 订单ID |
| timestamp | String | 订单成交时间 |
| exec_type | String | 流动性方向（T 或 M） |
| fee | String | 手续费 |
| side | String | 账单方向（buy、sell） |
| currency | String | 币种 |
此接口一笔成交会返回2条数据，一个以计价货币计算的，一个是以交易货币计算的。
手续费
fee字段：负数的fee表示平台收取的手续费，正数的fee表示表示平台向达到指定lv交易等级的用户支付的挂单奖励（返佣）
流动性
exec_type字段表示该账单是maker还是taker产生的。M表示Maker，T表示Taker。
分页
返回账单列表的ledger_id按降序排列，从最大ledger_id到最小ledger_id。OK- after都会有这样的第一笔ledger_id，以便将来的请求使用OK-after参数将获取一个更大的ledger_id（新的账单）。
[
{
"created_at": "2019-11-25T07:45:05.000Z",
"currency": "USDT",
"exec_type": "M",
"fee": "-0.01915417",
"instrument_id": "OKB-USDT",
"ledger_id": "8161858573",
"liquidity": "M",
"order_id": "3927696997697536",
"price": "1.7793",
"product_id": "OKB-USDT",
"side": "buy",
"size": "19.1541645",
"timestamp": "2019-11-25T07:45:05.000Z"
},
{
"created_at": "2019-11-25T07:45:05.000Z",
"currency": "OKB",
"exec_type": "M",
"fee": "0",
"instrument_id": "OKB-USDT",
"ledger_id": "8161858572",
"liquidity": "M",
"order_id": "3927696997697536",
"price": "1.7793",
"product_id": "OKB-USDT",
"side": "sell",
"size": "10.765",
"timestamp": "2019-11-25T07:45:05.000Z"
}
]
委托策略下单
提供止盈止损、跟踪委托、冰山委托和时间加权委托策略
POST /api/spot/v3/order_algo
POST /api/spot/v3/order_algo{"instrument_id":"BTC- USDT","order_type":"1","mode":"1","side":"sell","size":"0.005","trigger_price":"8000","algo_price":"7500"}（止盈止损）
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| mode | String | 是 | 1：币币 |
2：杠杆 |
|||
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| size | String | 是 | 委托总数，填写值1<=X<=1000000的数 |
| side | String | 是 | buy 或 sell |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| trigger_price | String | 是 | 触发价格，填写值0<X<=1000000 |
| algo_price | String | 是 | 委托价格，填写值0<X<=1000000 |
| algo_type | String | 1:限价 2:市场价；触发价格类型，默认是1:限价，为2:市场价时，委托价格不必填； |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| callback_rate | String | 是 | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 是 | 激活价格 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| algo_variance | String | 是 | 委托深度，填写值0.0001(0.01%)<=X<=0.01（1%） |
| avg_amount | String | 是 | 单笔均值，填写2-1000的整数（永续2-500的整数） |
| limit_price | String | 是 | 价格限制 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| sweep_range | String | 是 | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 是 | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 是 | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| limit_price | String | 是 | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 是 | 委托间隔，填写值5<=X<=120 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| result | String | 调用接口返回结果 |
| algo_id | String | 订单ID，下单失败时，此字段值为-1 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
{
"algo_id": 329967,
"error_message": "",
"error_code": "0",
"result": true
}
委托策略撤单
根据指定的algo_id撤销某个币的未完成订单，每次最多可撤6（冰山/时间）/10（计划/跟踪）个。
POST /api/spot/v3/cancel_batch_algos
单个撤单：POST /api/spot/v3/cancel_batch_algos{"instrument_id": "BTC- USDT","order_type":"1","algo_ids": ["1600593327162368"]}
批量撤单：POST /api/spot/v3/cancel_batch_algos{"instrument_id": "BTC- USDT","order_type":"1","algo_ids":["1600593327162368","1600593327162369"]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 撤销指定的币对 |
| algo_ids | List | 是 | 撤销指定的委托单ID |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 指定的币对 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| algo_ids | String | 撤销指定的委托单ID |
| result | String | 调用接口返回结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
返回参数
返回值是已发起撤销操作的委托单ID，不代表这些委托单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
解释说明
无法保证一定会成功撤销，建议用户调用撤单接口后，再调用获取委托单列表接口确认。
{
"result": true,
"error_message": "",
"error_code": "0",
"algo_ids": [
"329967"
],
"instrument_id": "BTC-USDT",
"order_type": "1"
}
获取您当前账户交易等级对应的手续费费率，母账户下的子账户的费率和母账户一致。每天凌晨0点更新一次
GET/api/spot/v3/trade_fee
GET/api/spot/v3/trade_fee
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| taker | String | 吃单手续费率 |
| maker | String | 挂单手续费率 |
| timestamp | String | 数据返回时间 |
{
"maker": "0.001",
"taker": "0.0015",
"timestamp": "2019-12-05T09:06:20.260Z"
}
获取委托单列表
列出您当前所有的订单信息。
GET/api/spot/v3/algo
GET/api/spot/v3/algo?instrument_id=BTC-USDT&order_type=1
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 指定的币对 |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| status | String | 非必填 | 【status和algo_id必填且只能填其一】 |
| 订单状态 | |||
1：待生效 |
|||
2：已生效 |
|||
3：已撤销 |
|||
4：部分生效 |
|||
5：暂停生效 |
|||
6：委托失败 |
|||
【只有冰山和加权有4、5状态】 |
|||
| algo_id | String | 非必填 | 【status和algo_id必填且只能填其一】 |
| 查询指定的委托单ID | |||
| before | string | 否 | 请求此id之后（更新的数据）的分页内容 |
| after | string | 否 | 请求此id之前（更旧的数据）的分页内容 |
| limit | string | 否 | 分页返回的结果集数量，默认为100，最大为100 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 指定的币对 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| timestamp | String | 委托时间 |
| rejected_at | String | 委托失效时间 |
| algo_id | String | 委托单ID |
| status | String | 订单状态 |
1: 待生效 |
||
2: 已生效 |
||
3: 已撤销 |
||
4: 部分生效 |
||
5: 暂停生效 |
||
| size | String | 委托数量,填写值1<=X<=1000000的整数 |
| algo_price | String | 策略委托价格 |
| mode | String | 1：币币 |
2：杠杆 |
||
| order_id | String | 订单 ID |
| side | String | Buy 或 Sell |
| trigger_price | String | 策略委托触发价格 |
止盈止损
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trigger_price | String | 触发价格，填写值0<X |
| algo_price | String | 委托价格，填写值0<X<=1000000 |
| algo_type | String | 1:限价 2:市场价； |
跟踪委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| callback_rate | String | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 激活价格 ，填写值0<X<=1000000 |
冰山委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| algo_variance | String | 委托深度，填写值0<=X<=0.01（1%） |
| avg_amount | String | 单笔均值，填写2-500的整数（永续2-500的整数） |
| limit_price | String | 价格限制 ，填写值0<X<=1000000 |
| deal_value | String | 已成交量 |
时间加权
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| sweep_range | String | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| limit_price | String | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 委托间隔，填写值5<=X<=120 |
| deal_value | String | 已委托量 |
{
"btc_usdt": [
{
"algo_id": "329967",
"algo_price": "7500",
"instrument_id": "btc_usdt",
"mode": "1",
"order_id": "",
"order_type": "1",
"rejected_at": "2019-10-09T15:59:59.000Z",
"side": "sell",
"size": "0.005",
"status": "3",
"timestamp": "2019-10-08T09:43:56.000Z",
"trigger_price": "8000"
},
{
"algo_id": "329997",
"algo_price": "7500",
"instrument_id": "btc_usdt",
"mode": "1",
"order_id": "",
"order_type": "1",
"rejected_at": "2019-10-09T15:59:59.000Z",
"side": "sell",
"size": "0.005",
"status": "1",
"timestamp": "2019-10-08T10:10:44.000Z",
"trigger_price": "8000"
}
]
}
获取交易币对的列表，查询各币对的交易限制和价格步长等信息。
GET/api/spot/v3/instruments
2018-09-12T07:56:45.645ZGET/api/spot/v3/instruments
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 币对名称 |
| base_currency | String | 交易货币币种 |
| quote_currency | String | 计价货币币种 |
| min_size | String | 最小交易数量 |
| size_increment | String | 交易货币数量精度 |
| tick_size | String | 交易价格精度 |
min_size指下单数量的最小值（交易货币）。size_increment（交易数量步长）是指下单数量的最小增量。例如，当size_increment为0.000001，委托数量传入0.0000126将被系统按截尾法修正为0.000012。
tick_size（价格步长）是指下单价格的最小增量，委托价格必须是tick_size的倍数。例如，当tick_size为0.0001，委托价格传入0.02237将被系统按截尾法修正为0.0223。
[
{
"base_currency":"BTC",
"instrument_id":"BTC-USDT",
"min_size":"0.001",
"quote_currency":"USDT",
"size_increment":"0.00000001",
"tick_size":"0.1"
},
{
"base_currency":"ETH",
"instrument_id":"ETH-USDT",
"min_size":"0.001",
"quote_currency":"USDT",
"size_increment":"0.000001",
"tick_size":"0.01"
}
]
获取币对的深度列表。这个请求不支持分页，一个请求返回整个深度列表。
GET/api/spot/v3/instruments/<instrument_id>/book
2019-03-20T07:48:09.130ZGET/api/spot/v3/instruments/BTC- USDT/book?size=5&depth=0.2
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| size | String | [ 非必填 ] 返回深度档位数量，最多返回200 |
| depth | String | [ 非必填 ] 按价格合并深度，例如：0.1或0.001 |
| instrument_id | String | [ 必填 ] 币对 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 时间戳 |
asks和bids值数组举例说明： ["411.8","10","8"] 411.8为深度价格，10为此价格数量，8为此深度由几笔订单组成。
当size不传时，返回200条；size传0时，返回0条；size最大200，传大于200的数时，返回200条。
按价格合并深度是指每个价格区间将仅返回一个数量，就像在该价格区间上只有一个订单。
asks: 卖方深度
bids: 买方深度
{
"asks":[
[
"3993.2",
"0.41600068",
"1"
],
[
"3993.4",
"1.24807818",
"3"
]
],
"bids":[
[
"3993",
"0.15149658",
"2"
],
[
"3992.8",
"1.19046818",
"1"
]
],
"timestamp":"2019-03-20T03:55:37.888Z"
}
获取平台全部币对的最新成交价、买一价、卖一价和24小时交易量的快照信息。
GET/api/spot/v3/instruments/ticker
2018-09-12T07:57:26.537ZGET/api/spot/v3/instruments/ticker
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 币对名称 |
| last | String | 最新成交价 |
| last_qty | String | 最新成交的数量 |
| best_ask | String | 卖一价 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid | String | 买一价 |
| best_bid_size | String | 买一价对应的数量 |
| open_24h | String | 24小时开盘价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| base_volume_24h | String | 24小时成交量，按交易货币统计 |
| quote_volume_24h | String | 24小时成交量，按计价货币统计 |
| timestamp | String | 系统时间戳 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
24小时开盘价取值来自24小时前那一分钟的K线的开盘价。即 2018年7月23日08:23:45，此时的涨跌幅依靠的是开盘价是2018年7月22日08:23:00时的价格。
{
"best_ask": "7222.2",
"best_bid": "7222.1",
"instrument_id": "BTC-USDT",
"product_id": "BTC-USDT",
"last": "7222.2",
"last_qty": "0.00136237",
"ask": "7222.2",
"best_ask_size": "0.09207739",
"bid": "7222.1",
"best_bid_size": "3.61314948",
"open_24h": "7356.8",
"high_24h": "7367.7",
"low_24h": "7160",
"base_volume_24h": "18577.2",
"timestamp": "2019-12-11T07:48:04.014Z",
"quote_volume_24h": "134899542.8"
}
获取币对的最新成交价、买一价、卖一价和24小时交易量的快照信息。
GET/api/spot/v3/instruments/<instrument-id>/ticker
2019-03-13T11:42:09.849ZGET/api/spot/v3/instruments/BTC-USDT/ticker
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | [ 必填 ] 币对 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 币对名称 |
| last | String | 最新成交价 |
| last_qty | String | 最新成交的数量 |
| best_ask | String | 卖一价 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid | String | 买一价 |
| best_bid_size | String | 买一价对应的数量 |
| open_24h | String | 24小时开盘价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| base_volume_24h | String | 24小时成交量，按交易货币统计 |
| quote_volume_24h | String | 24小时成交量，按计价货币统计 |
| timestamp | String | 系统时间戳 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
24小时开盘价取值来自24小时前那一分钟的K线的开盘价。即 2018年7月23日08:23:45，此时的涨跌幅依靠的是开盘价是2018年7月22日08:23:00时的价格。
{
"best_ask": "7222.2",
"best_bid": "7222.1",
"instrument_id": "BTC-USDT",
"product_id": "BTC-USDT",
"last": "7222.2",
"last_qty": "0.00136237",
"ask": "7222.2",
"best_ask_size": "0.09207739",
"bid": "7222.1",
"best_bid_size": "3.61314948",
"open_24h": "7356.8",
"high_24h": "7367.7",
"low_24h": "7160",
"base_volume_24h": "18577.2",
"timestamp": "2019-12-11T07:48:04.014Z",
"quote_volume_24h": "134899542.8"
}
本接口能查询最近60条数据。
GET/api/spot/v3/instruments/<instrument_id>/trades
2018-09-12T07:58:34.414ZGET/api/spot/v3/instruments/LTC-USDT/trades?limit=20
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| limit | String | 否 | 分页返回的结果集数量，最大为60，不填默认返回60条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| timestamp | String | 成交时间 |
| trade_id | String | 成交ID |
| price | String | 成交价格 |
| size | String | 成交数量 |
| side | String | 成交方向 |
成交方向side是指Taker订单的下单方向，Taker表示主动与深度列表中挂单进行成交。buy表示价格上涨，因为Taker是买单吃掉深度，所以价格将上行。相反，sell表示价格下跌。
[
{
"time":"2019-04-12T02:07:30.523Z",
"timestamp":"2019-04-12T02:07:30.523Z",
"trade_id":"1296412902",
"price":"4913.4",
"size":"0.00990734",
"side":"buy"
},
{
"time":"2019-04-12T02:07:30.455Z",
"timestamp":"2019-04-12T02:07:30.455Z",
"trade_id":"1296412899",
"price":"4913.2",
"size":"0.17820096",
"side":"sell"
}
]
获取币对的K线数据。K线数据按请求的粒度分组返回，k线数据最多可获取最近1440条。
GET/api/spot/v3/instruments/<instrument_id>/candles
GET/api/spot/v3/instruments/BTC- USDT/candles?granularity=86400&start=2019-03-19T16:00:00.000Z&end=2019-03-20T16:00:00.000Z
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对 |
| start | String | 否 | 开始时间（ISO 8601标准） |
| end | String | 否 | 结束时间（ISO 8601标准） |
| granularity | String | 否 | |
时间粒度，以秒为单位，默认值60。如[60/180/300/900/1800/3600/7200/14400/21600/43200/86400/604800]，详见下解释说明 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| time | String | 开始时间 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量 |
如果用户没有提供开始时间或结束时间中的任一字段，则两个字段都将被忽略。未提供开始时间和结束时间的请求，则系统按时间粒度返回最近的200条数据。
时间粒度granularity必须是[60 180 300 900 1800 3600 7200 14400 21600 43200 86400 604800]中的任一值，否则请求将被拒绝。这些值分别对应的是[1min 3min 5min 15min 30min 1hour 2hour 4hour 6hour 12hour 1day 1week]的时间段。
K线数据可能不完整。K线数据不应该轮询调用。
单次请求的最大数据量是200。如果您选择的开始/结束时间和时间粒度导致超过单次请求的最大数据量，您的请求将只会返回200个数据。如果您希望在更大的时间范围内获取足够精细的数据，则需要使用多个开始/结束范围进行多次请求。
[
[
"2019-03-19T16:00:00.000Z",
"3997.3",
"4031.9",
"3982.5",
"3998.7",
"26175.21141385"
],
[
"2019-03-18T16:00:00.000Z",
"3980.6",
"4014.6",
"3968.9",
"3997.3",
"33053.48725643"
]
]
币币杠杆交易的行情信息，账户信息，订单操作，订单查询，账单明细查询。
说明：因为要和老版本做兼融，实际有些接口返回参数会有多余，请以文档中返回参数说明为准。
例如币币账户信息接口返回frozen，hold和holds参数值相同，以hold为准；获取借币记录接口返回参数 repay_amount
和 returned_amount，repay_interest 和paid_interest
参数的值相同，product_id和instrument_id相同等等
获取币币杠杆账户资产列表，查询各币种的余额、冻结和可用等信息。
GET/api/margin/v3/accounts
2018-09-13T02:25:41.946ZGET/api/margin/v3/accounts
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 杠杆币对名称 |
| currency | String | 杠杆币对下的币种名称 |
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易数量 |
| risk_rate | String | 风险率 |
| can_withdraw | String | 可划转数量 |
| liquidation_price | String | 强平价 |
| borrowed | String | 已借币（已借未还的部分） |
| lending_fee | String | 利息（未还的利息） |
| margin_ratio | String | 保证金率 |
| maint_margin_ratio | String | 维持保证金率 |
| tiers | String | 当前借币数量档位 |
当你下市价单或限价单时，订单所需的资金将被冻结。这部分数量将不能被用于其他订单或者资金划转。资金将一直被冻结直至订单被成交或者取消。
{
"currency:BTC": {
"available": "0",
"balance": "0",
"borrowed": "0",
"can_withdraw": "0",
"frozen": "0",
"hold": "0",
"holds": "0",
"lending_fee": "0"
},
"currency:USDT": {
"available": "0",
"balance": "0",
"borrowed": "0",
"can_withdraw": "0",
"frozen": "0",
"hold": "0",
"holds": "0",
"lending_fee": "0"
},
"liquidation_price": "0",
"maint_margin_ratio": "0.05",
"margin_ratio": "",
"risk_rate": "",
"tiers": "1"
}
获取币币杠杆某币对账户的余额、冻结和可用等信息。
GET/api/margin/v3/accounts/<instrument_id>
2018-09-13T02:25:41.946ZGET/api/margin/v3/accounts/eos-usdt
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | [ 必填 ] 币对 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| balance | String | 余额 |
| currency | String | 该币对下的币种名称 |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易的数量 |
| risk_rate | String | 风险率 |
| can_withdraw | String | 可划转数量 |
| liquidation_price | String | 强平价 |
| borrowed | String | 已借币（已借未还的部分） |
| lending_fee | String | 利息（未还的利息） |
| margin_ratio | String | 保证金率 |
| maint_margin_ratio | String | 维持保证金率 |
| tiers | String | 当前借币数量档位 |
{
"currency:BTC": {
"available": "0",
"balance": "0",
"borrowed": "0",
"can_withdraw": "0",
"frozen": "0",
"hold": "0",
"holds": "0",
"lending_fee": "0"
},
"currency:USDT": {
"available": "0",
"balance": "0",
"borrowed": "0",
"can_withdraw": "0",
"frozen": "0",
"hold": "0",
"holds": "0",
"lending_fee": "0"
},
"liquidation_price": "0",
"maint_margin_ratio": "0.05",
"margin_ratio": "",
"risk_rate": "",
"tiers": "1"
}
列出杠杆帐户资产流水。帐户资产流水是指导致帐户余额增加或减少的行为。流水会分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。 本接口能查询最近3个月的数据。
GET/api/margin/v3/accounts/<instrument_id>/ledger
2019-03-18T03:45:56.000ZGET/api/margin/v3/accounts/btc- usdt/ledger?limit=10&type=1&after=2
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| type | String | 否 | 1.转入 2.转出 3.借币 4.还币 5.计息 7.买入 8.卖出 9.资金账户转入 10.法币转入 |
| 11.交割合约转入 12.币币转入 13.组合转入 14.转出至资金账户 15.转出至法币 16.转出至币币 17.转出至交割合约 18.转出至组合 | |||
| 19.强制还息 20.余币宝转入 21.转出至余币宝 22.永续合约转入 23.转出至永续合约 24.强平费 25.转出至套保账户 26.套保账户转入 | |||
| 59.还糖果 60.套保费 61.币币杠杆账户转入 62.转出至币币杠杆账户 64.矿池账户转入 65.转出至矿池账户 66.转出至期权账户 | |||
| 67.期权账户转入 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单ID |
| instrument_id | String | 杠杆币对名称 |
| currency | String | 币种 |
| balance | String | 余额 |
| amount | String | 变动数量 |
| type | String | 流水来源 |
| timestamp | String | 账单创建时间 |
| details | String | |
如果type是trade或者fee，则会有该details字段将包含order，instrument信息,如果type是transfer，则会有该details字段将包含from，to信息 |
||
| order_id | String | 交易的ID |
| from | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| to | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| 流水来源类型 | 描述 | |
| --- | --- | |
| transfer | 资金转入/转出 | |
| trade | 交易产生的资金变动 | |
| rebate | 返佣 |
[
[
{
"created_at":"2019-03-20T05:45:10.000Z",
"ledger_id":"78965766",
"timestamp":"2019-03-20T05:45:10.000Z",
"currency":"EOS",
"amount":"0",
"balance":"0.59957711",
"type":"transfer",
"details":{
"instrument_id":"EOS-USDT",
"order_id":"787057",
"product_id":"EOS-USDT"
}
},
{
"created_at":"2019-03-20T04:45:07.000Z",
"ledger_id":"78942699",
"timestamp":"2019-03-20T04:45:07.000Z",
"currency":"EOS",
"amount":"0",
"balance":"0.59957711",
"type":"transfer",
"details":{
"instrument_id":"EOS-USDT",
"order_id":"787057",
"product_id":"EOS-USDT"
}
},
{
"created_at":"2019-03-20T03:45:05.000Z",
"ledger_id":"78918186",
"timestamp":"2019-03-20T03:45:05.000Z",
"currency":"EOS",
"amount":"0",
"balance":"0.59957711",
"type":"transfer",
"details":{
"instrument_id":"EOS-USDT",
"order_id":"787057",
"product_id":"EOS-USDT"
}
}
],
{
"OK-BEFORE":"78965766",
"OK-AFTER":"78918186"
}
]
获取币币杠杆账户的借币配置信息，包括当前最大可借、借币利率、最大杠杆倍数。
GET/api/margin/v3/accounts/availability
2018-09-13T02:27:05.580ZGET/api/margin/v3/accounts/availability
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 杠杆币对名称 |
| currency | String | 币种 |
| available | String | 当前最大可借 |
| rate | String | 借币利率 |
| leverage | String | 最大杠杆倍数 |
[
{
"currency:BTC":{
"available":"0.09995502",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00009984"
},
"currency:USDT":{
"available":"400.00000000",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00019992"
},
"instrument_id":"BTC-USDT",
"product_id":"BTC-USDT"
},
{
"currency:EOS":{
"available":"1.9343",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00009984"
},
"currency:USDT":{
"available":"7.1571",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00019992"
},
"instrument_id":"EOS-USDT",
"product_id":"EOS-USDT"
}
]
获取某个币币杠杆账户的借币配置信息，包括当前最大可借、借币利率、最大杠杆倍数。
GET/api/margin/v3/accounts/<instrument_id>/availability
2019-03-18T02:27:37.723ZGET/api/margin/v3/accounts/BTC-USDT/availability
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | [ 必填 ] 币对 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| currency | String | 币种 |
| available | String | 当前最大可借 |
| rate | String | 借币利率 |
| leverage | String | 最大杠杆倍数 |
| instrument_id | String | 币对 |
[
{
"currency:BTC":{
"available":"0.09989261",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00009984"
},
"currency:USDT":{
"available":"400.00000000",
"leverage":"5",
"leverage_ratio":"5",
"rate":"0.00019992"
},
"instrument_id":"BTC-USDT",
"product_id":"BTC-USDT"
}
]
获取币币杠杆帐户的借币记录。这个请求支持分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。
GET/api/margin/v3/accounts/borrowed
2018-09-13T02:28:14.618ZGET/api/margin/v3/accounts/borrowed?status=0&limit=1&after=2
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| status | String | [ 非必填 ] 状态 |
0：未还清 |
||
1：已还清 |
||
| after | String | [ 非必填 ] 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的borrow_id |
| before | String | [ 非必填 ] 请求此id之后（更新的数据）的分页内容，传的值为对应接口的borrow_id |
| limit | String | [ 非必填 ] 分页返回的结果集数量，默认为100，最大为100（具体参见分页处的描述） |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| borrow_id | String | 借币记录ID |
| instrument_id | String | 杠杆币对名称 |
| currency | String | 币种 |
| timestamp | String | 借币时间 |
| amount | String | 借币总数量 |
| interest | String | 利息总数量 |
| returned_amount | String | 已还借币数量 |
| paid_interest | String | 已还利息数量 |
| last_interest_time | String | 最后一次计息时间 |
| force_repay_time | String | 强制还息时间 |
| rate | String | 利率 |
[
{
"amount":"0.5",
"borrow_id":"787057",
"created_at":"2019-03-18T09:41:44.000Z",
"currency":"EOS",
"force_repay_time":"2019-03-25T09:42:19.000Z",
"instrument_id":"EOS-USDT",
"interest":"0.0000386883807232",
"last_interest_time":"2019-03-20T05:45:11.000Z",
"paid_interest":"0.00000208",
"product_id":"EOS-USDT",
"rate":"0.00000416",
"repay_amount":"0.29999792",
"repay_interest":"0.00000208",
"returned_amount":"0.29999792",
"timestamp":"2019-03-18T09:41:44.000Z"
}
]
获取币币杠杆帐户某币对的借币记录。这个请求支持分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。
GET/api/margin/v3/accounts/<instrument_id>/borrowed
2018-09-13T02:29:06.610ZGET/api/margin/v3/accounts/BTC- USDT/borrowed?limit=2&status=1&after=2
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| status | String | [ 非必填 ] 状态 |
0：未还清 |
||
1：已还清 |
||
| after | String | [ 非必填 ] 请求此id之前（更旧的数据）的分页内容（举例一列数：1，2，3，4，5。after 4 |
只有5，to 4有1，2，3） |
||
| before | String | [ 非必填 ] 请求此id之后（更新的数据）的分页内容 |
| limit | String | [ 非必填 ] 分页返回的结果集数量，默认为100，最大为100（具体参见分页处的描述） |
| instrument_id | String | [ 必填 ] 币对 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| borrow_id | String | 借币记录ID |
| instrument_id | String | 杠杆币对名称 |
| currency | String | 币种 |
| timestamp | String | 借币时间 |
| amount | String | 借币总数量 |
| interest | String | 利息总数量 |
| returned_amount | String | 已还借币数量 |
| paid_interest | String | 已还利息数量 |
| last_interest_time | String | 最后一次计息时间 |
| force_repay_time | String | 强制还息时间 |
| rate | String | 利率 |
[
{
"amount":"0.5",
"borrow_id":"787057",
"created_at":"2019-03-18T09:41:44.000Z",
"currency":"EOS",
"force_repay_time":"2019-03-25T09:42:19.000Z",
"instrument_id":"EOS-USDT",
"interest":"0.0000386883807232",
"last_interest_time":"2019-03-20T05:45:11.000Z",
"paid_interest":"0.00000208",
"product_id":"EOS-USDT",
"rate":"0.00000416",
"repay_amount":"0.29999792",
"repay_interest":"0.00000208",
"returned_amount":"0.29999792",
"timestamp":"2019-03-18T09:41:44.000Z"
}
]
在某个币币杠杆账户里进行借币。
POST /api/margin/v3/accounts/borrow
2018-10-08T03:00:56.799ZPOST/api/margin/v3/accounts/borrow{"instrument_id":"ltc- usdt","currency":"usdt","amount":"0.1"}
| 参 数名 | 类 型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 杠杆币对名称 |
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单 |
| currency | String | 是 | 币种 |
| amount | String | 是 | 借币数量 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| borrow_id | String | 借币记录ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| result | Boolean | 结果 |
{
"borrow_id":"791434",
"client_oid":"",
"result":true
}
在某个币币杠杆账户里进行还币。
POST /api/margin/v3/accounts/repayment
2018-10-08T03:04:52.002ZPOST/api/margin/v3/accounts/repayment{"instrument_id":"ltc- usdt","currency":"usdt","amount":"0.1","borrow_id":"185759"}
| 参 数名 | 类 型 | 是 否必须 | 描 述 |
|---|---|---|---|
| borrow_id | String | 否 | 借币记录ID，不填时还整个币对的币 |
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单 |
| instrument_id | String | 是 | 杠杆币对名称 |
| currency | String | 是 | 币种 |
| amount | String | 是 | 还币数量 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| repayment_id | String | 还币记录ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| result | Boolean | 结果 |
{
"client_oid":"",
"repayment_id":"791434",
"result":true
}
OKEx
API提供limit和market和高级限价委托等下单模式。只有当您的账户有足够的资金才能下单。一旦下单，您的账户资金将在订单生命周期内被冻结。被冻结的资金以及数量取决于订单指定的类型和参数。
POST /api/margin/v3/orders
2018-09-12T07:46:47.098ZPOST/api/margin/v3/orders{"client_oid":"yt20180728","order_type":"0","instrument_id":"btc- usdt","side":"buy","type":"market","size":"0.1","notional":"100","margin_trading":"2"}
| 参 数名 | 类 型 | 是 否必须 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单 ，类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符 |
| type | String | 否 | limit 或 |
market（默认是limit）。当以market（市价）下单，order_type只能选择0（普通委托） |
|||
| side | String | 是 | buy 或 sell |
| instrument_id | String | 是 | 币对名称 |
| order_type | String | 否 | 参数填数字 |
0：普通委托（order type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
|||
| margin_trading | String | 是 | 下单类型（当前为币币杠杆交易，请求值为2） |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| price | String | 是 | 价格 |
| size | String | 是 | 买入或卖出的数量 |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| size | String | 否 | 卖出数量，市价卖出必填size |
| notional | String | 否 | 买入金额，市价买入时必填notional |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | Boolean | 下单结果。若是下单失败，将给出错误码提示。 |
client_oid的类型为字母+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询出最新的一条数据。
instrument_id
instrument_id必须是有效的币对。币对列表可通过/ instruments接口获取。
type
下单时，您可以指定订单类型。您指定的订单类型将决定是否需要其他订单参数以及撮合引擎如何执行您的订单。如果type没有指定，订单类型将默认为limit。限价单既是默认订单类型，也是基本订单类型。限价单需要指定price和size。size是买入或卖出交易货币的数量，price表示每个交易货币相对计价货币的价格。限价单会按指定价格或更好的价格成交。根据市场条件，卖单可以按照指定价格或者更高价格来成交，买单可以按照指定价格或更低价格成交。如果限价单不能立即成交，那么限价单将进入深度列表，直到被另一个新订单成交或被用户撤单。
市价单不同于限价单，因为它们不提供价格控制。市价单提供了一种不必指定价格，而以固定数量的货币进行买入或者卖出的方式。市价单下单后会立即撮合，而不会被挂入深度列表。市价单总是吃单方（taker）并承担taker费用。
price
price表示买入或卖出的价格。价格必须是价格步长size_increment的倍数。价格步长size_increment是价格的最小增量，可通过instruments接口获取。
size
size表示买入或卖出交易货币的数量。数量必须大于min_size。交易数量步长size_increment是数量的最小增量。上述参数都可通过instruments接口获取。
notional
notional表示被用于市价买入的计价货币的数量，市价买入时必填。例如，在BTC-USDT交易时，市价单指定5000 USDT表示将花费5000
USDT购买BTC。
hold
对于限价买单，系统将冻结计价货币的数量 = 限定价格 x
买入数量。对于限价卖单，系统将冻结你想卖出的交易货币的数量。对于市价买单，funds数量的计价货币将被冻结。对于市价卖单，size数量的交易货币将被冻结。如果您取消部分成交或未成交的订单，剩余资金将被解除冻结。
订单生命周期
HTTP请求将在订单被拒绝（资金不足，参数无效等）或下单成功（由匹配引擎接受）时作出响应。一个200响应表示该订单被接收并且进入撮合。进入撮合的订单可以部分或全部立即成交（取决于价格和市场条件）。部分成交的时候将把订单的剩余数量继续进行撮合。完全成交的订单将进入已成交状态。
监听行情数据的用户建议使用client_oid字段以便在接受到的信息中标识对应的数据。
响应
成功接受的订单将被分配一个订单ID。成功接受的订单表示撮合引擎已经接受的订单。 未成交的订单不会过期，并将保持撮合状态，直到被成交或取消。
{
"client_oid":"oktlever50",
"error_message": "",
"error_code": "0",
"order_id":"2512084870235136",
"result":true
}
下指定币对的多个订单（每次只能下最多4个币对且每个币对可批量下10个单）。
POST /api/margin/v3/batch_orders
市价单：POST /api/margin/v3/batch_orders[{"client_oid":"t20180728","order_type":"1","instrument_id":"btc- usdt","side":"sell","type":"market"," size ":"0.001"," notional ":"10001","margin_trading ":"2"},{"client_oid":"yy20180728","instrument_id":"btc- usdt","side":"sell","type":"limit"," size ":"0.001","notional":"10002","margin_trading ":"2"}
限价单：POST /api/margin/v3/batch_orders[{"client_oid":"y20180728","order_type":"1","instrument_id":"btc- usdt","side":"sell","type":"limit","size":"0.001","price":"10001","margin_trading ":"2"},{"client_oid":"yt20180728","instrument_id":"btc- usdt","side":"sell","type":"limit","size":"0.001","price":"10002","margin_trading ":"2"}
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单， 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| type | String | 否 | limit 或 |
market（默认是limit）。当以market（市价）下单，order_type只能选择0（普通委托） |
|||
| side | String | 是 | buy 或 sell |
| instrument_id | String | 是 | 币对名称 |
| order_type | String | 否 | 参数填数字 |
0：普通委托（order_type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
|||
| margin_trading | String | 是 | 下单类型（当前为币币杠杆交易，请求值为2） |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| price | String | 是 | 价格 |
| size | String | 是 | 买入或卖出的数量 |
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| size | String | 否 | [ 非必填 ] 卖出数量，市价卖出必填size |
| notional | String | 否 | [ 非必填 ] 买入金额，市价买入时必填notional |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | Boolean | 下单结果。若是下单失败，将给出错误码提示。 |
client_oid的类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
每次最多4个币对且每个币对最多10个订单，建议用户调用批量撤单接口后，再调用获取订单列表接口确认已撤销成功。
{
"BTC-USDT":[
{
"client_oid":"oktlever51",
"error_message": "",
"error_code": "0",
"order_id":"2512113685627904",
"result":true
},
{
"client_oid":"oktlever52",
"error_message": "",
"error_code": "0",
"order_id":"2512113687135232",
"result":true
}
]
}
撤销之前下的未完成订单。
POST /api/margin/v3/cancel_orders/<order_id> or <client_oid>
2018-10-12T07:34:30.223ZPOST/api/margin/v3/cancel_orders/a123{"instrument_id":"btc- usdt"}
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 提供此参数则撤销指定币对的相应订单，如果不提供此参数则返回错误码 |
| client_oid | String | 非必填 | order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 | |||
| order_id | String | 非必填 | order_id和client_oid必须且只能选一个填写，订单ID |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
| result | Boolean | 撤单申请结果。若是撤单失败，将给出错误码提示 |
order_id和client_oid必须且只能选一个填写
使用client_oid撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
如果订单无法取消（已经成交或已取消），那么返回的报错内容里将显示相应的原因。
{
"result":true,
"client_oid":"a123",
"order_id": "2510832677225473",
"error_message": "",
"error_code": "0"
}
撤销指定的某一种或多种币对的所有未完成订单，每个币对可批量撤10个单。
POST /api/margin/v3/cancel_batch_orders
2018-10-12T07:30:49.664ZPOST/api/margin/v3/cancel_batch_orders[{"instrument_id":"btc- usdt","client_oids":["a123","a1234"]},{"instrument_id":"ltc- usdt","client_oids":["a12345","a123456"]}]
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | |
| 提供此参数则撤销指定一个或多个币对的订单，如果不提供此参数则返回错误码，此字段支持传多个值。此参数为`[''btc-usdt'',''ltc- | |||
| eth'']`，推荐使用中横线连接币种，下划线连接的方式也同时兼容 | |||
| order_ids | List | 否 | order_id和client_oid必须且只能选一个填写，订单ID |
| client_oids | List | 否 | |
order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单，类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| instrument_id | String | 币种，如btc-usdt |
| result | Boolean | 撤单申请结果。若是撤单失败，将给出错误码提示 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
批量撤单一次性时候，要么都是order_id要么都是client_oid，否则会提示错误
使用client_oid批量撤单时，目前只支持一个币对下撤一个client_oid
，一次四个币对，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
使用order_id撤单时，每次最多4个币对且每个币对最多10个订单，建议用户调用批量撤单接口后，再调用获取订单列表接口确认已撤销成功。
{
"btc-usdt":[
{
"result":true,
"client_oid":"a123",
"order_id": "2510832677225473",
"error_message": "",
"error_code": "0"
},
{
"result":true,
"client_oid":"a1234",
"order_id": "2510832677225474",
"error_message": "",
"error_code": "0"
}
],
"ltc-usdt":[
{
"result":true,
"client_oid":"a12345",
"order_id": "2510832677225475",
"error_message": "",
"error_code": "0"
},
{
"result":true,
"client_oid":"a123456",
"order_id": "2510832677225476",
"error_message": "",
"error_code": "0"
}
]
}
列出您当前所有的订单信息（本接口能查询最近3个月订单信息）。这个请求支持分页，并且按委托时间倒序排序和存储，最新的排在最前面。
GET/api/margin/v3/orders
2018-09-12T07:49:43.306ZGET/api/margin/v3/orders?instrument_id=BTC- USDT&state=0&limit=2&after=2500723297223680
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| state | String | 是 | 订单状态 |
-2:失败 |
|||
-1:撤单成功 |
|||
0:等待成交 |
|||
1:部分成交 |
|||
2:完全成交 |
|||
3:下单中 |
|||
4:撤单中 |
|||
6: 未完成（等待成交+部分成交） |
|||
7:已完成（撤单成功+完全成交） |
|||
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 用户设置的订单ID |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| state | String | 订单状态 |
-2：失败 |
||
-1：撤单成功 |
||
0：等待成交 |
||
1：部分成交 |
||
2：完全成交 |
||
3：下单中 |
||
4：撤单中 |
||
| price_avg | String | 成交均价 |
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
最新的定义为 先从未成交表查，如果未成交表没有，再查已成交表的最新数据。
如果订单在其生命周期内没有任何成交，其记录可能被清除。这表示订单详细信息将不可用本接口来获取。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
[
{
"client_oid":"oktlever56",
"created_at":"2019-03-20T08:21:49.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2512264176206848",
"order_type":"0",
"price":"3613.3",
"price_avg": "3613.3",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T08:21:49.000Z",
"type":"limit"
},
{
"client_oid":"oktlever55",
"created_at":"2019-03-20T08:21:49.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2512264174306304",
"order_type":"0",
"price":"3613.3",
"price_avg": "3613.3",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T08:21:49.000Z",
"type":"limit"
}
]
通过订单ID获取单个订单信息。已撤销的未成交单只保留2个小时。
GET/api/margin/v3/orders/<order_id>
或者
GET/api/margin/v3/orders/<client_oid>
2018-09-13T02:39:22.475ZGET/api/margin/v3/orders/23458?instrument_id=btc- usdt
或
2018-09-13T02:39:22.475ZGET/api/margin/v3/orders/etyery8?instrument_id=btc- usdt
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | [ 必填 ] 币对 |
| order_id | String | [非必填 ] 订单ID order_id和client_oid必须且只能选一个填写 |
| client_oid | String | [非必填 ] order_id和client_oid必须且只能选一个填写 |
| 由您设置的订单ID来识别您的订单 ， 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| state | String | -2:失败 |
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
||
| price_avg | String | 成交均价 |
status为state旧版参数，会短期兼容，建议尽早切换state。
order_id和client_oid必须且只能选一个填写
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
最新的定义为 先从未成交表查，如果未成交表没有，再查已成交表的最新数据。
如果订单在其生命周期内没有任何成交，其记录可能被清除，则响应可能因为没有相应的匹配而返回状态码404。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
{
"client_oid":"",
"created_at":"2019-03-18T03:45:55.000Z",
"filled_notional":"1.504",
"filled_size":"0.4",
"funds":"",
"instrument_id":"EOS-USDT",
"notional":"",
"order_id":"2499854635054080",
"order_type":"0",
"price":"3.76",
"price_avg":"3.76",
"product_id":"EOS-USDT",
"side":"buy",
"size":"0.4",
"status":"filled",
"state": "0",
"timestamp":"2019-03-18T03:45:55.000Z",
"type":"limit"
}
列出您当前所有的订单信息。这个请求支持分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。
GET/api/margin/v3/orders_pending
2019-03-20T07:51:51.138ZGET/api/margin/v3/orders_pending?limit=2&instrument_id=BTC- USDT&after=2500723297223680
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id等 |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 用户设置的订单ID |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单创建时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| state | String | 订单状态 |
0:等待成交 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
本接口只能查询所有未成交或者部分成交的订单
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
[
{
"client_oid":"oktlever56",
"created_at":"2019-03-20T08:21:49.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2512264176206848",
"order_type":"0",
"price":"3613.3",
"price_avg":"",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T08:21:49.000Z",
"type":"limit"
},
{
"client_oid":"oktlever55",
"created_at":"2019-03-20T08:21:49.000Z",
"filled_notional":"0",
"filled_size":"0",
"funds":"",
"instrument_id":"BTC-USDT",
"notional":"",
"order_id":"2512264174306304",
"order_type":"0",
"price":"3613.3",
"price_avg":"",
"product_id":"BTC-USDT",
"side":"buy",
"size":"0.001",
"status":"open",
"state":"0",
"timestamp":"2019-03-20T08:21:49.000Z",
"type":"limit"
}
]
获取最近的成交明细列表。这个请求支持分页，并且按时间倒序排序和存储，最新的排在最前面。请参阅分页部分以获取第一页之后的其他纪录。 本接口能查询最近3月的数据。
GET/api/margin/v3/fills
2018-09-13T02:44:54.823ZGET/api/margin/v3/fills?order_id=23239&instrument_id=btc- usdt&limit=1&after=2
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| order_id | String | 否 | 订单ID，不填写order_id，返回当前instrument_id下的所有订单成交明细 |
| instrument_id | String | 是 | 币对名称 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单ID |
| instrument_id | String | 币对名称 |
| price | String | 价格 |
| size | String | 数量 |
| order_id | String | 订单ID |
| timestamp | String | 订单成交时间 |
| exec_type | String | 流动性方向（T 或 M） |
| fee | String | 手续费 |
| side | String | 订单方向（buy 或 sell） |
| currency | String | 币种 |
此接口一笔成交会返回2条数据，一个以计价货币计算的，一个是以交易货币计算的。
手续费
fee字段表示这条账单记录所收取的手续费。
流动性
exec_type字段表示该账单是maker还是taker产生的。M表示Maker，T表示Taker。
分页
返回账单列表的ledger_id按降序排列，从最大ledger_id到最小ledger_id。OK- AFTER都会有这样的第一笔ledger_id，以便将来的请求使用OK-after参数将获取一个更大的ledger_id（新的账单）。
[
{
"created_at": "2019-11-25T07:45:05.000Z",
"currency": "USDT",
"exec_type": "M",
"fee": "-0.01915417",
"instrument_id": "OKB-USDT",
"ledger_id": "8161858573",
"liquidity": "M",
"order_id": "3927696997697536",
"price": "1.7793",
"product_id": "OKB-USDT",
"side": "buy",
"size": "19.1541645",
"timestamp": "2019-11-25T07:45:05.000Z"
},
{
"created_at": "2019-11-25T07:45:05.000Z",
"currency": "OKB",
"exec_type": "M",
"fee": "0",
"instrument_id": "OKB-USDT",
"ledger_id": "8161858572",
"liquidity": "M",
"order_id": "3927696997697536",
"price": "1.7793",
"product_id": "OKB-USDT",
"side": "sell",
"size": "10.765",
"timestamp": "2019-11-25T07:45:05.000Z"
}
]
获取币币杠杆账户币种杠杆倍数
GET/api/margin/v3/accounts/<instrument_id>/leverage
GET/api/margin/v3/accounts/btc-usdt/leverage
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 币对名称，如：BTC-USDT |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 币对名称，如：BTC-USDT |
| leverage | String | 杠杆倍数 |
| error_code | String | 错误码 |
| error_message | String | 错误信息 |
| result | Boolean | 请求结果 |
{
"error_code": "",
"error_message": "",
"instrument_id": "btc-usdt",
"leverage": "3",
"result": true
}
设置币币杠杆账户币对杠杆倍数。
POST /api/margin/v3/accounts/<instrument_id>/leverage
POST /api/margin/v3/accounts/BTC-USDT/leverage{"leverage":"10"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| leverage | String | 是 | 要设定的杠杆倍数，填写2-10的数值 |
| instrument_id | String | 是 | 币对，如：BTC-USDT,LTC-USDT |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| leverage | String | 已设定的杠杆倍数，2-10的数值 |
| instrument_id | String | 币对，如：BTC-USDT |
| error_code | String | 错误码 |
| error_message | String | 错误信息 |
| result | Boolean | 请求结果 |
{
"error_code": "",
"error_message": "",
"instrument_id": "BTC-USDT",
"leverage": "7",
"result": true
}
要实时更新市场数据，请参阅WebSocket文档，以便获取并创建更完整的深度和交易数据。
币币杠杆交易和币币交易共享行情和深度数据，请移步币币行情查看接口。
获取现货杠杆标记价格。此接口为公共接口，不需要身份验证。
GET/api/margin/v3/instruments/<instrument_id>/mark_price
GET/api/margin/v3/instruments/EOS-USDT/mark_price
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 杠杆币对名称 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 杠杆币对名称 |
| mark_price | String | 指定杠杆的标记价格 |
| timestamp | String | 返回请求时间 |
{
"mark_price":"3.591",
"instrument_id":"EOS-USDT",
"timestamp":"2019-06-22T06:28:53.208Z"
}
交割合约交易的行情信息，账户信息，订单操作，订单查询，账单明细查询。
获取账户所有合约的持仓信息。请求此接口，会在数据库遍历所有币对下的持仓数据，有大量的性能消耗,请求频率较低。建议用户传合约ID获取持仓信息。
GET/api/futures/v3/position
GET/api/futures/v3/position
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| liquidation_price | String | 预估强平价 |
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 多仓结算基准价 |
| realised_pnl | String | 已实现盈余 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 空仓结算基准价 |
| instrument_id | String | 合约ID，如BTC-USD-180213 |
| leverage | String | 杠杆倍数 |
| created_at | String | 创建时间 |
| updated_at | String | 最近一次加减仓的更新时间 |
| short_margin | String | 空仓保证金 |
| short_pnl | String | 空仓收益 |
| short_pnl_ratio | String | 空仓收益率 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| short_settled_pnl | String | 空仓已结算收益 |
| long_margin | String | 多仓保证金 |
| long_pnl | String | 多仓收益 |
| long_pnl_ratio | String | 多仓收益率 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_settled_pnl | String | 多仓已结算收益 |
| last | String | 最新成交价 |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_margin | String | 多仓保证金 |
| long_liqui_price | String | 多仓强平价格 |
| long_pnl_ratio | String | 多仓收益率 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 多仓结算基准价 |
| realised_pnl | String | 已实现盈余 |
| long_leverage | String | 多仓杠杆倍数 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_margin | String | 空仓保证金 |
| short_liqui_price | String | 空仓强平价格 |
| short_pnl_ratio | String | 空仓收益率 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 空仓结算基准价 |
| short_leverage | String | 空仓杠杆倍数 |
| instrument_id | String | 合约ID，如BTC-USD-180213 |
| created_at | String | 创建时间 |
| updated_at | String | 最近一次加减仓的更新时间 |
| short_margin_ratio | String | 空仓保证金率 |
| short_maint_margin_ratio | String | 空仓维持保证金率 |
| short_pnl | String | 空仓收益 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| long_margin_ratio | String | 多仓保证金率 |
| long_maint_margin_ratio | String | 多仓维持保证金率 |
| long_pnl | String | 多仓收益 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_settled_pnl | String | 多仓已结算收益 |
| short_settled_pnl | String | 空仓已结算收益 |
| last | String | 最新成交价 |
{
"result": true,
"holding": [
[
{
"long_qty": "0",
"long_avail_qty": "0",
"long_avg_cost": "0",
"long_settlement_price": "0",
"realised_pnl": "-0.0001318",
"short_qty": "0",
"short_avail_qty": "0",
"short_avg_cost": "8181.88",
"short_settlement_price": "8181.88",
"liquidation_price": "113.81",
"instrument_id": "BTC-USD-191018",
"leverage": "10",
"created_at": "2019-10-08T11:56:07.922Z",
"updated_at": "2019-10-08T14:02:06.861Z",
"margin_mode": "crossed",
"short_margin": "0.0",
"short_pnl": "0.0",
"short_pnl_ratio": "-0.027818392",
"short_unrealised_pnl": "0.0",
"long_margin": "0.0",
"long_pnl": "0.0",
"long_pnl_ratio": "0.0",
"long_unrealised_pnl": "0.0",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8202.92"
},
{
"long_qty": "2",
"long_avail_qty": "2",
"long_avg_cost": "8260",
"long_settlement_price": "8260",
"realised_pnl": "0.00020928",
"short_qty": "2",
"short_avail_qty": "2",
"short_avg_cost": "8259.99",
"short_settlement_price": "8259.99",
"liquidation_price": "113.81",
"instrument_id": "BTC-USD-191227",
"leverage": "10",
"created_at": "2019-09-25T07:58:42.129Z",
"updated_at": "2019-10-08T14:02:51.029Z",
"margin_mode": "crossed",
"short_margin": "0.002422",
"short_pnl": "6.9E-6",
"short_pnl_ratio": "0.002477997",
"short_unrealised_pnl": "6.9E-6",
"long_margin": "0.002422",
"long_pnl": "-6.92E-6",
"long_pnl_ratio": "-0.002478",
"long_unrealised_pnl": "-6.92E-6",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8257.65"
}
]
]
}
{
"result": true,
"holding": [
[
{
"long_qty": "0",
"long_avail_qty": "0",
"long_margin": "0",
"long_liqui_price": "0",
"long_pnl_ratio": "0",
"long_avg_cost": "0",
"long_settlement_price": "0",
"realised_pnl": "-0.00001222",
"short_qty": "2",
"short_avail_qty": "2",
"short_margin": "0.00244443",
"short_liqui_price": "9040.9",
"short_pnl_ratio": "-0.06463685",
"short_avg_cost": "8181.88",
"short_settlement_price": "8181.88",
"instrument_id": "BTC-USD-191018",
"long_leverage": "0",
"short_leverage": "10",
"created_at": "2019-10-08T11:56:07.922Z",
"updated_at": "2019-10-08T11:56:08.002Z",
"margin_mode": "fixed",
"short_margin_ratio": "0.09410211",
"short_maint_margin_ratio": "0.005",
"short_pnl": "-1.5915E-4",
"short_unrealised_pnl": "-1.5915E-4",
"long_margin_ratio": "10000.0",
"long_maint_margin_ratio": "0.005",
"long_pnl": "0.0",
"long_unrealised_pnl": "0.0",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8237.72"
},
{
"long_qty": "4",
"long_avail_qty": "4",
"long_margin": "0.00323844",
"long_liqui_price": "7762.09",
"long_pnl_ratio": "0.10622415",
"long_avg_cost": "8234.43",
"long_settlement_price": "8234.43",
"realised_pnl": "-0.00000296",
"short_qty": "2",
"short_avail_qty": "2",
"short_margin": "0.00241105",
"short_liqui_price": "9166.74",
"short_pnl_ratio": "0.00248854",
"short_avg_cost": "8295.13",
"short_settlement_price": "8295.13",
"instrument_id": "BTC-USD-191227",
"long_leverage": "15",
"short_leverage": "10",
"created_at": "2019-09-25T07:58:42.129Z",
"updated_at": "2019-10-08T13:12:09.438Z",
"margin_mode": "fixed",
"short_margin_ratio": "0.1002126",
"short_maint_margin_ratio": "0.005",
"short_pnl": "5.7E-6",
"short_unrealised_pnl": "5.7E-6",
"long_margin_ratio": "0.07427591",
"long_maint_margin_ratio": "0.005",
"long_pnl": "3.4407E-4",
"long_unrealised_pnl": "3.4407E-4",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8294.07"
}
]
]
}
获取某个合约的持仓信息。
GET/api/futures/v3/<instrument_id>/position
GET/api/futures/v3/BTC-USD-180309/position
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| liquidation_price | String | 预估强平价 |
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 结算基准价 |
| realised_pnl | String | 已实现盈余 |
| leverage | String | 杠杆倍数 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 结算基准价 |
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| created_at | String | 创建时间 |
| updated_at | String | 最近一次加减仓的更新时间 |
| short_margin | String | 空仓保证金 |
| short_pnl | String | 空仓收益 |
| short_pnl_ratio | String | 空仓收益率 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| short_settled_pnl | String | 空仓已结算收益 |
| long_margin | String | 多仓保证金 |
| long_pnl | String | 多仓收益 |
| long_pnl_ratio | String | 多仓收益率 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_settled_pnl | String | 多仓已结算收益 |
| last | String | 最新成交价 |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_margin | String | 多仓保证金 |
| long_liqui_price | String | 多仓强平价格 |
| long_pnl_ratio | String | 多仓盈亏比 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 结算基准价 |
| realised_pnl | String | 已实现盈余 |
| long_leverage | String | 多仓杠杆倍数 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_margin | String | 空仓保证金 |
| short_liqui_price | String | 空仓强平价格 |
| short_pnl_ratio | String | 空仓盈亏比 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 结算基准价 |
| short_leverage | String | 空仓杠杆倍数 |
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| created_at | String | 创建时间 |
| updated_at | String | 最近一次加减仓的更新时间 |
| short_margin_ratio | String | 空仓保证金率 |
| short_maint_margin_ratio | String | 空仓维持保证金率 |
| short_pnl | String | 空仓收益 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| short_settled_pnl | String | 空仓已结算收益 |
| long_margin_ratio | String | 多仓保证金率 |
| long_maint_margin_ratio | String | 多仓维持保证金率 |
| long_pnl | String | 多仓收益 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_settled_pnl | String | 多仓已结算收益 |
| last | String | 最新成交价 |
{
"result": true,
"holding": [
{
"long_qty": "2",
"long_avail_qty": "2",
"long_avg_cost": "8260",
"long_settlement_price": "8260",
"realised_pnl": "0.00020928",
"short_qty": "2",
"short_avail_qty": "2",
"short_avg_cost": "8259.99",
"short_settlement_price": "8259.99",
"liquidation_price": "113.81",
"instrument_id": "BTC-USD-191227",
"leverage": "10",
"created_at": "2019-09-25T07:58:42.129Z",
"updated_at": "2019-10-08T14:02:51.029Z",
"margin_mode": "crossed",
"short_margin": "0.00242197",
"short_pnl": "6.63E-6",
"short_pnl_ratio": "0.002477997",
"short_unrealised_pnl": "6.63E-6",
"long_margin": "0.00242197",
"long_pnl": "-6.65E-6",
"long_pnl_ratio": "-0.002478",
"long_unrealised_pnl": "-6.65E-6",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8257.57"
}
],
"margin_mode": "crossed"
}
{
"result": true,
"holding": [
{
"long_qty": "4",
"long_avail_qty": "4",
"long_margin": "0.00323844",
"long_liqui_price": "7762.09",
"long_pnl_ratio": "0.06052306",
"long_avg_cost": "8234.43",
"long_settlement_price": "8234.43",
"realised_pnl": "-0.00000296",
"short_qty": "2",
"short_avail_qty": "2",
"short_margin": "0.00241105",
"short_liqui_price": "9166.74",
"short_pnl_ratio": "0.03318052",
"short_avg_cost": "8295.13",
"short_settlement_price": "8295.13",
"instrument_id": "BTC-USD-191227",
"long_leverage": "15",
"short_leverage": "10",
"created_at": "2019-09-25T07:58:42.129Z",
"updated_at": "2019-10-08T13:12:09.438Z",
"margin_mode": "fixed",
"short_margin_ratio": "0.10292507",
"short_maint_margin_ratio": "0.005",
"short_pnl": "7.853E-5",
"short_unrealised_pnl": "7.853E-5",
"long_margin_ratio": "0.07103743",
"long_maint_margin_ratio": "0.005",
"long_pnl": "1.9841E-4",
"long_unrealised_pnl": "1.9841E-4",
"long_settled_pnl": "0",
"short_settled_pnl": "0",
"last": "8266.99"
}
],
"margin_mode": "fixed"
}
获取合约账户所有币种的账户信息。请求此接口，会在数据库遍历所有币对下的账户数据，有大量的性能消耗,请求频率较低。建议用户传币种获取账户信息信息。
GET/api/futures/v3/accounts
GET/api/futures/v3/accounts
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 账户余额币种 |
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| equity | String | 账户权益 |
| total_avail_balance | String | 账户余额 |
| margin | String | 保证金（挂单冻结+持仓已用） |
| margin_frozen | String | 持仓已用保证金 |
| margin_for_unfilled | String | 挂单冻结保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| margin_ratio | String | 保证金率 |
| maint_margin_ratio | String | 维持保证金率 |
| liqui_mode | string | 强平模式：tier（梯度强平） |
| can_withdraw | string | 可划转数量 |
| liqui_fee_rate | string | 强平手续费 |
| underlying | string | 标的指数，如：BTC-USD，BTC-USDT |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 账户余额币种 |
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| fixed_balance | String | 逐仓账户余额 |
| available_qty | String | 逐仓可用余额 |
| margin_frozen | String | 持仓已用保证金 |
| margin_for_unfilled | String | 挂单冻结保证金 |
| instrument_id | String | 合约ID，如BTC-USD-180213，BTC-USDT-191227 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| equity | String | 账户权益（账户动态权益） |
| total_avail_balance | String | 账户余额（账户静态权益） |
| auto_margin | String | 是否自动追加保证金 |
1: 自动追加已开启 |
||
0: 自动追加未开启 |
||
| liqui_mode | string | 强平模式：tier（梯度强平） |
| can_withdraw | string | 可划转数量 |
所有持仓/所有账户信息，没有持仓/持币时返回空数组；单个持仓/单个账户信息没有持仓/持币时返回各字段均为默认值；
逐仓：
1.账户权益：账户权益=账户余额+逐仓仓位账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
2.可用：可用余额=账户余额+逐仓仓位账户余额+本合约已实现盈亏- 当前仓位的持仓所需保证金 - 挂单冻结保证金
全仓：
1.账户权益=账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
2.可用余额=账户余额+所有合约已实现盈亏+所有合约的未实现- 所有仓位持仓所需保证金 - 挂单冻结保证金
{
"info":{
"btc":{
"can_withdraw":"0.00994739",
"currency":"BTC",
"equity":"0.00994739",
"liqui_fee_rate":"0.0005",
"liqui_mode":"tier",
"maint_margin_ratio":"0.005",
"margin":"0",
"margin_for_unfilled":"0",
"margin_frozen":"0",
"margin_mode":"crossed",
"margin_ratio":"10000",
"realized_pnl":"0",
"total_avail_balance":"0.00994739",
"underlying":"BTC-USD",
"unrealized_pnl":"0"
}
}
}
{
"info":{
"bch":{
"auto_margin":"0",
"can_withdraw":"0.00169207",
"contracts":[
{
"available_qty":"0.00169207",
"fixed_balance":"0",
"instrument_id":"BCH-USD-191227",
"margin_for_unfilled":"0",
"margin_frozen":"0",
"realized_pnl":"0",
"unrealized_pnl":"0"
}
],
"currency":"BCH",
"equity":"0.00169207",
"liqui_mode":"tier",
"margin_mode":"fixed",
"total_avail_balance":"0.00169207"
}
}
}
获取单个币种的合约账户信息。
GET/api/futures/v3/accounts/<underlying>
GET/api/futures/v3/accounts/btc-usd
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如：btc-usd,btc-usdt |
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| equity | String | 账户权益 |
| total_avail_balance | String | 账户余额 |
| margin | String | 保证金（挂单冻结+持仓已用） |
| margin_frozen | String | 持仓已用保证金 |
| margin_for_unfilled | String | 挂单冻结保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| margin_ratio | String | 保证金率 |
| maint_margin_ratio | String | 维持保证金率 |
| liqui_mode | string | 强平模式：tier（梯度强平） |
| can_withdraw | string | 可划转数量 |
| liqui_fee_rate | string | 强平手续费 |
| underlying | string | 标的指数，如：BTC-USD，BTC-USDT |
| currency | string | 账户余额币种 |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| fixed_balance | String | 逐仓账户余额 |
| available_qty | String | 逐仓可用余额 |
| margin_frozen | String | 持仓已用保证金 |
| margin_for_unfilled | String | 挂单冻结保证金 |
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| equity | String | 账户权益 |
| total_avail_balance | String | 账户余额 |
| auto_margin | String | 是否自动追加保证金 |
1: 自动追加已开启 |
||
0: 自动追加未开启 |
||
| liqui_mode | string | 强平模式：tier（梯度强平） |
| can_withdraw | string | 可划转数量 |
| currency | string | 账户余额币种 |
所有持仓/所有账户信息，没有持仓/持币时返回空JSON；单个持仓/单个账户信息没有持仓/持币时返回各字段均为默认值
逐仓：
1.账户权益：账户权益=账户余额+逐仓仓位账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
2.可用：可用余额=账户余额+逐仓仓位账户余额+本合约已实现盈亏- 当前仓位的持仓所需保证金 - 挂单冻结保证金
全仓：
1.账户权益=账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
2.可用余额=账户余额+所有合约已实现盈亏+所有合约的未实现- 所有仓位持仓所需保证金 - 挂单冻结保证金
{
"equity": "0",
"margin": "0",
"realized_pnl": "0",
"unrealized_pnl": "0",
"margin_ratio": "10000",
"margin_mode": "crossed",
"total_avail_balance": "0",
"margin_frozen": "0",
"margin_for_unfilled": "0",
"liqui_mode": "tier",
"maint_margin_ratio": "0.005",
"liqui_fee_rate": "0.0005",
"can_withdraw": "0",
"underlying": "BTC-USD",
"currency": "BTC"
}
{
"total_avail_balance": "0",
"contracts": [
{
"available_qty": "0",
"fixed_balance": "0",
"instrument_id": "BTC-USD-191227",
"margin_for_unfilled": "0",
"margin_frozen": "0",
"realized_pnl": "0",
"unrealized_pnl": "0"
}
],
"equity": "0",
"margin_mode": "fixed",
"auto_margin": "0",
"liqui_mode": "tier",
"can_withdraw": "0",
"currency": "BTC"
}
获取合约账户币种杠杆倍数
GET/api/futures/v3/accounts/<underlying>/leverage
GET/api/futures/v3/accounts/btc-usdt/leverage
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如：BTC-USD，BTC-USDT |
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| underlying | String | 标的指数，如：BTC-USD，BTC-USDT |
| leverage | String | 杠杆倍数 |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| long_leverage | String | 多头杠杆倍数 |
| short_leverage | String | 空头杠杆倍数 |
全仓同一个币种只允许有一种杠杆倍数，逐仓同一个合约同一个方向只能用一种杠杆倍数。
1.全仓模式：
{
"leverage": "12",
"margin_mode": "crossed",
"underlying": "BTC-USD"
}
2.逐仓模式：
{
"BTC-USD-191227": {
"long_leverage": "20",
"short_leverage": "10"
},
"BTC-USD-191108": {
"long_leverage": "10",
"short_leverage": "10"
},
"margin_mode": "fixed",
"BTC-USD-191101": {
"long_leverage": "10",
"short_leverage": "10"
}
}
设置合约账户币种杠杆倍数。当下单时，系统会按照您设置的杠杆倍数进行下单。
POST /api/futures/v3/accounts/<underlying>/leverage
POST /api/futures/v3/accounts/BTC-USD/leverage{"leverage":"10"}（全仓示例）
POST /api/futures/v3/accounts/BTC-USD/leverage{"instrument_id":"BTC- USD-180213","direction":"long","leverage":"10"}（逐仓示例）
| 全仓参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| leverage | String | 是 | 要设定的杠杆倍数，填写1-100的数值 |
| underlying | String | 是 | 标的指数，如：BTC-USD,BTC-USDT |
| 逐仓参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| direction | String | 是 | 开仓方向 |
long（做多）或short（做空） |
|||
| leverage | String | 是 | 要设定的杠杆倍数，填写1-100的数值 |
| underlying | String | 是 | 标的指数，如：BTC-USD,BTC-USDT |
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| underlying | String | 标的指数，如：BTC-USD，BTC-USDT |
| leverage | String | 已设定的杠杆倍数，1-100的数值 |
| result | String | 返回设定结果，成功或错误码 |
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| instrument_id | String | 合约ID，如BTC-USD-180213 |
| direction | String | 开仓方向 |
long（做多）或short（做空） |
||
| leverage | String | 已设定的杠杆倍数，1-100的数值 |
| result | String | 返回设定结果，成功或错误码 |
| underlying | String | 是 |
仓位设定：全仓，逐仓
全仓的话：传currency ,传杠杆倍数
逐仓的话：传instrument_id，传方向，传杠杆倍数
全仓同一个币种只允许有一种杠杆倍数，逐仓同一个合约同一个方向只能用一种杠杆倍数。
1.全仓模式：
{
"result": true,
"leverage": "12",
"margin_mode": "crossed",
"currency": "BTC",
"underlying": "BTC-USD"
}
2.逐仓模式：
{
"result": true,
"BTC-USD-191227": {
"short": "10",
"long": "20"
},
"margin_mode": "fixed"
}
列出帐户资产流水。帐户资产流水是指导致帐户余额增加或减少的行为。本接口能查询最近三个月的数据。
GET/api/futures/v3/accounts/<underlying>/ledger
GET/api/futures/v3/accounts/eos-usd/ledger?after=2510946217009854&limit=3
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如：btc-usd,btc-usdt |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| type | String | 否 | 1.开多 |
2.开空 |
|||
3.平多 |
|||
4.平空 |
|||
5.手续费 |
|||
6.转入， |
|||
7.转出 |
|||
8.清算已实现盈亏 |
|||
13.强平平多 |
|||
14.强平平空 |
|||
15.交割平多 |
|||
16.交割平空 |
|||
17.清算未实现收益-多头 |
|||
18.清算未实现收益-空头 |
|||
20.强减空 |
|||
21.强减多 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| ledger_id | String | 账单ID |
| underlying | String | 标的指数，如：btc-usd,btc-usdt |
| amount | String | 变动数量 |
| type | String | 流水来源 |
| timestamp | String | 账单创建时间 |
| details | String | |
如果type是trade或者fee，则会有该details字段将包含order，instrument信息,如果type是transfer，则会有该details字段将包含from，to信息 |
||
| order_id | String | 订单ID |
| instrument_id | String | 合约ID |
| from | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| to | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| balance | String | 开仓平仓的张数（开仓为正数，平仓为负数，当type是fee 时，balance为0） |
| currency | string | 账户余额币种 |
| 流水来源类型 | 参数类型 | 描述 |
| --- | --- | --- |
| transfer | String | 资金转入/转出 |
| match | String | 开多/开空/平多/平空 |
| fee | String | 手续费 |
| settlement | String | 清算/分摊/多结算/空结算 |
| liquidation | String | 强平多/强平空/交割平多/交割平空 |
[
{
"ledger_id":"3786201700599811",
"timestamp":"2019-10-31T08:00:53.097Z",
"amount":"0",
"balance":"0",
"currency":"btc-usd",
"underlying":"BTC-USD",
"type":"settlement",
"details":{
"order_id":"0",
"instrument_id":"BTC-USD-191227"
}
}
]
OKEx合约交易提供了限价单下单模式。只有当您的账户有足够的资金才能下单。一旦下单，您的账户资金将在订单生命周期内被冻结。被冻结的资金以及数量取决于订单指定的类型和参数。
当前最高可开杠杆倍数由您的持仓、挂单及开仓时新的下单张数决定，详情请见：https://www.okex.com/derivatives/futures/position
POST /api/futures/v3/order
POST /api/futures/v3/order{"client_oid": "12233456","order_type":"1","instrument_id":"BTC- USD-180213","type":"1","price":"432.11","size":"2","match_price":"0"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| type | String | 是 | 1:开多 |
2:开空 |
|||
3:平多 |
|||
4:平空 |
|||
| order_type | String | 否 | 参数填数字 |
0：普通委托（order type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
|||
4：市价委托 |
|||
| price | String | 否 | 委托价格 |
| size | String | 是 | 买入或卖出合约的数量（以张计数） |
| match_price | String | 否 | 是否以对手价下单(0:不是; |
1:是)，默认为0，当取值为1时，price字段无效。当以对手价下单，order_type只能选择0（普通委托） |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| order_id | String | 订单ID，下单失败时，此字段值为-1 |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | Boolean | 调用接口返回结果 |
instrument_id
instrument_id必须是有效的合约ID。合约列表可通过/ instruments接口获取。
client_oid
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符（此功能 2019.2.28 号正式上线）
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
type
下单时，您可以指定订单类型。在您没有持仓时，只能选择开多和开空。您只能对持仓合约进行平仓。
price
price表示买入或卖出每张合约的价格。价格必须是价格步长tick_size的倍数。价格步长tick_size是价格的最小增量，可通过instruments接口获取。
size
size表示买入或卖出合约的张数。数量必须是整数。
match_price
对手价表示你希望以目前对手方的最优价格成交。如果你下的是买单，选择以对手价下单表示你用当前卖一价进行下单。如果你下的是卖单，选择以对手价下单表示你用当前买一价进行下单。
订单生命周期
HTTP请求将在订单被拒绝（资金不足，参数无效等）或下单成功（由匹配引擎接受）时作出响应。一个200响应表示该订单被接收并且进入撮合。进入撮合的订单可以部分或全部立即成交（取决于价格和市场条件）。部分成交的时候将把订单的剩余数量继续进行撮合。完全成交的订单将进入已成交状态。
监听行情数据的用户建议使用client_oid字段以便在接受到的信息中标识对应的数据。
响应
成功接受的订单将被分配一个订单ID。成功接受的订单表示撮合引擎已经接受的订单。
未成交的订单不会过期，并将保持撮合状态，直到被成交或取消。
{
"result":true,
"error_message":"",
"error_code":"0",
"client_oid":"oktfuture8",
"order_id":"2517062038154240"
}
批量进行合约下单操作。每个合约可批量下10个单。
POST /api/futures/v3/orders
POST /api/futures/v3/orders{"instrument_id":"ETH- USD-181228","orders_data":[{"order_type":"1","client_oid":"f379a96206fa4b778e1554c6dc969687","type":"1","price":"180.0","size":"1","match_price":"0"}]}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-190927 |
| orders_data | List | 是 | JSON类型的字符串 |
例：[{order_type:"0",price:"5",size:"2",type:"1",match_price:"1"},{order_type:"0",price:"2",size:"3",type:"1",match_price:"1"}] |
|||
最大下单量为10，当以对手价下单，order_type只能选择0（普通委托） 。 |
|||
price, size, type, match_price 参数参考future_trade接口中的说明 |
|||
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| order_type | String | 否 | 参数填数字 |
0：普通委托（order_type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| order_info | String | 订单信息 |
| order_id | String | 订单ID，下单失败时，此字段值为-1 |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
client_oid用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
只要其中任何一单下单成功，result就会返回true，
返回的结果数据和orders_data提交订单数据顺序一致。如果下单失败，则order_id为-1，error_code是错误码提示，error_message是错误信息。
{
"result":true,
"order_info":[
{
"error_message":"",
"error_code":"0",
"client_oid":"oktfuture18",
"order_id":"2517748155771904"
},
{
"error_message":"",
"error_code":"0",
"client_oid":"oktfuture19",
"order_id":"2517748157541376"
}
]
}
撤销之前下的未完成订单。
POST /api/futures/v3/cancel_order/<instrument_id>/<order_id> or <client_oid>
POST /api/futures/v3/cancel_order/BTC-USD-180309/1407616797780992
或
POST /api/futures/v3/cancel_order/BTC-USD-180309/1407616797780992ee
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| order_id | String | 非必填 | order_id和client_oid必须且只能选一个填写，订单ID |
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| client_oid | String | 非必填 | order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| order_id | String | 订单ID |
| result | String | 撤单申请结果 |
| instrument_id | String | 合约ID，如BTC-USD-180213,,BTC-USDT-191227 |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
使用client_oid撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
使用client_oids撤单时返回参数包含order_ids和client_oids,
使用order_ids撤单时返回参数不包含client_oids
这order_id是服务器分配的订单ID，而不是用户传的的client_oid
如果订单无法取消（已经成交或已取消），那么返回的报错内容里将显示相应的原因。
返回值是已发起撤销操作的订单ID，不代表这些订单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
1.用client_oid撤单的返回值：
{
"result":true,
"error_message":"",
"error_code":"0",
"client_oid":"oktfuture10",
"order_id":"2517514559122432",
"instrument_id":"EOS-USD-190628"
}
2.用order_id撤单的返回值：
{
"result":true,
"error_message":"",
"error_code":"0",
"order_id":"2517535534836736",
"instrument_id":"EOS-USD-190628"
}
根据指定的order_id撤销某个合约的未完成订单，每次最多可撤10个单。
POST /api/futures/v3/cancel_batch_orders/<instrument_id>
POST /api/futures/v3/cancel_batch_orders/BTC-USD-180309{"order_ids":[ "2517748157541376", "2517748155771904"]}
或
POST /api/futures/v3/cancel_batch_orders/BTC-USD-180309{"client_oids":[ "oktfuture19","oktfuture18"]}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 撤销指定合约品种的订单 如：BTC-USD-180309,BTC-USDT-191227 |
| order_ids | List | 非必填 | order_id和client_oid必须且只能选一个填写，撤销指定的订单ID |
| client_oids | List | 非必填 | |
order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单， |
|||
| 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 撤销指定合约品种的订单 如：BTC-USD-180309,BTC-USDT-191227 |
| order_ids | String | 撤销指定的订单ID |
| client_oids | String | 由您设置的订单ID来识别您的订单 |
| result | String | 调用接口返回结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
批量撤单时候，要么都是order_id要么都是client_oids，否则会提示错误
使用client_oids批量撤单时，目前只支持一个币对下撤10个client_oids，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
order_ids 和client_oids
必须且只能选一个填写，使用client_oids撤单时返回参数包含order_ids和client_oids，使用order_ids撤单时返回参数不包含client_oids
返回值是已发起撤销操作的订单ID列表，不代表这些订单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
无法保证一定会成功撤销，建议用户调用批量撤单接口后，再调用获取订单列表接口确认。
1.用client_oids批量撤单的返回值：
{
"result":true,
"error_message":"",
"error_code":"0",
"order_ids":[
"2517748157541376",
"2517748155771904"
],
"instrument_id":"EOS-USD-190628",
"client_oids":[
"oktfuture19",
"oktfuture18"
]
}
2.用order_ids批量撤单的返回值：
{
"result":true,
"error_message":"",
"error_code":"0",
"order_ids":[
"2517748157541376",
"2517748155771904"
],
"instrument_id":"EOS-USD-190628"
}
列出您当前所有的订单信息。本接口能查询最近三个月的数据。这个请求支持分页，并且按委托时间倒序排序和存储，最新的排在最前面。
GET/api/futures/v3/orders/<instrument_id>
GET/api/futures/v3/orders/BTC- USD-190628?state=2&after=2517062044057601&limit=2
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| state | String | 是 | 订单状态 |
-2:失败 |
|||
-1:撤单成功 |
|||
0:等待成交 |
|||
1:部分成交 |
|||
2:完全成交 |
|||
3:下单中 |
|||
4:撤单中 |
|||
6: 未完成（等待成交+部分成交） |
|||
7:已完成（撤单成功+完全成交） |
|||
| after | String | 否 | 请求此id之前(更旧的数据)的分页内容，传的值为对应接口的order_id； |
| before | String | 否 | 请求此id之后(更新的数据)的分页内容，传的值为对应接口的order_id； |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| client_oid | String | 用户设置的订单ID |
| size | String | 委托数量 |
| timestamp | Date | 委托时间 |
| filled_qty | String | 成交数量 |
| fee | String | 手续费 |
| order_id | String | 订单ID |
| price | String | 委托价格 |
| price_avg | String | 成交均价 |
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| contract_val | String | 合约面值 |
| leverage | String | 杠杆倍数，1-100的数值 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
4：市价委托 |
||
| pnl | String | 收益 |
| state | String | 订单状态 |
-2：失败 |
||
-1：撤单成功 |
||
0：等待成交 |
||
1：部分成交 |
||
2：完全成交 |
||
3：下单中 |
||
4：撤单中 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
如果订单在其生命周期内没有任何成交，其记录可能被清除。这表示订单详细信息将不可用本接口来获取。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
{
"result": true,
"order_info": [
{
"instrument_id": "BTC-USD-191227",
"size": "2",
"timestamp": "2019-09-25T08:42:34.000Z",
"filled_qty": "2",
"fee": "-0.0000119",
"order_id": "3582522429644800",
"price": "8160.55",
"price_avg": "8402.36",
"status": "2",
"state": "2",
"type": "3",
"contract_val": "100",
"leverage": "10",
"client_oid": "",
"pnl": "-0.00011292",
"order_type": "0"
},
{
"instrument_id": "BTC-USD-191227",
"size": "2",
"timestamp": "2019-09-25T07:58:42.000Z",
"filled_qty": "2",
"fee": "-0.00001183",
"order_id": "3582349944101888",
"price": "8454.42",
"price_avg": "8454.42",
"status": "2",
"state": "2",
"type": "1",
"contract_val": "100",
"leverage": "10",
"client_oid": "",
"pnl": "0",
"order_type": "0"
}
]
}
通过订单ID获取单个订单信息。已撤销的未成交单只保留2个小时。
GET/api/futures/v3/orders/<instrument_id>/<order_id>
或
GET/api/futures/v3/orders/<instrument_id>/<client_oid>
GET/api/futures/v3/orders/BTC-USD-180213/888845120785408
或
GET/api/futures/v3/orders/BTC-USD-180213/888845120785408ee
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| order_id | String | 否 | 订单ID order_id和client_oid必须且只能选一个填写 |
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| client_oid | String | 否 | order_id和client_oid必须且只能选一个填写 .由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写） 1-32位字符 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| size | String | 委托数量 |
| timestamp | String | 委托时间 |
| filled_qty | String | 成交数量 |
| fee | String | 手续费 |
| order_id | String | 订单ID |
| price | String | 委托价格 |
| price_avg | String | 成交均价 |
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| contract_val | String | 合约面值 |
| leverage | String | 杠杆倍数，1-100的数值 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
4：市价委托 |
||
| pnl | String | 收益 |
| state | String | 订单状态 |
-2：失败 |
||
-1：撤单成功 |
||
0：等待成交 |
||
1：部分成交 |
||
2：完全成交 |
||
3：下单中 |
||
4：撤单中 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
本接口只能查询最近三个月的已成交和已撤销订单信息。
如果订单在其生命周期内没有任何成交，其记录可能被清除，则响应可能因为没有相应的匹配而返回状态码404。
未成交的订单可能会根据市场情况在你发起请求和服务器响应之间改变状态。
{
"instrument_id": "BTC-USD-191227",
"size": "2",
"timestamp": "2019-09-25T08:42:34.000Z",
"filled_qty": "2",
"fee": "-0.0000119",
"order_id": "3582522429644800",
"price": "8160.55",
"price_avg": "8402.36",
"status": "2",
"state": "2",
"type": "3",
"contract_val": "100",
"leverage": "10",
"client_oid": "",
"pnl": "-0.00011292",
"order_type": "0"
}
获取最近的成交明细列表，本接口能查询最近7天的数据。
GET/api/futures/v3/fills
GET/api/futures/v3/fills?order_id=123123&instrument_id=BTC- USD-180309&after=2517062044057601&limit=50
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| order_id | String | 否 | 订单ID，不填写order_id，返回当前instrument_id下的所有订单成交明细 |
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的trade_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的trade_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| trade_id | String | 账单ID |
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| price | String | 价格 |
| order_qty | String | 数量 |
| order_id | String | 订单ID |
| created_at | String | 订单成交时间 |
| exec_type | String | 流动性方向（T 或 M） |
| fee | String | 手续费 |
| side | String | 订单方向（buy 或 sell） |
手续费
fee字段：负数的fee表示平台收取的手续费，正数的fee表示表示平台向达到指定lv交易等级的用户支付的挂单奖励（返佣）
流动性
exec_type字段表示该账单是maker还是taker产生的。M表示Maker，T表示Taker。
分页
返回账单列表的trade_id按降序排列，从最大trade_id到最小trade_id。OK- after都会有这样的第一笔trade_id，以便将来的请求使用OK-after参数将获取一个更大的trade_id（新的账单）。
[
{
"trade_id":"2517062044057601",
"instrument_id":"EOS-USD-190628",
"price":"3.692",
"order_qty":"1",
"order_id":"251706627555816789240",
"created_at":"2019-03-21T04:41:58.0Z",
"exec_type":"T",
"fee":"-0.00081257",
"side":"buy"
}
]
设置合约币种账户模式，注意：当前有仓位或者有挂单时禁止切换账户模式。
POST /api/futures/v3/accounts/margin_mode
POST /api/futures/v3/accounts/margin_mode{"underlying":"btc- usd","margin_mode":"crossed"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如：BTC-USD,BTC-USDT |
| margin_mode | String | 是 | 账户模式 |
crossed:全仓 |
|||
fixed:逐仓 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| underlying | String | 标的指数，如：BTC-USD,BTC-USDT |
| margin_mode | String | 账户模式 |
crossed:全仓 |
||
fixed:逐仓 |
||
| result | String | 返回设定结果 |
{
"result": true,
"margin_mode": "fixed",
"underlying": "BTC-USD"
}
市价全平接口，其中BTC合约持仓小于或等于999张时才能调用，否则报错；类似的，其他币种合约的持仓应该小于或等于9999张。
POST /api/futures/v3/close_position
POST /api/futures/v3/close_position{"instrument_id":"BTC- USD-180213","direction":"long"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| direction | String | 是 | 平仓方向 |
long:平多 |
|||
short:平空 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| direction | String | 平仓方向 |
long:平多 |
||
short:平空 |
||
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
{
"result":true,
"error_message":"",
"error_code":"0",
"instrument_id":"BTC-USD-180213",
"direction":"long"
}
此接口，仅支持撤销平仓的所有挂单。不包括开仓的挂单。
POST /api/futures/v3/cancel_all
POST /api/futures/v3/cancel_all{"instrument_id":"BTC- USD-180213","direction":"long"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 ,BTC-USDT-191227 |
| direction | String | 是 | 平仓方向 |
long:平多 |
|||
short:平空 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 是 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| direction | String | 是 平仓方向 |
long:平多 |
||
short:平空 |
||
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
{
"result":true,
"error_message":"",
"error_code":"0",
"instrument_id":"BTC-USD-180213",
"direction":"long"
}
获取合约挂单冻结的数量.
GET/api/futures/v3/accounts/<instrument_id>/holds
GET/api/futures/v3/accounts/BTC-USD-181228/holds
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| amount | String | 冻结数量 |
| timestamp | String | 查询时间 |
{
"amount":"0.3073",
"instrument_id":"EOS-USD-190328",
"timestamp":"2019-03-26T03:19:48.035Z"
}
委托策略下单
提供止盈止损、跟踪委托、冰山委托和时间加权委托策略
POST /api/futures/v3/order_algo
POST /api/futures/v3/order_algo{"instrument_id":"BTC- USD-190328","type":"1","trigger_price":"432.11","order_type":"1","algo_price":"341.99","size":"2"}（止盈止损）
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-190328 ,BTC-USDT-191227 |
| type | String | 是 | 1:开多 |
2:开空 |
|||
3:平多 |
|||
4:平空 |
|||
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| size | String | 是 | 委托总数（以张计数），填写值1<=X<=1000000的整数 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| trigger_price | String | 是 | 触发价格，填写值0<X<=1000000 |
| algo_price | String | 是 | 委托价格，填写值0<X<=1000000 |
| algo_type | String | 否 | 1:限价 2:市场价；触发价格类型，默认是限价；为市场价时，委托价格不必填； |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| callback_rate | String | 是 | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 是 | 激活价格 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| algo_variance | String | 是 | 委托深度，填写值0.0001(0.01%)<=X<=0.01（1%） |
| avg_amount | String | 是 | 单笔均值，填写2-1000的整数（永续2-500的整数） |
| price_limit | String | 是 | 价格限制 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| sweep_range | String | 是 | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 是 | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 是 | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| price_limit | String | 是 | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 是 | 委托间隔，填写值5<=X<=120 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| result | String | 调用接口返回结果 |
| instrument_id | String | 合约ID，如BTC-USD-190328 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| algo_id | String | 订单ID，下单失败时，此字段值为-1 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
{
"result": true,
"algo_id": "3003646",
"error_message": "",
"error_code": "0",
"instrument_id": "EOS-USD-191227",
"order_type": "1"
}
委托策略撤单
根据指定的algo_id撤销某个合约的未完成订单，每次最多可撤6（冰山/时间）/10（计划/跟踪）个。
POST /api/futures/v3/cancel_algos
单个撤单：POST /api/futures/v3/cancel_algos{"instrument_id":"BTC- USD-190328","order_type":"1","algo_ids":["198273485"]}
批量撤单：POST /api/futures/v3/cancel_algos{"instrument_id":"BTC- USD-190328","order_type":"1","algo_ids":["198273485","198273486"]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 撤销指定的合约品种 e.g BTC-USDT-191227 ,BTC-USD-190328 |
| algo_ids | List | 是 | 撤销指定的委托单ID |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 撤销指定的合约品种 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| algo_ids | String | 撤销指定的委托单ID |
| result | String | 调用接口返回结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
返回参数
返回值是已发起撤销操作的委托单ID，不代表这些委托单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
解释说明
无法保证一定会成功撤销，建议用户调用撤单接口后，再调用获取委托单列表接口确认。
{
"result": true,
"error_message": "",
"error_code": "0",
"algo_id": "3003646",
"instrument_id": "EOS-USD-191227",
"order_type": "1"
}
获取委托单列表
列出您当前所有的订单信息。
GET/api/futures/v3/order_algo/<instrument_id>
GET/api/futures/v3/order_algo/BTC-USD-190328?order_type=1&status=2
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-190328 ,BTC-USDT-191227 |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| status | String | 见描述 | 【status和algo_id必填且只能填其一】 |
| 订单状态 | |||
1：待生效 |
|||
2：已生效 |
|||
3：已撤销 |
|||
4：部分生效 |
|||
5：暂停生效 |
|||
6：委托失败 |
|||
【只有冰山和加权有4、5状态】 |
|||
| algo_id | String | 见描述 | 【status和algo_id必填且只能填其一】 |
| 查询指定的委托单ID | |||
| before | string | 否 | 请求此id之后（更新的数据）的分页内容 |
| after | string | 否 | 请求此id之前（更旧的数据）的分页内容 |
| limit | string | 否 | 分页返回的结果集数量，默认为100，最大为100 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-190328 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| timestamp | String | 委托时间 |
| algo_ids | String | 委托单ID |
| status | String | 订单状态 |
1: 待生效 |
||
2: 已生效 |
||
3: 已撤销 |
||
4: 部分生效 |
||
5: 暂停生效 |
||
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| leverage | String | 杠杆倍数 |
| size | String | 委托数量（以张计数）,填写值1<=X<=1000000的整数 |
| order_id | String | 订单id |
止盈止损
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trigger_price | String | 触发价格，填写值0<X |
| algo_price | String | 委托价格，填写值0<X<=1000000 |
| real_amount | String | 实际成交数量 |
| algo_type | String | 1:限价 2:市场价； |
跟踪委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| callback_rate | String | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 激活价格 ，填写值0<X<=1000000 |
| real_amount | String | 实际委托数量 |
冰山委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| algo_variance | String | 委托深度，填写值0<=X<=0.01（1%） |
| avg_amount | String | 单笔均值，填写2-500的整数（永续2-500的整数） |
| price_limit | String | 价格限制 ，填写值0<X<=1000000 |
| deal_value | String | 已成交量 |
时间加权
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| sweep_range | String | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| price_limit | String | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 委托间隔，填写值5<=X<=120 |
| deal_value | String | 已委托量 |
[
{
"algo_ids": "3003719",
"algo_price": "2",
"instrument_id": "EOS-USD-191227",
"leverage": "10",
"order_type": "1",
"real_amount": "0",
"size": "1",
"status": "1",
"timestamp": "2019-10-11T07:43:41.000Z",
"trigger_price": "2",
"type": "1"
},
{
"algo_ids": "3003718",
"algo_price": "2",
"instrument_id": "EOS-USD-191227",
"leverage": "10",
"order_type": "1",
"real_amount": "0",
"size": "1",
"status": "1",
"timestamp": "2019-10-11T07:43:39.000Z",
"trigger_price": "2",
"type": "1"
}
]
获取您当前账户交易等级对应的手续费费率，母账户下的子账户的费率和母账户一致。每天凌晨0点更新一次
GET/api/futures/v3/trade_fee
2019-11-12T07:28:43.497ZGET/api/futures/v3/trade_fee
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| taker | String | 吃单手续费率 |
| maker | String | 挂单手续费率 |
| delivery | String | 交割手续费率 |
| timestamp | String | 数据返回时间 |
备注：maker 的值：负数，代表是反佣的费率，正数，代表平台扣除的费率。（和web页面上展示的一致）
{
"delivery": "0.0003",
"maker": "0.0002",
"taker": "0.0005",
"timestamp": "2019-12-11T11:02:31.360Z"
}
增加/减少某逐仓仓位的保证金
POST/api/futures/v3/position/margin
POST/api/futures/v3/positon/margin{"instrument_id":"BTC- USDT-200626","direction":"long,"amount":"1","type":"1"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USDT-200626 |
| direction | String | 是 | 开仓方向，long(做多)或者short(做空) |
| type | String | 是 | 增加/减少：1：增加 2：减少 |
| amount | String | 是 | 增加或减少的保证金数量 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USDT-180213 |
| direction | String | 开仓方向，long(做多)或者short(做空) |
| amount | String | 已增加/减少的保证金数量 |
| type | String | 增加/减少：1：增加 2：减少 |
| liquidation_price | String | 增加/减少后的最新强平价格 |
| result | String | 返回设定结果，成功或错误码 |
{
"instrument_id":"BTC-USDT-200626",
"direction": "long",
"amount":"1",
"type":"0x62477bac6509a04512819bb1455e923a60dea5966c7caeaa0b24eb8fb0432b85",
"liquidation_price":"ETH",
"result":"true"
}
获取可用合约的列表，查询各合约的交易限制和价格步长等信息。
GET/api/futures/v3/instruments
GET/api/futures/v3/instruments
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| underlying | String | 标的指数，如：BTC-USD |
| base_currency | String | 交易货币，如：BTC-USD中的BTC ,BTC-USDT中的BTC |
| quote_currency | String | 计价货币币种，如：BTC-USD中的USD ,BTC-USDT中的USDT |
| settlement_currency | String | 盈亏结算和保证金币种，如BTC |
| contract_val | String | 合约面值(美元) |
| listing | String | 上线日期 |
| delivery | String | 交割日期 |
| tick_size | String | 下单价格精度 |
| trade_increment | String | 下单数量精度 |
| alias | String | 本周 this_week |
次周 next_week |
||
季度 quarter |
||
次季度 bi_quarter |
||
| is_inverse | String | true or false ,是否 币本位保证金合约 |
| contract_val_currency | String | 合约面值计价币种 如 usd，btc，ltc，etc xrp eos |
tick_size(价格精度)是指下单价格的最小增量，委托价格必须是tick_size的倍数。例如，当tick_size为0.01，委托价格传入0.022将被系统按截尾法修正为0.02。
{
"instrument_id": "TRX-USD-191108",
"underlying_index": "TRX",
"quote_currency": "USD",
"tick_size": "0.00001",
"contract_val": "10",
"listing": "2019-10-25",
"delivery": "2019-11-08",
"trade_increment": "1",
"alias": "next_week",
"underlying": "TRX-USD",
"base_currency": "TRX",
"settlement_currency": "TRX",
"is_inverse": "true",
"contract_val_currency": "USD"
},
{
"instrument_id": "TRX-USD-191227",
"underlying_index": "TRX",
"quote_currency": "USD",
"tick_size": "0.00001",
"contract_val": "10",
"listing": "2019-09-13",
"delivery": "2019-12-27",
"trade_increment": "1",
"alias": "quarter",
"underlying": "TRX-USD",
"base_currency": "TRX",
"settlement_currency": "TRX",
"is_inverse": "true",
"contract_val_currency": "USD"
}
…………
]
获取合约的深度列表。这个请求不支持分页，一个请求返回整个深度列表。
GET/api/futures/v3/instruments/<instrument_id>/book
GET/api/futures/v3/instruments/BTC-USD-180309/book?size=50
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| size | String | 否 | 返回深度数量，最大值可传200，即买卖深度共400条 |
| depth | String | 否 | 按价格合并深度，例如：0.1，0.001 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 系统时间戳 |
返回值数组说明
["411.8", "10", "1", "4"]
411.8为深度价格，10为此价格的合约张数，1为此价格的强平单个数，4为此价格的订单个数，timestamp为深度生成时间戳。
当size不传时，返回1条；size传0时，返回0条；size最大200，传大于200的数时，返回200条。
按价格合并深度是指每个价格区间将仅返回一个数量，就像在该价格区间上只有一个订单。
{
"bids":[
[
"3.596",
"5125",
"0",
"15"
],
[
"3.595",
"553",
"0",
"14"
]
],
"asks":[
[
"3.597",
"3181",
"0",
"18"
],
[
"3.598",
"13912",
"0",
"31"
]
],
"timestamp":"2019-03-22T01:59:34.707Z"
}
获取平台全部合约的最新成交价、买一价、卖一价和24小时交易量的快照信息。
GET/api/futures/v3/instruments/ticker
GET/api/futures/v3/instruments/ticker
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-190927 |
| last | String | 最新成交价 |
| best_ask | String | 卖一价 |
| best_bid | String | 买一价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| timestamp | String | 系统时间戳 |
| last_qty | String | 最新成交的数量 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid_size | String | 买一价对应的数量 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
[
{
"instrument_id": "btc-usd-200327",
"last": "7611.21",
"best_bid": "7612.2",
"best_ask": "7612.21",
"high_24h": "8018.38",
"low_24h": "7611",
"volume_24h": "12822186",
"timestamp": "2020-03-12T04:30:10.494Z",
"last_qty": "20",
"best_ask_size": "917",
"best_bid_size": "833"
}
]
获取合约的最新成交价、买一价、卖一价和24小时交易量的快照信息。
GET/api/futures/v3/instruments/<instrument_id>/ticker
GET/api/futures/v3/instruments/BTC-USD-180309/ticker
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| last | String | 最新成交价 |
| best_ask | String | 卖一价 |
| best_bid | String | 买一价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| timestamp | String | 系统时间戳 |
| last_qty | String | 最新成交的数量 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid_size | String | 买一价对应的数量 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
{
"instrument_id": "btc-usd-200327",
"last": "7611.21",
"best_bid": "7612.2",
"best_ask": "7612.21",
"high_24h": "8018.38",
"low_24h": "7611",
"volume_24h": "12822186",
"timestamp": "2020-03-12T04:30:10.494Z",
"last_qty": "20",
"best_ask_size": "917",
"best_bid_size": "833"
}
获取合约最新的300条成交列表。
GET/api/futures/v3/instruments/<instrument_id>/trades
GET/api/futures/v3/instruments/BTC- USD-180309/trades?after=2517062044057601&limit=2
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的trade_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的trade_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| timestamp | String | 成交时间 |
| trade_id | String | 成交ID |
| price | String | 成交价格 |
| qty | String | 成交数量 |
| side | String | 成交方向 |
成交方向side是指Taker订单的下单方向，Taker表示主动与深度列表中挂单进行成交。buy表示价格上涨，因为Taker是买单吃掉深度，所以价格将上行。相反，sell表示价格下跌。
trade_id是记录成交信息的递增ID，可能不完整。
[
[
{
"trade_id":"2522253054345222",
"side":"sell",
"price":"3.625",
"qty":"24",
"timestamp":"2019-03-22T02:42:07.323Z"
},
{
"trade_id":"2522252973080580",
"side":"buy",
"price":"3.626",
"qty":"6",
"timestamp":"2019-03-22T02:42:06.081Z"
},
{
"trade_id":"2522252969410561",
"side":"buy",
"price":"3.626",
"qty":"6",
"timestamp":"2019-03-22T02:42:06.026Z"
}
],
{
}
]
获取合约的K线数据。K线数据按请求的粒度分组返回，k线数据最多可获取最近1440条。
GET/api/futures/v3/instruments/<instrument_id>/candles
GET/api/futures/v3/instruments/EOS- USD-190628/candles?start=2019-03-18T02:31:00Z&end=2019-03-20T02:55:00Z&granularity=60
（查询EOS-USD-180309的2019年3月18日02点31分到2019年3月20日02点55分的1分钟K线数据）
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| start | String | 否 | 开始时间（ISO 8601标准，例如：2018-06-20T02:31:00Z） |
| end | String | 否 | 结束时间（ISO 8601标准，例如：2018-06-20T02:31:00Z） |
| granularity | String | 否 | |
时间粒度，以秒为单位，默认值60。如[60/180/300/900/1800/3600/7200/14400/21600/43200/86400/604800]，详见下解释说明 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| timestamp | String | 开始时间 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量（张） |
| currency_volume | String | 按币种折算的交易量 |
k线衔接规则：
1）次周合约交割时：老次周合约对接新当周合约，老当周合约对接新次周合约，季度合约不变；
2）季度合约交割时：老当周合约对接新季度合约，老季度合于对接新次周合约，老次周合约对接新当周合约；
如果用户没有提供开始时间或结束时间中的任一字段，则两个字段都将被忽略。未提供开始时间和结束时间的请求，则系统按时间粒度返回最近的300条数据。
时间粒度granularity必须是[60 180 300 900 1800 3600 7200 14400 21600 43200 86400 604800]中的任一值，否则请求将被拒绝。这些值分别对应的是[1min 3min 5min 15min 30min 1hour 2hour 4hour 6hour 12hour 1day 1week]的时间段。
K线数据可能不完整。
单次请求的最大数据量是300。如果您选择的开始/结束时间和时间粒度导致超过单次请求的最大数据量，您的请求将只会返回300个数据。如果您希望在更大的时间范围内获取足够精细的数据，则需要使用多个开始/结束范围进行多次请求。
返回值分别为[timestamp,open,high,low,close,volume,currency_volume]
[
[
"2019-03-20T16:00:00.000Z",
"3.721",
"3.743",
"3.677",
"3.708",
"8422410",
"22698348.04828491"
],
[
"2019-03-19T16:00:00.000Z",
"3.731",
"3.799",
"3.494",
"3.72",
"24912403",
"67632347.24399722"
],
[
"2019-03-18T16:00:00.000Z",
"3.729",
"3.78",
"3.698",
"3.731",
"17545741",
"46945274.21772249"
]
]
获取币种指数。此接口为公共接口，不需要身份验证。
GET/api/futures/v3/instruments/<instrument_id>/index
GET/api/futures/v3/instruments/EOS-USD-190628/index
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 指数币对，如BTC-USD-190628,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 指数币对，如BTC-USD-190628,BTC-USDT-191227 |
| index | String | 指数价格 |
| timestamp | String | 系统时间戳 |
指数币对"-"后面的币种表示指数价格的计价单位。
{
"instrument_id":"EOS-USD-190628",
"index":"3.59125725275",
"timestamp":"2019-03-22T05:18:05.756Z"
}
获取法币汇率。此接口为公共接口，不需要身份验证。
GET/api/futures/v3/rate
GET/api/futures/v3/rate
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如USD_CNY |
| rate | String | 汇率 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"USD_CNY",
"rate":"6.701",
"timestamp":"2019-03-22T05:08:44.323Z"
}
获取合约预估交割价。交割预估价只有交割前一小时才有返回值。此接口为公共接口，不需要身份验证。
GET/api/futures/v3/instruments/<instrument_id>/estimated_price
GET/api/futures/v3/instruments/BTC-USD-180309/estimated_price
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| settlement_price | String | 预估交割价 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"EOS-USD-181026",
"settlement_price":"0",
"timestamp":"2018-10-23T10:07:44.095Z"
}
获取合约整个平台的总持仓量。此接口为公共接口，不需要身份验证。
GET /api/futures/v3/instruments/<instrument_id>/open_interest
GET/api/futures/v3/instruments/BTC-USD-180309/open_interest
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 描述 | |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| amount | String | 总持仓量 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"EOS-USD-190628",
"amount":"5311831",
"timestamp":"2019-03-22T05:56:06.726Z"
}
获取合约当前交易的最高买价和最低卖价。此接口为公共接口，不需要身份验证。
GET/api/futures/v3/instruments/<instrument_id>/price_limit
GET/api/futures/v3/instruments/BTC-USD-180309/price_limit
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| highest | String | 最高买价 |
| lowest | String | 最低卖价 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"EOS-USD-190628",
"highest":"3.707",
"lowest":"3.491",
"timestamp":"2019-03-22T06:05:08.502Z"
}
获取合约标记价格。此接口为公共接口，不需要身份验证。
GET/api/futures/v3/instruments/<instrument_id>/mark_price
GET/api/futures/v3/instruments/BTC-USD-180309/mark_price
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213 |
| mark_price | String | 指定合约品种的标记价格 |
| timestamp | String | 返回请求时间 |
为了防止个别用户恶意操控市场导致合约价格波动剧烈，我们根据现货指数和合理基差设定标记价格。
{
"mark_price":"3.591",
"instrument_id":"EOS-USD-190628",
"timestamp":"2019-03-22T06:28:53.208Z"
}
获取合约强平单，此接口为公共接口，不需要身份验证。
GET/api/futures/v3/instruments/<instrument_id>/liquidation
GET/api/futures/v3/instruments/BTC-USD-180309/liquidation?status=0&limit=50
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| status | String | 是 | 状态 |
0：最近7天未成交 |
|||
1：最近7天已成交 |
|||
| limit | String | 否 | 分页返回的结果集数量，默认为100，最大为100，按时间倒序排列，越晚的在前面 |
| from | String | 否 | 请求此id之前（更旧的数据）的分页内容，例如 2 |
| to | String | 否 | 请求此id之后（更新的数据）的分页内容 例如 3 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213,BTC-USDT-191227 |
| size | String | 数量 |
| created_at | Date | 强平单的委托时间 |
| loss | String | 穿仓用户亏损 |
| price | String | 订单价格 |
| type | String | 订单类型 |
3:平多 |
||
4:平空 |
[
{
"loss":"0.0",
"size":"945",
"price":"5.623",
"created_at":"2018-10-21T01:20:18.0Z",
"instrument_id":"EOS-USD-181026",
"type":"1"
},
{
"loss":"0",
"size":"37",
"price":"5.623",
"created_at":"2018-10-21T01:20:18.0Z",
"instrument_id":"EOS-USD-181026",
"type":"1"
}
]
获取历史结算/交割记录
GET/api/futures/v3/settlement/history
GET/api/futures/v3/settlement/history
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-180213 |
| start | String | 否 | 开始时间（ISO 8601标准，例如：2020-03-08T08:00:00Z） |
| limit | String | 否 | 每一页100条 |
| end | String | 否 | 结束时间（ISO 8601标准，例如：2020-03-10T08:00:00Z） |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-180213 |
| type | String | 交割：delivery 结算：settlement |
| settlement_price | String | 交割/结算价格 |
| clawback_loss | String | 穿仓用户亏损分摊 |
| reserve | String | 准备金分摊 |
| clawback_rate | String | 分摊比例 如 0 ，0.01（1%） |
| timestamp | String | 交割/结算日期 |
[
{
"instrument_id": "btc-usd-180213",
"type": "settlement",
"settlement_price": "7923.88",
"clawback_loss": "0.0",
"reserve": "0.0252",
"clawback_rate": "0.0",
"timestamp": "2020-03-09T08:00:21.000Z"
},
{
"instrument_id": "btc-usd-180213",
"type": "settlement",
"settlement_price": "8804.51",
"clawback_loss": "0.0",
"reserve": "0.0",
"clawback_rate": "0.0",
"timestamp": "2020-03-08T08:00:20.000Z"
}
]
永续合约交易的行情信息，账户信息，订单操作，订单查询，账单明细查询。
获取账户所有合约的持仓信息。请求此接口，会在数据库遍历所有币对下的持仓数据，有大量的性能消耗,请求频率较低。建议用户传合约ID获取持仓信息。
GET/api/swap/v3/position
GET/api/swap/v3/position
全仓
| 全 仓参数名 | 参 数类型 | 描 述 |
|---|---|---|
| margin_mode | String | 仓位模式：全仓crossed |
| liquidation_price | String | 预估强平价 |
| position | String | 持仓数量 |
| avail_position | String | 可平数量 |
| margin | String | 保证金 |
| avg_cost | String | 开仓平均价 |
| settlement_price | String | 结算基准价 |
| instrument_id | String | 合约名称 |
| leverage | String | 杠杆 |
| realized_pnl | String | 已实现盈亏 |
| side | String | 方向 |
| timestamp | String | 创建时间 |
| maint_margin_ratio | String | 维持保证金率 |
| settled_pnl | String | 已结算收益 |
| last | String | 最新成交价 |
| unrealized_pnl | String | 未实现盈亏 |
逐仓
| 逐 仓参数名 | 参 数类型 | 描 述 |
|---|---|---|
| margin_mode | String | 仓位模式：逐仓fixed |
| liquidation_price | String | 预估强平价 |
| position | String | 持仓数量 |
| avail_position | String | 可平数量 |
| margin | String | 保证金 |
| avg_cost | String | 开仓平均价 |
| settlement_price | String | 结算基准价 |
| instrument_id | String | 合约名称 |
| leverage | String | 杠杆 |
| realized_pnl | String | 已实现盈亏 |
| side | String | 方向 |
| timestamp | String | 创建时间 |
| maint_margin_ratio | String | 维持保证金率 |
| settled_pnl | String | 已结算收益 |
| last | String | 最新成交价 |
| unrealized_pnl | String | 未实现盈亏 |
[
{
"margin_mode": "fixed",
"timestamp": "2019-09-27T03:47:37.230Z",
"holding": [
{
"avail_position": "20",
"avg_cost": "8025.0",
"instrument_id": "BTC-USD-SWAP",
"last": "8099.8",
"leverage": "15.00",
"liquidation_price": "7002.6",
"maint_margin_ratio": "0.0050",
"margin": "0.0454",
"position": "20",
"realized_pnl": "-0.0001",
"settled_pnl": "0.0076",
"settlement_price": "8279.2",
"side": "long",
"timestamp": "2019-09-27T03:47:37.230Z",
"unrealized_pnl": "0"
}
]
},
{
"margin_mode": "crossed",
"timestamp": "2019-09-27T03:49:02.018Z",
"holding": [
{
"avail_position": "3",
"avg_cost": "59.49",
"instrument_id": "LTC-USD-SWAP",
"last": "55.79",
"leverage": "10.00",
"liquidation_price": "4.37",
"maint_margin_ratio": "0.0100",
"margin": "0.0537",
"position": "3",
"realized_pnl": "0.0000",
"settled_pnl": "-0.0330",
"settlement_price": "55.84",
"side": "long",
"timestamp": "2019-09-27T03:49:02.018Z",
"unrealized_pnl": "0"
},
]
}
]
获取某个合约的持仓信息
GET/api/swap/v3/<instrument_id>/position
GET/api/swap/v3/BTC-USD-SWAP/position
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
全仓
| 全 仓参数名 | 参 数类型 | 描 述 |
|---|---|---|
| margin_mode | String | 仓位模式：全仓crossed |
| liquidation_price | String | 预估强平价 |
| position | String | 持仓数量 |
| avail_position | String | 可平数量 |
| margin | String | 保证金 |
| avg_cost | String | 开仓平均价 |
| settlement_price | String | 结算基准价 |
| instrument_id | String | 合约名称 |
| leverage | String | 杠杆 |
| realized_pnl | String | 已实现盈亏 |
| side | String | 方向 |
| timestamp | String | 最近一次加减仓的更新时间 |
| maint_margin_ratio | String | 维持保证金率 |
| settled_pnl | String | 已结算收益 |
| last | String | 最新成交价 |
| unrealized_pnl | String | 未实现盈亏 |
逐仓
| 逐 仓参数名 | 参 数类型 | 描 述 |
|---|---|---|
| margin_mode | String | 仓位模式：逐仓fixed |
| liquidation_price | String | 预估强平价 |
| position | String | 持仓数量 |
| avail_position | String | 可平数量 |
| margin | String | 保证金 |
| avg_cost | String | 开仓平均价 |
| settlement_price | String | 结算基准价 |
| instrument_id | String | 合约名称 |
| leverage | String | 杠杆 |
| realized_pnl | String | 已实现盈亏 |
| side | String | 方向 |
| timestamp | String | 最近一次加减仓的更新时间 |
| maint_margin_ratio | String | 维持保证金率 |
| settled_pnl | String | 已结算收益 |
| last | String | 最新成交价 |
| unrealized_pnl | String | 未实现盈亏 |
{
"margin_mode": "fixed",
"timestamp": "2019-09-27T03:47:37.230Z",
"holding": [
{
"avail_position": "20",
"avg_cost": "8025.0",
"instrument_id": "BTC-USD-SWAP",
"last": "8113.1",
"leverage": "15.00",
"liquidation_price": "7002.6",
"maint_margin_ratio": "0.0050",
"margin": "0.0454",
"position": "20",
"realized_pnl": "-0.0001",
"settled_pnl": "0.0076",
"settlement_price": "8279.2",
"side": "long",
"timestamp": "2019-09-27T03:47:37.230Z",
"unrealized_pnl": "0"
}
]
}
{
"margin_mode": "crossed",
"timestamp": "2019-09-27T03:49:02.018Z",
"holding": [
{
"avail_position": "3",
"avg_cost": "59.49",
"instrument_id": "LTC-USD-SWAP",
"last": "55.98",
"leverage": "10.00",
"liquidation_price": "4.37",
"maint_margin_ratio": "0.0100",
"margin": "0.0536",
"position": "3",
"realized_pnl": "0.0000",
"settled_pnl": "-0.0330",
"settlement_price": "55.84",
"side": "long",
"timestamp": "2019-09-27T03:49:02.018Z",
"unrealized_pnl": "0"
},
]
}
获取所有币种合约的账户信息，当用户没有持仓时，保证金率为10000
GET/api/swap/v3/accounts
GET/api/swap/v3/accounts
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| currency | String | 账户余额币种 |
| underlying | string | 标的指数，如：BTC-USD，BTC-USDT |
| equity | String | 账户权益 |
| total_avail_balance | String | 账户余额 |
| fixed_balance | String | 逐仓账户余额 |
| margin | String | 已用保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| margin_ratio | String | 保证金率 |
| instrument_id | String | 合约名称 |
| margin_frozen | String | 开仓冻结保证金 |
| timestamp | String | 创建时间 |
| margin_mode | String | 仓位模式 |
全仓：crossed |
||
逐仓：fixed |
||
| maint_margin_ratio | String | 维持保证金率 |
| max_withdraw | String | 可划转数量 |
所有持仓/所有账户信息，没有持仓/持币时返回空数组；单个持仓/单个账户信息没有持仓/持币时返回各字段均为默认值；
逐仓：
账户权益：账户权益=账户余额+逐仓仓位账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
全仓：
账户权益=账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
{
"info": [
{
"equity": "0.0446",
"fixed_balance": "0.0461",
"instrument_id": "BTC-USD-SWAP",
"maint_margin_ratio": "0.0000",
"margin": "0.0454",
"margin_frozen": "0.0000",
"margin_mode": "fixed",
"margin_ratio": "0.0000",
"realized_pnl": "-0.0001",
"timestamp": "2019-09-27T03:47:37.230Z",
"total_avail_balance": "0.0033",
"unrealized_pnl": "-0.0049"
"max_withdraw": "0.0033"
},
{
"equity": "0.1371",
"fixed_balance": "0.0000",
"instrument_id": "LTC-USD-SWAP",
"maint_margin_ratio": "0.0100",
"margin": "0.1071",
"margin_frozen": "0.0000",
"margin_mode": "crossed",
"margin_ratio": "0.1280",
"realized_pnl": "0.0000",
"timestamp": "2019-09-27T03:49:02.018Z",
"total_avail_balance": "0.1371",
"unrealized_pnl": "0.0000"
"max_withdraw": "0.0033"
},
{
"equity": "0.1124",
"fixed_balance": "0.0000",
"instrument_id": "EOS-USD-SWAP",
"maint_margin_ratio": "0.0100",
"margin": "0.1367",
"margin_frozen": "0.0000",
"margin_mode": "crossed",
"margin_ratio": "0.0164",
"realized_pnl": "0.0000",
"timestamp": "2019-08-27T02:05:29.651Z",
"total_avail_balance": "0.1124",
"unrealized_pnl": "0.0000"
"max_withdraw": "0.0033"
}
]
}
获取单个币种合约的账户信息，当用户没有持仓时，保证金率为10000
GET/api/swap/v3/<instrument_id>/accounts
GET/api/swap/v3/BTC-USD-SWAP/accounts
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 账户余额币种 |
| underlying | string | 标的指数，如：BTC-USD，BTC-USDT |
| equity | String | 账户权益 |
| fixed_balance | String | 逐仓账户余额 |
| total_avail_balance | String | 账户余额 |
| margin | String | 已用保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| margin_ratio | String | 保证金率 |
| instrument_id | String | 合约名称 |
| margin_frozen | String | 开仓冻结保证金 |
| timestamp | String | 创建时间 |
| margin_mode | String | 仓位模式 |
全仓：crossed |
||
逐仓：fixed |
||
| maint_margin_ratio | String | 维持保证金率 |
| max_withdraw | String | 可划转数量 |
所有持仓/所有账户信息，没有持仓/持币时返回空JSON；单个持仓/单个账户信息没有持仓/持币时返回各字段均为默认值
逐仓：
账户权益：账户权益=账户余额+逐仓仓位账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
全仓：
账户权益=账户余额+所有合约的已实现盈亏+所有合约的未实现盈亏
{
"info": {
"equity": "0.0444",
"fixed_balance": "0.0461",
"instrument_id": "BTC-USD-SWAP",
"maint_margin_ratio": "0.0000",
"margin": "0.0454",
"margin_frozen": "0.0000",
"margin_mode": "fixed",
"margin_ratio": "0.0000",
"realized_pnl": "-0.0001",
"timestamp": "2019-09-27T03:47:37.230Z",
"total_avail_balance": "0.0033",
"unrealized_pnl": "-0.0051"
"max_withdraw": "0.0033"
}
}
获取某个合约的杠杆倍数，持仓模式
GET/api/swap/v3/accounts/<instrument_id>/settings
GET/api/swap/v3/accounts/BTC-USD-SWAP/settings
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| long_leverage | String | 多仓杠杆 |
| margin_mode | String | 持仓模式 |
| short_leverage | String | 空仓杠杆 |
| instrument_id | String | 合约名称 |
全仓同一个合约只允许有一种杠杆倍数，逐仓同一个合约同一个方向只能用一种杠杆倍数。
{
"long_leverage":"5.0000",
"short_leverage":"5.0000",
"margin_mode":"crossed",
"instrument_id":"BTC-USD-SWAP"
}
设定某个合约的杠杆倍数
POST /api/swap/v3/accounts/<instrument_id>/leverage
POST /api/swap/v3/accounts/BTC-USD-SWAP/leverage{"leverage": "10","side": "1"}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| leverage | String | 是 | 杠杆倍数，填写1-100的数值 |
| side | String | 是 | 方向 |
1:逐仓-多仓 |
|||
2:逐仓-空仓 |
|||
3:全仓 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| long_leverage | String | 多仓杠杆 |
| margin_mode | String | 持仓模式 |
| short_leverage | String | 空仓杠杆 |
| instrument_id | String | 合约名称 |
{
"long_leverage":"10.0000",
"short_leverage":"10.0000",
"margin_mode":"crossed",
"instrument_id":"BTC-USD-SWAP"
}
列出账户资产流水，账户资产流水是指导致账户余额增加或减少的行为。流水会分页，每页100条数据，并且按照时间倒序排序和存储，最新的排在最前面。 本接口能查询最近7天的数据。
GET/api/swap/v3/accounts/<instrument_id>/ledger
GET/api/swap/v3/accounts/BTC-USD-SWAP/ledger?after=2&limit=30
注：after=2&limit=30代表在第2页请求30条数据，返回结果为第2页的30条最近的数据
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的ledger_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的ledger_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| type | String | 否 | 1. 开多 |
2. 开空 |
|||
3. 平多 |
|||
4. 平空 |
|||
5.转入 |
|||
6.转出 |
|||
7.清算未实现 |
|||
8.分摊 |
|||
9.剩余拨付 |
|||
10.强平多 |
|||
11.强平空 |
|||
14.资金费 |
|||
15.手动追加 |
|||
16.手动减少 |
|||
17.自动追加 |
|||
18.修改持仓模式 |
|||
19.强减多 |
|||
20.强减空 |
|||
21.用户调低杠杆追加保证金 |
|||
22.清算已实现 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单id |
| amount | String | 变动金额 |
| type | String | 账单类型 |
| fee | String | 手续费 |
| timestamp | String | 账单创建时间 |
| instrument_id | String | 合约ID |
| currency | String | 币种，如：btc |
| details | String | |
如果type是trade或者fee，则会有该details字段将包含order，instrument信息,如果type是transfer，则会有该details字段将包含from，to信息 |
||
| order_id | String | 订单的ID |
| from | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| to | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| balance | String | 开仓平仓的张数（开仓为正数，平仓为负数，当type是fee时，balance为0） |
| 流 水来源类型 | 参 数类型 | 描 述 |
| --- | --- | --- |
| transfer | String | 转入/转出 |
| match | String | 交易产生的资金变动 |
| settlement | String | 清算/分摊 |
| liquidation | String | 强平/减仓 |
| funding | String | 资金费 |
| margin | String | 修改保证金的资金变动 |
[
{
"amount": "0.000011",
"balance": "0",
"fee": "0.000000",
"currency": "BTC",
"details": {
"instrument_id": "BTC-USD-SWAP",
"order_id": ""
},
"type": "funding",
"instrument_id": "BTC-USD-SWAP",
"ledger_id": "336890402630811792",
"timestamp": "2019-10-03T16:00:00.000Z"
},
{
"amount": "0.001812",
"balance": "0",
"fee": "0.000000",
"currency": "BTC",
"details": {
"instrument_id": "BTC-USD-SWAP",
"order_id": ""
},
"type": "settlement",
"instrument_id": "BTC-USD-SWAP",
"ledger_id": "336648803103555621",
"timestamp": "2019-10-03T08:00:00.000Z"
},
]
API交易提供限价单下单模式，只有当您的账户有足够的资金才能下单。一旦下单，您的账户资金将在订单生命周期内被冻结，被冻结的资金以及数量取决于订单指定的类型和参数。目前api下单只支持以美元为计价单位
POST /api/swap/v3/order
POST /api/swap/v3/order{"client_oid":"e12233456","size":"2","order_type":"1","type":"1","match_price":"0","price":"432.11","instrument_id":"BTC- USD-SWAP"}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| size | String | 是 | 下单数量 |
| type | String | 是 | 可填参数： |
1:开多 |
|||
2:开空 |
|||
3:平多 |
|||
4:平空 |
|||
| order_type | String | 否 | 参数填数字 |
0：普通委托（order_type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
|||
4：市价委托 |
|||
| match_price | String | 否 | 是否以对手价下单。 |
0:不是; 1:是。当以对手价下单，order_type只能选择0（普通委托） |
|||
| price | String | 否 | 委托价格 |
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
请求参数校验:合约名称必须是已存在合约名称；委托价格必须符合下单成交价格(不能达到溢价和强平价)；下单类型除了1:开多; 2:开空; 3:平多;
4:平空都会报错；数量不能小于等于零，不能大于可开张数。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单id，下单失败时，此字段值为-1 |
| client_oid | String | 由您设置的订单id来标识您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
instrument_id
instrument_id必须是有效的合约ID。合约列表可通过/ instruments接口获取。
client_oid
client_oid用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
type
下单时，您可以指定订单类型。在您没有持仓时，只能选择开多和开空。您只能对持仓合约进行平仓。
price
price表示买入或卖出每张合约的价格。价格必须是价格步长tick_size的倍数。价格步长tick_size是价格的最小增量，可通过/instruments接口获取。
size
size表示买入或卖出合约的张数。数量必须是整数。
match_price
对手价表示你希望以目前对手方的最优价格成交。如果你下的是买单，选择以对手价下单表示你用当前卖一价进行下单。如果你下的是卖单，选择以对手价下单表示你用当前买一价进行下单。
订单生命周期
HTTP请求将在订单被拒绝（资金不足，参数无效等）或下单成功（由匹配引擎接受）时作出响应。一个200响应表示该订单被接收并且进入撮合。进入撮合的订单可以部分或全部立即成交（取决于价格和市场条件）。部分成交的时候将把订单的剩余数量继续进行撮合。完全成交的订单将进入已成交状态。
监听行情数据的用户建议使用client_oid字段以便在接受到的信息中标识对应的数据。
响应
成功接受的订单将被分配一个订单ID。成功接受的订单表示撮合引擎已经接受的订单。
未成交的订单不会过期，并将保持撮合状态，直到被成交或取消。
{
"error_message":"",
"result":"true",
"error_code":"0",
"client_oid":"oktswap6",
"order_id":"6a-d-54dcc6543-0"
}
批量进行下单请求，每个合约可批量下10个单。 [永续合约委托说明](https://www.okex.me/support/hc/zh- cn/articles/360037140632)
POST /api/swap/v3/orders
POST /api/swap/v3/orders{"instrument_id": "EOS-USD- SWAP","order_data":[{"client_oid": "oktswap14", "type": "1", "price": "3.2571000000000003", "size": "1", "match_price": "0"}, {"client_oid": "oktswap15", "type": "1", "price": "3.2571000000000003", "size": "1", "match_price": "0"}]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| order_data | List | 是 | JSON类型的字符串 |
| 例：`[{"order_type":"0","client_oid": "E213","price": "5","size": "2","type": | |||
| "1","match_price": "0"},{"order_type":"0","client_oid": "243","price": | |||
| "2","size": "3","type": "2","match_price": "1"}]` | |||
最大下单量为20，当以对手价下单，order_type只能选择0（普通委托） |
|||
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| size | String | 是 | 下单数量 |
| price | String | 是 | 委托价格 |
| type | String | 是 | 可填参数： |
1:开多 |
|||
2:开空 |
|||
3:平多 |
|||
4:平空 |
|||
| match_price | String | 否 | 是否以对手价下单 |
0:不是; 1:是。当以对手价下单，order_type只能选择0（普通委托） |
|||
| order_type | String | 否 | 参数填数字 |
0：普通委托（order_type不填或填0都是普通委托） |
|||
1：只做Maker（Post only） |
|||
2：全部成交或立即取消（FOK） |
|||
3：立即成交并取消剩余（IOC） |
|||
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
请求参数的校验和单个订单一致。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单id，下单失败时，此字段值为-1 |
| client_oid | String | 由您设置的订单id来标识您的订单 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
client_oid用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
result是代表服务器处理了请求，不代表下单、撤单是否成功。
返回的结果数据和order_data提交订单数据顺序一致。如果下单失败，则order_id为-1，error_code是错误码提示，error_message是错误信息。
{
"order_info":[
{
"client_oid":"oktswap14",
"error_code":"0",
"error_message":"",
"order_id":"6a-d-54df9a2ac-0"
"result": "true"
},
{
"client_oid":"oktswap15",
"error_code":"0",
"error_message":"",
"order_id":"6a-d-54df9a2ad-0"
"result": "true"
}
],
"result":"true"
}
撤销之前下的未完成订单。
POST /api/swap/v3/cancel_order/<instrument_id>/<order_id> or <client_oid>
POST /api/swap/v3/cancel_order/BTC-USD-SWAP/64-2b-17122f911-3
或
POST /api/swap/v3/cancel_order/BTC-USD-SWAP/64er
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| order_id | String | 非必填 | order_id和client_oid必须且只能选一个填写，订单id |
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| client_oid | String | 非必填 | order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
请求参数校验：合约名称必须是已存在合约的名称；order_id必须是已存在的order_id。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单id |
| result | String | 撤单申请结果 |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
使用client_oid撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
order_id和client_oid必须且只能选一个填写
这order_id是服务器分配的订单ID，而不是用户传的的client_oid。
返回值是已发起撤销操作的订单ID，不代表这些订单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
result是代表服务器处理了请求，不代表下单、撤单是否成功。
如果订单无法取消（已经成交或已取消），那么返回的报错内容里将显示相应的原因。
{
"result":"true",
"client_oid":"oktswap6",
"order_id":"6a-d-54dcc6543-0",
"error_message": "",
"error_code": "0"
}
撤销之前下的未完成订单，每个币对可批量撤10个单。
POST /api/swap/v3/cancel_batch_orders/<instrument_id>
POST /api/swap/v3/cancel_batch_orders/BTC-USD- SWAP{"ids":["64-2a-17122d911-0","64-2b-17124f911-0","64-2c-17126f911-0"]}
或
POST /api/swap/v3/cancel_batch_orders/BTC-USD- SWAP{"client_oids":["6EEE33","643RE","64REE"]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| ids | List | 非必填 | order_id和client_oid必须且只能选一个填写，订单id列表 |
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| client_oids | List | 非必填 | |
order_id和client_oid必须且只能选一个填写，由您设置的订单ID来识别您的订单，类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符 |
请求参数校验和单个订单撤销一致。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| ids | String | 订单id列表 |
| result | String | 撤单申请结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
返回值是已发起撤销操作的订单ID列表，不代表这些订单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
批量撤单时候，要么都是order_id要么都是client_oid，否则会提示错误
使用client_oid批量撤单时，目前只支持一个币对下撤一个client_oid
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
result是代表服务器处理了请求，不代表下单、撤单是否成功。如果全部都撤单失败，result就为false。
无法保证一定会成功撤销，建议用户调用批量撤单接口后，再调用获取订单列表接口确认。
1. 用order_ids批量撤单：
{
"client_oids":[
],
"ids":[
"6a-d-54df9a2ac-0",
"6a-d-54df9a2ad-0"
],
"instrument_id":"EOS-USD-SWAP",
"result":"true",
"error_message": "",
"error_code": "0"
}
2. 用client_oids撤单:
{
"client_oids":[
"oktswap16",
"oktswap17"
],
"ids":[
],
"instrument_id":"EOS-USD-SWAP",
"result":"true",
"error_message": "",
"error_code": "0"
}
列出您当前所有的订单信息。本接口能查询最近7天20000条数据。这个请求支持分页，并且按委托时间倒序排序和存储，最新的排在最前面。
GET/api/swap/v3/orders/<instrument_id>
GET/api/swap/v3/orders/EOS-USD-SWAP?state=2&after=1&limit=2
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的order_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| state | String | 是 | 订单状态 |
-2:失败 |
|||
-1:撤单成功 |
|||
0:等待成交 |
|||
1:部分成交 |
|||
2:完全成交 |
|||
3:下单中 |
|||
4:撤单中 |
|||
6: 未完成（等待成交+部分成交） |
|||
7:已完成（撤单成功+完全成交） |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| client_oid | String | 用户设置的订单ID |
| size | String | 委托数量 |
| timestamp | String | 创建时间 |
| filled_qty | String | 成交数量 |
| fee | String | 手续费 |
| order_id | String | 订单id |
| price | String | 委托价格 |
| price_avg | String | 成交均价 |
| type | String | 1:开多 |
2:开空 |
||
3:平多 |
||
4:平空 |
||
| contract_val | String | 合约面值 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
4：市价委托 |
||
| state | String | -2:失败 |
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
||
| trigger_price | String | 强平的真实触发价格，仅强平单会返回此字段 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
最新的定义为 先从未成交表查，如果未成交表没有，再查已成交表的最新数据。
{
"order_info":[
{
"client_oid":"",
"contract_val":"10",
"fee":"-0.000551",
"filled_qty":"1",
"instrument_id":"EOS-USD-SWAP",
"order_id":"6a-7-54d663a28-0",
"order_type":"0",
"price":"3.633",
"price_avg":"3.633",
"size":"1",
"state":"2",
"status":"2",
"timestamp":"2019-03-25T05:56:21.674Z",
"trigger_price": "0.0",
"type":"4"
},
{
"client_oid":"",
"contract_val":"10",
"fee":"-0.000550",
"filled_qty":"1",
"instrument_id":"EOS-USD-SWAP",
"order_id":"6a-8-54cee3a3f-0",
"order_type":"0",
"price":"3.640",
"price_avg":"3.640",
"size":"1",
"state":"2",
"status":"2",
"timestamp":"2019-03-25T03:45:17.376Z",
"trigger_price": "0.0",
"type":"2"
}
]
}
通过订单id获取单个订单信息。本接口只能查询最近3个月的已成交和已撤销订单信息。已撤销的未成交单只保留2个小时。
GET/api/swap/v3/orders/<instrument_id>/<order_id>
或
GET/api/swap/v3/orders/<instrument_id>/<client_oid>
GET/api/swap/v3/orders/BTC-USD-SWAP/64-2a-26132f931-3
或
GET/api/swap/v3/orders/BTC-USD-SWAP/64rt
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| order_id | String | 否 | 订单id , order_id和client_oid必须且只能选一个填写 |
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| client_oid | String | 否 | order_id和client_oid必须且只能选一个填写 . 由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写）1-32位字符 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| size | String | 委托数量 |
| timestamp | String | 创建时间 |
| filled_qty | String | 成交数量 |
| fee | String | 手续费 |
| order_id | String | 订单id |
| price | String | 委托价格 |
| price_avg | String | 成交均价 |
| type | String | 1:开多 |
2:开空 |
||
3:平多 |
||
4:平空 |
||
| contract_val | String | 合约面值 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
4：市价委托 |
||
| state | String | -2:失败 |
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
||
| trigger_price | String | 强平的真实触发价格，仅强平单会返回此字段 |
status为state旧版参数，会短期兼容，建议尽早切换state。
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符
，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
最新的定义为 先从未成交表查，如果未成交表没有，再查已成交表的最新数据。
{
"filled_qty":"1",
"fee":"-0.000550",
"client_oid":"",
"price_avg":"3.640",
"trigger_price": "0.0",
"type":"2",
"instrument_id":"EOS-USD-SWAP",
"size":"1",
"price":"3.640",
"contract_val":"10",
"order_id":"6a-8-54cee3a3f-0",
"order_type":"0",
"status":"2",
"state":"2",
"timestamp":"2019-03-25T03:45:17.376Z"
}
获取最近的成交明细列表，本接口能查询最近7天的数据。
GET/api/swap/v3/fills
GET/api/swap/v3/fills?order_id=64-2b-16122f931-3&instrument_id=BTC-USD- SWAP&after=1&limit=50
（返回BTC-USD-SWAP中order_id为64-2b-16122f931-3的订单中第1页前50笔成交信息）
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| order_id | String | 否 | 订单ID，不填写order_id，返回当前instrument_id下的所有订单成交明细 |
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的trade_id等 |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的trade_id等 |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交id |
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| order_id | String | 订单id |
| price | String | 成交价格 |
| order_qty | String | 成交数量 |
| fee | String | 手续费 |
| timestamp | String | 成交时间 |
| exec_type | String | 流动性方向 |
T：taker; M：maker |
||
| side | String | 订单方向 |
手续费
fee字段：负数的fee表示平台收取的手续费，正数的fee表示表示平台向达到指定lv交易等级的用户支付的挂单奖励（返佣）
[
{
"trade_id":"197429674631450625",
"instrument_id":"EOS-USD-SWAP",
"order_id":"6a-7-54d663a28-0",
"price":"3.633",
"order_qty":"1.0000",
"fee":"-0.000551",
"timestamp":"2019-03-25T05:56:31.287Z",
"exec_type":"M",
"side":"short"
}
]
获取合约挂单冻结数量。
GET/api/swap/v3/accounts/<instrument_id>/holds
GET/api/swap/v3/accounts/BTC-USD-SWAP/holds
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| amount | String | 开仓冻结保证金 |
| timestamp | String | 查询时间 |
校验合约名称，只要和数据库中的合约名称不同，就会报错
{
"instrument_id":"BTC-USD-SWAP",
"amount":"303613",
"timestamp":"2019-03-26T02:36:22.703Z"
}
委托策略下单
提供止盈止损、跟踪委托、冰山委托和时间加权委托策略
POST /api/swap/v3/order_algo
POST /api/swap/v3/order_algo{"instrument_id":"BTC-USD- SWAP","type":"1","trigger_price":"432.11","order_type":"1","algo_price":"341.99","size":"2"}（止盈止损）
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-SWAP,BTC-USDT-SWAP |
| type | String | 是 | 1:开多 |
2:开空 |
|||
3:平多 |
|||
4:平空 |
|||
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| size | String | 是 | 委托总数（以张计数），填写值1<=X<=1000000的整数 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| trigger_price | String | 是 | 触发价格，填写值0<X<=1000000 |
| algo_price | String | 是 | 委托价格，填写值0<X<=1000000 |
| algo_type | String | 否 | 1:限价 2:市场价；触发价格类型，默认是限价；为市场价时，委托价格不必填； |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| callback_rate | String | 是 | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 是 | 激活价格 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| algo_variance | String | 是 | 委托深度，填写值0.0001(0.01%)<=X<=0.01（1%） |
| avg_amount | String | 是 | 单笔均值，填写2-1000的整数（永续2-500的整数） |
| price_limit | String | 是 | 价格限制 ，填写值0<X<=1000000 |
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| sweep_range | String | 是 | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 是 | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 是 | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| price_limit | String | 是 | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 是 | 委托间隔，填写值5<=X<=120 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| result | String | 调用接口返回结果 |
| instrument_id | String | 合约ID，如BTC-USD-SWAP |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| algo_id | String | 订单ID，下单失败时，此字段值为-1 |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| algo_type | String | 1:限价 2:市场价； |
{
"error_message": "",
"error_code": "0",
"data": {
"result": "success",
"algo_id": "340286404443709440",
"error_message": "",
"error_code": "0",
"instrument_id": "BTC-USD-SWAP",
"order_type": 1
},
"detailMsg": ""
}
委托策略撤单
根据指定的algo_id撤销某个合约的未完成订单，每次最多可撤6（冰山/时间）/10（计划/跟踪）个。
POST /api/swap/v3/cancel_algos
单个撤单：POST /api/swap/v3/cancel_algos{"instrument_id":"BTC-USD- SWAP","order_type":"1","algo_ids":["198273485"]}
批量撤单：POST /api/swap/v3/cancel_algos{"instrument_id":"BTC-USD- SWAP","order_type":"1","algo_ids":["198273485","198273486"]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 撤销指定的合约品种 |
| algo_ids | List | 是 | 撤销指定的委托单ID |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 撤销指定的合约品种 |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| algo_ids | String | 撤销指定的委托单ID |
| result | String | 调用接口返回结果 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
返回参数
返回值是已发起撤销操作的委托单ID，不代表这些委托单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
解释说明
无法保证一定会成功撤销，建议用户调用撤单接口后，再调用获取委托单列表接口确认。
{
"error_message": "",
"error_code": "0",
"data": {
"result": "success",
"algo_ids": "[340286404443709440]",
"instrument_id": "BTC-USD-SWAP",
"order_type": "1"
},
"detailMsg": ""
}
获取委托单列表
列出您当前所有的订单信息。
GET/api/swap/v3/order_algo/<instrument_id>
GET/api/swap/v3/order_algo/BTC-USD-SWAP?order_type=1&status=3
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-SWAP,BTC-USDT-SWAP |
| order_type | String | 是 | 1：止盈止损 |
2：跟踪委托 |
|||
3：冰山委托 |
|||
4：时间加权 |
|||
| status | String | 见描述 | 【status和algo_id必填且只能填其一】 |
| 订单状态 | |||
1：待生效 |
|||
2：已生效 |
|||
3：已撤销 |
|||
4：部分生效 |
|||
5：暂停生效 |
|||
6：委托失败 |
|||
【只有冰山和加权有4、5状态】 |
|||
| algo_id | String | 见描述 | 【status和algo_id必填且只能填其一】 |
| 查询指定的委托单ID | |||
| before | string | 否 | 请求此id之后（更新的数据）的分页内容 |
| after | string | 否 | 请求此id之前（更旧的数据）的分页内容 |
| limit | string | 否 | 分页返回的结果集数量，默认为100，最大为100 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-SWAP |
| order_type | String | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权 |
||
| timestamp | String | 委托时间 |
| real_price | String | 实际委托价格 |
| algo_id | String | 委托单ID |
| status | String | 订单状态 |
1: 待生效 |
||
2: 已生效 |
||
3: 已撤销 |
||
4: 部分生效 |
||
5: 暂停生效 |
||
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| leverage | String | 杠杆倍数 |
| size | String | 委托数量（以张计数）,填写值1<=X<=1000000的整数 |
| algo_price | String | 策略委托价格 |
| real_amount | String | 实际委托数量 |
| trigger_price | String | 策略委托触发价格 |
| order_id | String | 订单id |
止盈止损
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trigger_price | String | 触发价格，填写值0<X |
| algo_price | String | 委托价格，填写值0<X<=1000000 |
| real_amount | String | 实际成交数量 |
| algo_type | String | 1:限价 2:市场价； |
跟踪委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| callback_rate | String | 回调幅度，填写值0.001（0.1%）<=X<=0.05（5%） |
| trigger_price | String | 激活价格 ，填写值0<X<=1000000 |
| real_amount | String | 实际委托数量 |
冰山委托
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| algo_variance | String | 委托深度，填写值0<=X<=0.01（1%） |
| avg_amount | String | 单笔均值，填写2-500的整数（永续2-500的整数） |
| price_limit | String | 价格限制 ，填写值0<X<=1000000 |
| deal_value | String | 已成交量 |
时间加权
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| sweep_range | String | 扫单范围，填写值0.005（0.5%）<=X<=0.01（1%） |
| sweep_ratio | String | 扫单比例，填写值 0.01<=X<=1 |
| single_limit | String | 单笔上限，填写值10<=X<=2000（永续2-500的整数） |
| price_limit | String | 价格限制，填写值0<X<=1000000 |
| time_interval | String | 委托间隔，填写值5<=X<=120 |
| deal_value | String | 已委托量 |
{
"orderStrategyVOS": [
{
"algo_id": "340286404443709440",
"algo_price": "8300.0",
"instrument_id": "BTC-USD-SWAP",
"leverage": "15.00",
"order_type": "1",
"real_amount": "0.0000",
"real_price": "0.0",
"size": "1.0000",
"status": "3",
"timestamp": "2019-10-08T08:27:20.517Z",
"trigger_price": "8200.0",
"type": "1"
},
{
"algo_id": "337464291111936000",
"algo_price": "9000.0",
"instrument_id": "BTC-USD-SWAP",
"leverage": "15.00",
"order_type": "1",
"real_amount": "0.0000",
"real_price": "0.0",
"size": "1.0000",
"status": "3",
"timestamp": "2019-10-04T11:00:18.392Z",
"trigger_price": "8500.0",
"type": "1"
},
]
}
获取您当前账户交易等级对应的手续费费率，母账户下的子账户的费率和母账户一致。每天凌晨0点更新一次。
此接口返回的手续费费率只适用于(BTC,ETH,EOS,BSV,BCH,LTC,ETC,XRP,TRX)，其他币种费率，请根据您的手续费等级查询费率说明页面确认(https://www.okex.com/fees.html)。
GET/api/swap/v3/trade_fee
2019-11-12T07:28:43.497ZGET/api/swap/v3/trade_fee
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| taker | String | 吃单手续费率 |
| maker | String | 挂单手续费率 |
| timestamp | String | 数据返回时间 |
备注：maker 的值：负数，代表是反佣的费率，正数，代表平台扣除的费率。（和web页面上展示的一致）
{
"maker": "0.0002",
"taker": "0.0005",
"timestamp": "2019-11-25T12:30:50.057Z"
}
市价全平接口，其中BTC合约持仓小于或等于999张时才能调用，否则报错；类似的，其他币种合约的持仓应该小于或等于9999张。
POST/api/swap/v3/close_position
POST/api/swap/v3/close_position{"instrument_id":"BTC-USD- SWAP","direction":"long"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-SWAP |
| direction | String | 是 | 平仓方向 |
long:平多 |
|||
short:平空 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-SWAP |
| direction | String | 平仓方向 |
long:平多 |
||
short:平空 |
||
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
{
"result":true,
"error_message":"",
"error_code":"0",
"instrument_id":"BTC-USD-SWAP",
"direction":"long"
}
此接口，仅支持撤销平仓的所有挂单。不包括开仓的挂单。
POST /api/swap/v3/cancel_all
POST /api/swap/v3/cancel_all{"instrument_id":"BTC-USD- SWAP","direction":"long"}
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-SWAP |
| direction | String | 是 | 平仓方向 |
long:平多 |
|||
short:平空 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 是 合约ID，如BTC-USD-SWAP |
| direction | String | 是 平仓方向 |
long:平多 |
||
short:平空 |
||
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 调用接口返回结果 |
{
"result":true,
"error_message":"",
"error_code":"0",
"instrument_id":"BTC-USD-SWAP",
"direction":"long"
}
获取可用合约的列表，这组公开接口提供了行情数据的快照，无需认证即可调用。 获取可用合约的列表，查询各合约的交易限制和价格步长等信息。
GET/api/swap/v3/instruments
GET/api/swap/v3/instruments
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| underlying | String | 标的指数，如：BTC-USD |
| base_currency | String | 币种，如BTC |
| quote_currency | String | 计价货币，如BTC-USD-SWAP中的USD |
| settlement_currency | String | 盈亏结算和保证金币种，BTC |
| contract_val | String | 合约面值 |
| listing | String | 上线日期 |
| delivery | String | 结算时间 |
| size_increment | String | 数量精度 |
| tick_size | String | 价格精度 |
| is_inverse | String | true or false ,是否是反向合约 |
| contract_val_currency | String | 合约面值计价币种 |
[
{
"instrument_id":"BTC-USD-SWAP",
"underlying_index":"BTC",
"quote_currency":"USD",
"coin":"BTC",
"contract_val":"100",
"listing":"2018-08-28T02:43:23.000Z",
"delivery":"2019-11-26T08:00:00.000Z",
"size_increment":"1",
"tick_size":"0.1",
"base_currency":"BTC",
"underlying":"BTC-USD",
"settlement_currency":"BTC",
"is_inverse":"true",
"contract_val_currency":"USD"
},
{
"instrument_id":"LTC-USD-SWAP",
"underlying_index":"LTC",
"quote_currency":"USD",
"coin":"LTC",
"contract_val":"10",
"listing":"2018-12-21T07:53:47.000Z",
"delivery":"2019-11-26T08:00:00.000Z",
"size_increment":"1",
"tick_size":"0.01",
"base_currency":"LTC",
"underlying":"LTC-USD",
"settlement_currency":"LTC",
"is_inverse":"true",
"contract_val_currency":"USD"
}
.....
]
获取合约的深度列表。
GET/api/swap/v3/instruments/<instrument_id>/depth
GET/api/swap/v3/instruments/BTC-USD-SWAP/depth?size=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如 BTC-USD-SWAP,BTC-USDT-SWAP |
| depth | String | 否 | 按价格合并深度，例如：0.1,0.001 |
| size | String | 否 | 返回深度数量，最大值可传200，即买卖深度共400条 |
校验合约名称，只要和数据库中的合约名称不同，就会报错
当size不传时，返回1条；size传0时，返回0条；size最大200，传大于200的数时，返回200条。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| time | String | 系统时间戳 |
返回值数组说明
["411.8", "10", "1", "4"]
411.8为深度价格，10为此价格的合约张数，1为此价格的强平单个数，4为此价格的订单个数。
{
"asks":[
[
"3968.5",
"121",
0,
2
],
[
"3968.6",
"160",
0,
4
]
],
"bids":[
[
"3968.4",
"179",
0,
4
],
[
"3968",
"914",
0,
3
]
],
"time":"2019-03-25T11:12:10.601Z"
}
获取平台全部合约的最新成交价、买一价、卖一价和24交易量。
GET/api/swap/v3/instruments/ticker
GET/api/swap/v3/instruments/ticker
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| best_ask | String | 卖一价 |
| best_bid | String | 买一 价 |
| last | String | 最新成交价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| timestamp | String | 系统时间戳 |
| last_qty | String | 最新成交的数量 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid_size | String | 买一价对应的数量 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
[
{
"instrument_id": "BTC-USDT-SWAP",
"last": "7387.6",
"high_24h": "7980",
"low_24h": "7348.3",
"volume_24h": "514883697",
"best_ask": "7387.2",
"best_bid": "7387.1",
"timestamp": "2020-03-12T08:03:39.280Z",
"last_qty": "3486",
"best_bid_size": "33068",
"best_ask_size": "9002"
}
]
获取合约的最新成交价、买一价、卖一价和24交易量。
GET/api/swap/v3/instruments/<instrument_id>/ticker
GET/api/swap/v3/instruments/BTC-USD-SWAP/ticker
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
校验合约名称，只要和数据库中的合约名称不同，就会报错
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| last | String | 最新成交价 |
| best_bid | String | 买一价 |
| best_ask | String | 卖一价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| timestamp | String | 系统时间戳 |
| last_qty | String | 最新成交的数量 |
| best_ask_size | String | 卖一价对应的量 |
| best_bid_size | String | 买一价对应的数量 |
最高价、最低价和成交量都是按最近24小时为维度统计的。
{
"instrument_id": "BTC-USDT-SWAP",
"last": "7387.6",
"high_24h": "7980",
"low_24h": "7348.3",
"volume_24h": "514883697",
"best_ask": "7387.2",
"best_bid": "7387.1",
"timestamp": "2020-03-12T08:03:39.280Z",
"last_qty": "3486",
"best_bid_size": "33068",
"best_ask_size": "9002"
}
获取合约的成交记录，本接口能查询最近300条数据。
GET/api/swap/v3/instruments/<instrument_id>/trades
GET/api/swap/v3/instruments/BTC-USD-SWAP/trades?after=1&limit=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| after | String | 否 | 请求此id之前（更旧的数据）的分页内容，传的值为对应接口的trade_id |
| before | String | 否 | 请求此id之后（更新的数据）的分页内容，传的值为对应接口的trade_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
校验合约名称，只要和数据库中的合约名称不同，就会报错。after和before同时传，以after为准
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交id |
| price | String | 成交价格 |
| size | String | 成交数量 |
| side | String | 成交方向：sell或buy |
| timestamp | String | 成交时间 |
成交方向side是指 buy 或 sell，返回 buy 或 sell。
获取永续合约最新的300条成交列表
[
{
"trade_id":"197610300823248897",
"price":"3969.2",
"size":"5",
"side":"buy",
"timestamp":"2019-03-25T11:55:23.569Z"
},
{
"trade_id":"197608511860318209",
"price":"3969.3",
"size":"56",
"side":"sell",
"timestamp":"2019-03-25T11:51:50.308Z"
}
]
获取合约的K线数据。k线数据最多可获取最近1440条。
GET/api/swap/v3/instruments/<instrument_id>/candles
GET/api/swap/v3/instruments/BTC-USD- SWAP/candles?start=2019-03-24T02:31:00.000Z&end=2019-03-25T02:55:00.000Z&granularity=86400
（查询BTC-USD-SWAP的2019年3月24日到25日的日线K线数据）
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| start | String | 否 | 开始时间，必须是ISO 8601格式的时间 |
| end | String | 否 | 结束时间，必须是ISO 8601格式的时间 |
| granularity | String | 否 | |
时间粒度，以秒为单位，默认值60。如[60/180/300/900/1800/3600/7200/14400/21600/43200/86400/604800]，详见下解释说明 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| timestamp | String | 系统时间 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量（按张折算） |
| currency_volume | String | 交易量（按币折算） |
如果用户没有提供开始时间或结束时间中的任一字段，则两个字段都将被忽略。未提供开始时间和结束时间的请求，则系统按时间粒度返回最近的200条数据。
时间粒度granularity必须是[60 180 300 900 1800 3600 7200 14400 21600 43200 86400 604800]中的任一值，否则请求将被拒绝。这些值分别对应的是[1min 3min 5min 15min 30min 1hour 2hour 4hour 6hour 12hour 1day 1week]的时间段。
K线数据可能不完整。
单次请求的最大数据量是200。如果您选择的开始/结束时间和时间粒度导致超过单次请求的最大数据量，您的请求将只会返回200个数据。如果您希望在更大的时间范围内获取足够精细的数据，则需要使用多个开始/结束范围进行多次请求。
数组中的数据顺序分别是：时间戳，开盘价格，最高价格，最低价格，收盘价格，交易量（张），交易量（币）
即分别为[timestamp,open,high,low,close,volume,currency_volume]
[
[
"2019-03-25T16:00:00.000Z",
"3946.6",
"3960",
"3860",
"3917.7",
"329627",
"8434.421"
],
[
"2019-03-24T16:00:00.000Z",
"3971.4",
"3977.7",
"3942.6",
"3946.4",
"333780",
"8416.0873"
]
]
//["系统时间","开盘价格","最高价格","最低价格","收盘价格","交易量（按张折算）","交易量（按币折算）"]
获取币种指数。
GET/api/swap/v3/instruments/<instrument_id>/index
GET/api/swap/v3/instruments/BTC-USD-SWAP/index
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
校验合约名称，只要和数据库中的合约名称不同，就会报错
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| index | String | 现货指数价格 |
| timestamp | String | 系统时间戳 |
指数币对"-"后面的币种表示指数价格的计价单位。
{
"instrument_id":"BTC-USD-SWAP",
"index":"3913.64749999",
"timestamp":"2019-03-26T02:30:20.560Z"
}
获取法币汇率。
GET/api/swap/v3/rate
GET/api/swap/v3/rate
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | USD_CNY |
| rate | String | 汇率 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"USD_CNY",
"rate":"6.701",
"timestamp":"2019-03-26T02:32:52.703Z"
}
获取合约整个平台的总持仓量。
GET/api/swap/v3/instruments/<instrument_id>/open_interest
GET/api/swap/v3/instruments/BTC-USD-SWAP/open_interest
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| amount | String | 总持仓量 |
| timestamp | String | 系统时间戳 |
校验合约名称，只要和数据库中的合约名称不同，就会报错
{
"instrument_id":"BTC-USD-SWAP",
"amount":"303613",
"timestamp":"2019-03-26T02:36:22.703Z"
}
获取合约当前交易的最高买价和最低卖价。
GET/api/swap/v3/instruments/<instrument_id>/price_limit
GET/api/swap/v3/instruments/BTC-USD-SWAP/price_limit
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
校验合约名称，只要和数据库中的合约名称不同，就会报错
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| highest | String | 最高买价 |
| lowest | String | 最低卖价 |
| timestamp | String | 系统时间戳 |
{
"instrument_id":"BTC-USD-SWAP",
"highest":"3953.4",
"lowest":"3875.0",
"timestamp":"2019-03-26T02:42:38.143Z"
}
获取合约强平单。
GET/api/swap/v3/instruments/<instrument_id>/liquidation
GET/api/swap/v3/instruments/BTC-USD-SWAP/liquidation?status=1&limit=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| status | String | 是 | 状态 |
0：最近7天的未成交 |
|||
1：最近7天的已成交 |
|||
| limit | String | 否 | 分页返回的结果集数量，默认为100，最大为100，按时间倒序排列，越晚的在前面 |
| from | String | 否 | 请求此id之前（更旧的数据）的分页内容，例如 2 |
| to | String | 否 | 请求此id之后（更新的数据）的分页内容 例如 3 |
校验合约名称，只要和数据库中的合约名称不同，就会报错
status不是0或1，报非法参数
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| size | String | 数量 |
| created_at | String | 委托时间 |
| loss | String | 穿仓用户亏损 |
| price | String | 委托价格 |
| type | String | 3:平多 |
4:平空 |
[
{
"instrument_id":"BTC-USD-SWAP",
"size":"4",
"created_at":"2019-03-26T02:00:40.490Z",
"loss":"0",
"price":"3935.1",
"type":"4"
},
{
"instrument_id":"BTC-USD-SWAP",
"size":"193",
"created_at":"2019-03-25T23:28:15.922Z",
"loss":"0",
"price":"3932.5",
"type":"4"
}
]
获取合约下一次的结算时间。
GET/api/swap/v3/instruments/<instrument_id>/funding_time
GET/api/swap/v3/instruments/BTC-USD-SWAP/funding_time
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
校验合约名称，只要和数据库中的合约名称不同，就会报错
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| funding_time | String | 当期资金费率时间 |
| funding_rate | String | 当期资金费率 |
| estimated_rate | String | 下一期预测资金费率 |
| settlement_time | String | 结算时间 |
{
"instrument_id": "EOS-USD-SWAP",
"funding_time": "2019-09-02T16:00:00.000Z",
"funding_rate": "-0.00066983",
"estimated_rate": "-0.00043662",
"settlement_time": "2019-09-02T16:00:00.000Z"
}
获取合约标记价格。
GET/api/swap/v3/instruments/<instrument_id>/mark_price
GET/api/swap/v3/instruments/BTC-USD-SWAP/mark_price
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| mark_price | String | 标记价格 |
| timestamp | String | 系统时间戳 |
为了防止个别用户恶意操控市场导致合约价格波动剧烈，我们根据现货指数和合理基差设定标记价格。
{
"instrument_id":"BTC-USD-SWAP",
"mark_price":"3914.3",
"timestamp":"2019-03-26T03:33:50.064Z"
}
获取合约历史资金费率，本接口能查询最近1个月的数据。
GET/api/swap/v3/instruments/<instrument_id>/historical_funding_rate
GET/api/swap/v3/instruments/BTC-USD-SWAP/historical_funding_rate?limit=2
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-SWAP,BTC-USDT-SWAP |
| limit | String | 否 | 返回的结果集数量，默认为100，最大为100，按时间顺序排列，越早下单的在前面 |
校验合约名称，只要和数据库中的合约名称不同，就会报错。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-SWAP |
| funding_rate | String | 当期资金费率 |
| realized_rate | String | 实际资金费率 |
| interest_rate | String | 利率 |
| funding_time | String | 结算时间 |
[
{
"instrument_id":"BTC-USD-SWAP",
"funding_rate":"-0.00007116",
"realized_rate":"-0.00007116",
"interest_rate":"0.00000000",
"funding_time":"2019-03-26T02:00:00.000Z"
},
{
"instrument_id":"BTC-USD-SWAP",
"funding_rate":"-0.00010248",
"realized_rate":"-0.00010248",
"interest_rate":"0.00000000",
"funding_time":"2019-03-25T14:00:00.000Z"
}
]
期权合约交易的行情信息，账户信息，订单操作，订单查询，账单明细查询。
期权接口中underlying, instrument_id, coin等参数值都大小写兼容，比如btc-usd, BTC-USD等价。
获取某个标的下的持仓信息
GET/api/option/v3/<underlying>/position
GET/api/option/v3/BTC-USD/position?instrument_id=BTC-USD-190927-12500-C
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| instrument_id | String | 否 | 合约ID，如BTC-USD-190927-12500-C |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-190927-12500-C |
| position | String | 净持仓数量 |
| avg_cost | String | 开仓平均价 |
| avail_position | String | 可平仓数量 |
| settlement_price | String | 上期结算基准价 |
| total_pnl | String | 不含手续费的持仓收益，可跨期 (markPx - avgCost) Pos multiplier |
| pnl_ratio | String | 收益率 sideFactor * (markPx/avgCost - 1) |
| realized_pnl | String | 当期已实现收益 |
| unrealized_pnl | String | 当期未实现收益 |
| pos_margin | String | 持仓保证金（即初始保证金），只有标准账户提供 |
| option_value | String | 期权市值 |
| created_at | String | 仓位建立时间，ISO 8601格式 |
| updated_at | String | 最后一次仓位变化时间，ISO 8601格式 |
成功返回：
{
"holding":[
{
"instrument_id":"BTC-USD-190927-12500-C",
"position":"20",
"avg_cost":"3.26",
"avail_position":"20",
"settlement_price":"3.6",
"total_pnl":"50",
"pnl_ratio":"0.3",
"realized_pnl":"40",
"unrealized_pnl":"10",
"pos_margin":"100",
"option_value":"70",
"created_at":"2019-08-30T03:09:20.315Z",
"updated_at":"2019-08-30T03:40:18.318Z"
},
{
"instrument_id":"BTC-USD-190927-12500-P",
"position":"20",
"avg_cost":"3.26",
"avail_position":"20",
"settlement_price":"3.6",
"total_pnl":"50",
"pnl_ratio":"0.3",
"realized_pnl":"40",
"unrealized_pnl":"10",
"pos_margin":"100",
"option_value":"70",
"created_at":"2019-08-30T03:09:20.315Z",
"updated_at":"2019-08-30T03:40:18.318Z"
}
]
}
为空返回：分两种情形
一、不传instrument_id
{'holding': []}
二、传instrument_id（列举每个字段，但数值型为0，时间戳字段填1970初始时间）
{
"holding":[
{
"instrument_id":"BTC-USD-190927-7500-C",
"position":"0",
"avg_cost":"0",
"avail_position":"0",
"settlement_price":"0",
"total_pnl":"0",
"pnl_ratio":"0",
"realized_pnl":"0",
"unrealized_pnl":"0",
"pos_margin":"0",
"option_value":"0",
"created_at":"1970-01-01T00:00:00.000Z",
"updated_at":"1970-01-01T00:00:00.000Z"
}
]
}
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取单个标的物账户信息。
GET/api/option/v3/accounts/<underlying>
GET/api/option/v3/accounts/BTC-USD
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| currency | String | 账户币种, 如BTC |
| underlying | String | 标的指数，如BTC-USD |
| equity | String | 权益 |
| total_avail_balance | String | 总余额 |
| margin_balance | String | 保证金余额 |
| margin_frozen | String | 已用保证金（IMR，包含挂单和持仓保证金） |
| avail_margin | String | 可用保证金 |
| max_withdraw | String | 可划转数量 |
| margin_for_unfilled | String | 总挂单保证金 |
| maintenance_margin | String | 持仓最低维持保证金 |
| realized_pnl | String | 当期已实现盈亏汇总 |
| unrealized_pnl | String | 当期未实现盈亏汇总 |
| option_value | String | 期权总市值 |
| delta | String | 账户总delta |
| vega | String | 账户总vega |
| gamma | String | 账户总gamma |
| theta | String | 账户总theta |
| risk_factor | String | 风险乘数 （目前该字段暂未启用） |
| margin_multiplier | String | 规模乘数 （目前该字段暂未启用） |
| account_status | String | "0": 正常，"1": 延迟减仓中，"2": 减仓中 |
成功返回：
{
"underlying": "BTC-USD",
"equity": "0.00254188",
"total_avail_balance": "0.00254188",
"margin_balance": "0.00254188",
"avail_margin": "0.00254188",
"margin_for_unfilled": "0",
"margin_frozen": "0",
"maintenance_margin": "0",
"realized_pnl": "0",
"unrealized_pnl": "0",
"max_withdraw": "0",
"option_value": "0",
"delta": "0",
"vega": "0",
"gamma": "0",
"theta": "0",
"risk_factor": "1",
"margin_multiplier": "1",
"account_status": "0",
"currency": "BTC"
}
为空返回：
{
"underlying": "BTC-USD",
"equity": "0",
"total_avail_balance": "0",
"margin_balance": "0",
"avail_margin": "0",
"margin_for_unfilled": "0",
"margin_frozen": "0",
"maintenance_margin": "0",
"realized_pnl": "0",
"unrealized_pnl": "0",
"max_withdraw": "0",
"option_value": "0",
"delta": "0",
"vega": "0",
"gamma": "0",
"theta": "0",
"risk_factor": "1",
"margin_multiplier": "1",
"account_status": "0",
"currency": "BTC"
}
失败返回：
{'error_code': 36001, 'error_message': 'Invalid underlying index'}
API交易提供限价单下单模式，只有当您的账户有足够的资金才能下单。一旦下单，您的账户资金将在订单生命周期内被冻结，被冻结的资金以及数量取决于订单指定的类型和参数
POST /api/option/v3/order
POST /api/option/v3/order{"client_oid":"oktoption15","instrument_id":"BTC- USD-190927-12500-C","side":"buy","order_type":"0","price":"2.15","size":"2","match_price":"0"}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| client_oid | String | 否 | 由您设置的订单ID来识别您的订单,格式是字母（区分大小写）+数字 或者 |
| 纯字母（区分大小写），1-32位字符 （不能重复） | |||
| instrument_id | String | 是 | 合约ID，如BTC-USD-190927-5000-C |
| side | String | 是 | 订单方向(buy/sell) |
| order_type | String | 否 | 参数填数字，0：普通委托（默认值） |
| price | String | 是 | 委托价格 |
| size | String | 是 | 委托数量（合约张数） |
| match_price | String | 否 | 是否以对手价下单 0:不是（默认值） 1:是 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID，下单失败时，此字段值为-1 |
| client_oid | String | 由您设置的订单ID |
| error_code | String | 错误码，下单成功时为0，下单失败时会显示相应错误码 |
| error_message | String | 错误信息，下单成功时为空，下单失败时会显示错误信息 |
| result | String | 接口调用返回结果，true/false |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
instrument_id
instrument_id必须是有效的合约ID。合约列表可通过GET/api/option/v3/instruments/接口获取。
client_oid
用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单和查询订单时只能撤销或者查询最新的一条数据。
side
side委托订单的方向，buy或sell。
price
price表示买入或卖出每张合约的价格。价格必须是价格步长(tick_size)的倍数。价格步长(tick_size)是价格的最小增量，可通过/instruments接口获取。
size
size表示买入或卖出合约的张数。数量必须是正整数。
match_price
对手价表示你希望以目前对手方的最优价格成交。如果你下的是买单，选择以对手价下单表示你用当前卖一价进行下单。如果你下的是卖单，选择以对手价下单表示你用当前买一价进行下单。
响应
成功接受的订单将被分配一个订单ID。成功接受的订单表示撮合引擎已经接受的订单。未成交的订单不会过期，并将保持撮合状态，直到被成交或取消。
下单成功：
{
"result": "true",
"error_message": "",
"error_code": "0",
"client_oid": "b1234",
"order_id": "131801215763791872"
}
下单失败：
{
"result": "true",
"error_message": "Invalid format for client_oid",
"error_code": "36203",
"client_oid": "1234",
"order_id": "-1"
}
批量进行下单请求，每个标的指数最多可批量下10个单。
POST /api/option/v3/orders
POST /api/option/v3/orders{"underlying": "BTC-USD", "order_data":[{"instrument_id":"BTC-USD-190927-12500-C", "size": "1", "price": "3.2571", "side": "buy", "order_type":"0", "match_price": "0"}, {"instrument_id":"BTC-USD-190927-12500-C", "size": "1", "price": "3.26", "side": "buy", "order_type":"0", "match_price": "0"}]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD，同一批订单合约必须针对同一指数标的。 |
| order_data | String | 是 | 订单请求列表，每个请求与单个订单请求格式一致 |
请求参数的校验和单个订单一致。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_info | String | 批量下单结果列表，每个元素的结构与单个下单返回一致 |
| result | String | 接口调用返回结果, true/false |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
client_oid 是数字+字母（大小写）或者纯字母（大小写）类型 1-32位
result是代表服务器处理了请求，不代表下单是否成功。
返回的结果数据和order_data提交订单数据顺序一致。如果下单失败，则order_id为-1，error_code是错误码提示，error_message是错误信息。
批量下单成功：
{
"result": "true",
"order_info": [
{
"error_message": "",
"result": "true",
"error_code": "0",
"client_oid": "order1",
"order_id": "131841003766198272"
},
{
"error_message": "",
"result": "true",
"error_code": "0",
"client_oid": "order2",
"order_id": "131841003766198273"
}
]
}
批量下单失败：
全部失败：
{
"order_info":[
{
"client_oid":"oktoption14",
"order_id":"-1",
"error_code":"36211",
"error_message":"Exceeding max batch size for order submission",
"result":"false"
},
{
"client_oid":"oktoption15",
"order_id":"-1",
"error_code":"36211",
"error_message":"Exceeding max batch size for order submission",
"result":"false"
}
],
"result":"true"
}
部分失败：
{
"order_info":[
{
"client_oid":"oktoption14",
"order_id":"305512815291895606",
"error_code":"0",
"error_message":"",
"result":"true"
},
{
"client_oid":"oktoption15",
"order_id":"-1",
"error_code":"36211",
"error_message":"Exceeding max batch size for order submission",
"result":"false"
}
],
"result":"true"
}
撤销之前下的未完成订单。
POST /api/option/v3/cancel_order/<underlying>/<order_id or client_oid>
POST /api/option/v3/cancel_order/BTC-USD/305512815291895607
or
POST /api/option/v3/cancel_order/BTC-USD/oktoption15
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| order_id | String | 非必填 | order_id和client_oid必须且只能选一个填写。订单ID。 |
| client_oid | String | 非必填 | order_id和client_oid必须且只能选一个填写。在下单时由您设置的ID来识别您的订单, |
| 类型为字母（大小写）+数字或者纯字母（大小写） 1-32位字符 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| error_code | String | 错误码，撤单成功时为0，撤单失败时会显示相应错误码 |
| error_message | String | 错误信息，撤单成功时为空，撤单失败时会显示错误信息 |
| result | String | 接口调用返回结果，true/false |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
使用client_oid撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
result是代表服务器处理了请求，不代表撤单是否成功。
如果订单无法取消(已经成交或已取消)，那么返回的报错内容里将显示相应的原因。
{
"order_id": "131801215763791872",
"client_oid": "b1234",
"result": "true",
"error_message": "",
"error_code": "0"
}
批量撤销之前下的未完成订单，每个标的指数最多可批量撤10个单。
POST /api/option/v3/cancel_batch_orders/<underlying>
POST /api/option/v3/cancel_batch_orders/BTC- USD{"order_ids":["305512815291895606","305512815291895607"]}
OR
POST /api/option/v3/cancel_batch_orders/BTC- USD{"client_oids":["oktoption14","oktoption15"]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 合约标的指数，如BTC-USD，同一批量撤单必须为同一标的合约 |
| order_ids | List | 非必填 | order_id和client_oid必须且只能选一个填写。订单ID的列表。 |
| client_oids | List | 非必填 | |
| order_id和client_oid必须且只能选一个填写。client_oid的列表，在下单时由您设置的ID来识别您的订单, | |||
| 类型为字母（大小写）+数字或者纯字母（大小写） 1-32位字符 |
请求参数校验和单个订单撤销一致。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_info | String | 批量撤单结果列表，每个元素的结构与单个撤单返回一致 |
| result | String | 接口调用返回结果, true/false |
返回值中是已发起撤销操作的订单ID列表，不代表这些订单已成功撤销，正在成交中的无法撤销，未成交的可成功撤销。
如果error_code的返回值不为0，说明请求校验失败并被拒绝.
使用client_oid批量撤单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，撤单时只能撤销最新的一条数据
result是代表服务器处理了请求，不代表撤单是否成功。
无法保证一定会成功撤销，建议用户调用批量撤单接口后，再调用获取订单列表接口确认。
批量撤单成功：（传入order_id）
{
"result": "true",
"order_info": [
{
"error_message": "",
"result": "true",
"error_code": "0",
"client_oid": "order1",
"order_id": "131841003766198272"
},
{
"error_message": "",
"result": "true",
"error_code": "0",
"client_oid": "order2",
"order_id": "131841003766198273"
}
]
}
批量撤单失败：（传入order_id）
{
"result":"true",
"order_info":[
{
"client_oid":"", --如果能通过order_id带出来，也返回
"order_id":"305512815291895606",
"error_code":"36216",
"error_message":"Order does not exist",
"result":"false"
},
{
"client_oid":"", --如果能通过order_id带出来，也返回
"order_id":"305512815291895607",
"error_code":"36216",
"error_message":"Order does not exist",
"result":"false"
}
]
}
批量撤单失败：（client_oid）
{
"result": "true",
"order_info":[
{
"client_oid":"oktoption14",
"order_id":"", --如果能通过client_oid带出来，也返回
"error_code":"36218",
"error_message":"Order cancellation failed.",
"result":"false"
},
{
"client_oid":"oktoption15",
"order_id":"", ----如果能通过client_oid带出来，也返回
"error_code":"36218",
"error_message":"Order cancellation failed.",
"result":"false"
}
]
}
修改之前下的未完成订单。
POST /api/option/v3/amend_order/<underlying>
POST /api/option/v3/amend_order/BTC- USD{"order_id":"305512815291895607","new_size":"2"}
or
POST /api/option/v3/amend_order/BTC- USD{"client_oid":"oktoption15","new_size":"2"}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| order_id | String | 非必填 | order_id和client_oid不能同时为空。订单ID。 |
| client_oid | String | 非必填 | order_id和client_oid不能同时为空。在下单时由您设置的ID来识别您的订单, |
| 类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符。 | |||
| request_id | String | 否 | |
| 客户可选择提供request_id，如果提供，在修改返回状态中，会包含相应的request_id，方便客户找到相应的修改请求。类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符。 | |||
| new_size | String | 非必填 | |
| new_size和new_price至少要传入一个。请求修改的新数量，对于部分成交订单，该数量应包含已成交数量。 | |||
| new_price | String | 非必填 | new_size和new_price至少要传入一个。请求修改的新价格。 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| request_id | String | 如果客户在修改请求中提供request_id，则返回相应request_id |
| error_code | String | 错误码，请求成功时为0，请求失败时会显示相应错误码 |
| error_message | String | 错误信息，请求成功时为空，请求失败时会显示错误信息 |
| result | String | 接口调用返回结果，true/false |
如果error_code的返回值不为0，说明请求校验失败并被拒绝
使用client_oid修改订单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，只能修改最新的一条数据
如果同时传入了order_id和client_oid，将使用order_id，而忽略client_oid.
result是代表服务器处理了请求，不代表修改是否成功。
如果订单无法修改，那么返回的报错内容里将显示相应的原因。
{
"result": "true",
"request_id": "",
"client_oid": "b1234",
"order_id": "131801215763791872",
"error_message": "",
"error_code": "0"
}
修改之前下的未完成订单，每个标的指数最多可批量修改10个单。
POST /api/option/v3/amend_batch_orders/<underlying>
POST /api/option/v3/amend_batch_orders/BTC- USD{"amend_data":[{"order_id":"305512815291895607","new_size":"2"},{"order_id":"305512815291895606","new_size":"1"}]}
OR
POST /api/option/v3/amend_batch_orders/BTC- USD{"amend_data":[{"client_oid":"oktoption15","request_id":"okoptionBTCUSDmod001","new_size":"2"},{"client_oid":"oktoption14","request_id":"okoptionBTCUSDmod002","new_size":"1"}]}
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 合约标的指数，如BTC-USD，同一批修改必须对应同一个标的指数 |
| amend_data | List | 是 | 批量修改请求，每一个请求格式与单个修改相同。 |
请求参数校验和单个订单修改一致。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_info | String | 批量修改结果列表，每个元素的结构与单个修改订单返回一致 |
| result | String | 接口调用返回结果, true/false |
返回值中是已发起修改操作的订单ID列表，不代表这些订单已成功修改。
如果error_code的返回值不为0，说明请求校验失败并被拒绝
使用client_oid 批量修改订单时，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，修改时只能修改最新的一条数据。
result是代表服务器处理了请求，不代表修改是否成功。
无法保证一定会成功修改，建议用户调用批量修改订单接口后，再调用获取订单列表接口确认。
传入client_oid批量修改
{
"order_info":[
{
client_oid":"oktoption14",
"order_id":"",
"request_id":"okoptionBTCUSDmod002",
"error_code":"0",
"error_message":"",
"result":"true"
},
{
"client_oid":"oktoption15",
"order_id":"",
"request_id":"okoptionBTCUSDmod001",
"error_code":"0",
"error_message":"",
"result":"true"
}
],
"result":"true"
}
查询单个订单状态。已撤销的未成交单只保留2个小时。
GET/api/option/v3/orders/<underlying>/<order_id or client_oid>
GET/api/option/v3/orders/BTC-USD/305512815291895606
or
GET/api/option/v3/orders/BTC-USD/oktoption14
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 合约标的指数，如BTC-USD |
| order_id | String | 非必填 | order_id和client_oid必须且只能选一个填写。订单ID。 |
| client_oid | String | 非必填 | order_id和client_oid必须且只能选一个填写。下单时由您设置的订单ID来识别您的订单 |
| , 类型为字母（大小写）+数字或者纯字母（大小写） 1-32位字符 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| timestamp | String | 状态变更时间，ISO 8601格式 |
| instrument_id | String | 合约名称，如BTC-USD-190927-12500-C |
| size | String | 委托数量 |
| price | String | 委托价格 |
| side | String | 订单方向(buy/sell) |
| filled_qty | String | 成交数量 |
| price_avg | String | 成交均价（如果成交数量为0，该字段也为0） |
| fee | String | 手续费 |
| contract_val | String | 合约面值（即合约乘数） |
| last_fill_px | String | 最新成交价格（如没有成交，为0） |
| last_fill_qty | String | 最新成交数量（如没有成交，为0） |
| order_type | String | 0：普通委托 |
| type | String | 区分用户订单的属性 |
| 1.买入，2.卖出，11.强平卖出，12.强平买入，13.减仓卖出，14.减仓买入 | ||
| state | String | 订单状态("-2":失败, "-1":撤单成功, "0":等待成交 , "1":部分成交, "2":完全成交, |
| "3":下单中, "4":撤单中, "5": 修改中） |
client_oid的类型为字母（大小写）+数字或者纯字母（大小写），1-32位字符，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
成功返回：
{
"order_id": "131801215763791872",
"client_oid": "b1234",
"timestamp": "2019-12-30T08:50:58.614Z",
"instrument_id": "BTC-USD-200103-7500-C",
"size": "1",
"price": "0.001",
"side": "buy",
"filled_qty": "0",
"price_avg": "0",
"fee": "0",
"contract_val": "0.1000",
"last_fill_px": "0",
"last_fill_qty": "0",
"order_type": "0",
"state": "0",
"type": "1"
}
为空返回：
{}
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取当前所有的订单列表。本接口能查询7天内数据。
GET/api/option/v3/orders/<underlying>
GET/api/option/v3/orders/BTC-USD?instrument_id=BTC- USD-190927-12500-C&after=18&before=3&state=2&limit=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 合约标的指数，如BTC-USD |
| instrument_id | String | 否 | 合约ID，如BTC- |
| USD-190927-12500-C。如果提供的instrument_id的标的物与underlying参数不同，返回错误码。 | |||
| after | String | 否 | 请求此id之前(更旧的数据)的分页内容，传的值为对应接口的order_id |
| before | String | 否 | 请求此id之后(更新的数据)的分页内容，传的值为对应接口的order_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| state | String | 是 | 订单状态("-2":失败,"-1":撤单成功,"0":等待成交 ,"1":部分成交, |
| "2":完全成交,"3":下单中,"4":撤单中,"6": 未完成（等待成交+部分成交），"7":已完成（撤单成功+完全成交）） |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| order_info | List | 查询结果列表，其中每个元素的结构与"查询单个订单状态"接口返回一致。 |
| order_id | String | 订单ID |
| client_oid | String | 由您设置的订单ID来识别您的订单 |
| timestamp | String | 状态变更时间，ISO 8601格式 |
| instrument_id | String | 合约名称，如BTC-USD-190927-12500-C |
| size | String | 委托数量 |
| price | String | 委托价格 |
| side | String | 订单方向(buy/sell) |
| filled_qty | String | 成交数量 |
| price_avg | String | 成交均价（如果成交数量为0，该字段也为0） |
| fee | String | 手续费 |
| contract_val | String | 合约面值（即合约乘数） |
| last_fill_px | String | 最新成交价格（如没有成交，为0） |
| last_fill_qty | String | 最新成交数量（如没有成交，为0） |
| order_type | String | 0：普通委托 |
| type | String | 区分用户订单的属性 |
| 1.买入，2.卖出，11.强平卖出，12.强平买入，13.减仓卖出，14.减仓买入 | ||
| state | String | 订单状态("-2":失败, "-1":撤单成功, "0":等待成交 , "1":部分成交, "2":完全成交, |
| "3":下单中, "4":撤单中, "5": 修改中） |
client_oid 的类型为字母（大小写）+数字或者纯字母（大小写）， 1-32位字符 ，用户需要自己保证此ID不重复，OKEx不会进行排重提示，如有重复，查询订单时只能查询出最新的一条数据。
成功返回：
{
"order_info": [
{
"client_oid": "b1234",
"contract_val": "0.1000",
"fee": "0",
"filled_qty": "0",
"instrument_id": "BTC-USD-200103-7500-C",
"last_fill_px": "0",
"last_fill_qty": "0",
"order_id": "131801215763791872",
"order_type": "0",
"price": "0.001",
"price_avg": "0",
"side": "buy",
"size": "2",
"state": "-1",
"timestamp": "2019-12-30T08:57:44.323Z",
"type": "1"
}
]
}
为空返回：
{'order_info': []}
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取最近的成交明细列表。本接口能查询7天内数据。
GET/api/option/v3/fills/<underlying>;
GET/api/option/v3/fills/BTC-USD?instrument_id=BTC- USD-190927-12500-C&client_oid=oktoption15&limit=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 合约标的指数，如BTC-USD |
| order_id | String | 否 | 订单ID |
| instrument_id | String | 否 | 合约名称，如BTC-USD-190927-12500-C |
| after | String | 否 | 请求此id之前(更旧的数据)的分页内容，传的值为对应接口的trade_id |
| before | String | 否 | 请求此id之后(更新的数据)的分页内容，传的值为对应接口的trade_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交ID |
| order_id | String | 订单ID |
| instrument_id | String | 合约名称，如BTC-USD-190927-12500-C |
| fill_price | String | 成交价格 |
| fill_qty | String | 成交数量 |
| timestamp | String | 成交时间, ISO 8601格式 |
| side | String | 成交方向(buy/sell) |
| exec_type | String | 流动性方向，T：taker M：maker |
| fee | String | 手续费 |
成功返回：
[
{
"trade_id": "135383019552770048",
"order_id": "135383019066273792",
"instrument_id": "BTC-USD-200110-6500-P",
"fill_price": "0.001",
"fill_qty": "1",
"side": "buy",
"exec_type": "taker",
"fee": "-0.0000125",
"timestamp": "2020-01-09T06:03:47.095Z"
},
{
{
"trade_id": "130026669872252928",
"order_id": "130019947002728448",
"instrument_id": "TBTC-USD-191227-8000-P",
"fill_price": "0.011",
"fill_qty": "27",
"side": "buy",
"exec_type": "maker",
"fee": "-0.00054",
"timestamp": "2019-12-25T11:19:33.871Z"
}
]
为空返回：
[]
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
列出账户资产流水，账户资产流水是指导致账户余额增加或减少的行为。流水会分页，每页100条数据，并且按照时间倒序排序和存储，最新的排在最前面。 本接口能查询最近7天的数据。
GET/api/option/v3/accounts/<underlying>/ledger
GET/api/option/v3/accounts/BTC-USD/ledger?after=18&before=3&limit=10
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| after | String | 否 | 请求此id之前(更旧的数据)的分页内容，传的值为对应接口的ledger_id； |
| before | String | 否 | 请求此id之后(更新的数据)的分页内容，传的值为对应接口的ledger_id； |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| ledger_id | String | 账单ID |
| currency | String | 账户币种, 如BTC |
| amount | String | 变动金额 |
| realized_pnl | String | 已实现收益，不含费用 |
| type | String | 流水来源类型（具体参见下表） |
| timestamp | String | 账单创建时间，ISO 8601格式 |
| balance | String | 如果类型是交易产生的，代表成交张数 |
| details | String | |
如果type是trade或者fee，则会有该details字段将包含order，instrument信息,如果type是transfer，则会有该details字段将包含from，to信息 |
||
| order_id | String | 订单ID |
| instrument_id | String | 合约ID |
| from | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| to | String | 是 |
1:币币账户 |
||
3:交割合约 |
||
4:法币账户 |
||
5:币币杠杆账户 |
||
6:资金账户 |
||
8:余币宝账户 |
||
9:永续合约账户 |
||
12:期权合约 |
||
14:挖矿账户 |
||
17:借贷账户 |
||
| 流 水来源类型 | 参 数类型 | 描 述 |
| --- | --- | --- |
| transfer | String | 转入/转出 |
| match | String | 交易 |
| fee | String | 手续费 |
| settlement | String | 交割/结算 |
| liquidation | String | 强平/减仓 |
成功返回：
[
{
"ledger_id": "131798350215260160",
"currency": "BTC",
"amount": "0.00254188",
"realized_pnl": "0",
"type": "transfer",
"timestamp": "2019-12-30T08:39:35.385Z",
"balance": "0",
"details": null
}
]
为空返回：
[]
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取当前账户交易等级对应的手续费费率，母账户下的子账户的费率和母账户一致（每天凌晨0点更新）。
GET/api/option/v3/trade_fee
GET/api/option/v3/trade_fee
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| timestamp | String | 当前时间，ISO 8601格式 |
| maker | String | 挂单手续费率 |
| taker | String | 吃单手续费率 |
| exercise | String | 行权手续费率 |
成功返回：
{
"timestamp": "2019-12-30T11:09:35.380Z",
"maker": "0.0002",
"taker": "0.0005",
"exercise": "0.0002"
}
为空返回：
{}
失败返回：
{
"error_message": "Instrument does not exist",
"error_code": "36002"
}
获取期权交易已支持的标的指数列表。
GET/api/option/v3/underlying
GET/api/option/v3/underlying
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| underlying | String | 标的指数，如BTC-USD |
成功返回：
[
"BTC-USD"
]
为空返回：
[]
失败返回：
{'error_code': 36101, 'error_message': 'Account does not exist'}
获取可用合约的列表。
GET/api/option/v3/instruments/<underlying>
GET/api/option/v3/instruments/BTC-USD?instrument_id=BTC- USD-190927-8500-C&delivery=190927
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| delivery | String | 否 | 合约到期日，如果提供，只返回相应到期日的合约信息。格式为"YYMMDD"，如"190527" |
| instrument_id | String | 否 | 合约ID，如果提供，只返回相应合约信息 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-190830-9000-C |
| underlying | String | 标的指数，如BTC-USD |
| settlement_currency | String | 盈亏结算和保证金币种，如BTC |
| contract_val | String | 合约乘数，对BTC期权合约，该值为0.1 |
| option_type | String | 期权类型，C或P |
| strike | String | 行权价格 |
| tick_size | String | 价格精度（如0.0005） |
| lot_size | String | 一手合约张数 |
| listing | String | 上线日期，ISO 8601格式 |
| delivery | String | 交割日期，ISO 8601格式 |
| state | String | 合约状态：1-预上线, 2-已上线, 3-暂停交易, 4-结算中 |
| trading_start_time | String | 交易开始时间，ISO 8601格式 |
| timestamp | String | 合约状态变更时间，ISO 8601格式 |
成功返回：
[
{
"instrument_id":"BTC-USD-200103-5500-C",
"underlying":"BTC-USD",
"settlement_currency":"BTC",
"contract_val":"0.1000",
"option_type":"C",
"strike":"5500",
"tick_size":"0.0005",
"lot_size":"1.0000",
"listing":"2019-12-25T08:30:36.175Z",
"delivery":"2020-01-03T08:00:00.000Z",
"state":"2",
"trading_start_time":"2019-12-25T08:30:36.175Z",
"timestamp":"2019-12-30T08:00:23.156Z"
}
]
为空返回：
[]
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取同一标的下所有期权合约详细定价。
GET/api/option/v3/instruments/<underlying>/summary
获取同一标的下所有期权合约详细定价：
GET/api/option/v3/instruments/BTC-USD/summary?delivery=190927
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| delivery | String | 否 | 合约到期日，如果提供，只返回相应到期日的合约信息。格式为"YYMMDD"，如"190527" |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID |
| timestamp | String | 系统时间戳，ISO 8061格式 |
| best_bid | String | 买一价 |
| best_ask | String | 卖一价 |
| last | String | 最新成交价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| open_interest | String | 持仓量 |
| mark_price | String | 标记价格 |
| highest_buy | String | 最高买价 |
| lowest_sell | String | 最低卖价 |
| delta | String | 期权价格对underlying价格的敏感度 |
| gamma | String | delta对underlying价格的敏感度 |
| vega | String | 期权价格对隐含波动率的敏感度 |
| theta | String | 期权价格对剩余期限的敏感度 |
| leverage | String | 杠杆倍数 |
| mark_vol | String | 标记波动率 |
| bid_vol | String | bid波动率 |
| ask_vol | String | ask波动率 |
| realized_vol | String | 已实现波动率（目前该字段暂未启用） |
| estimated_price | String | 预估交割价 |
成功返回：所有期权详细定价
[
{
"instrument_id":"BTC-USD-200103-5500-C",
"best_ask":"0.25",
"best_bid":"0.246",
"best_ask_size":"305",
"best_bid_size":"305",
"delta":"0.7494223636",
"gamma":"-0.6765419039",
"high_24h":"0",
"highest_buy":"0.3435",
"realized_vol":"0",
"bid_vol":"",
"ask_vol":"1.5625",
"mark_vol":"0.9987",
"last":"0",
"leverage":"4.0342",
"low_24h":"0",
"lowest_sell":"0.152",
"mark_price":"0.24788017",
"theta":"-0.0000809873",
"vega":"0.0000077307",
"volume_24h":"0",
"open_interest":"0",
"estimated_price":"0",
"timestamp":"2019-12-30T10:57:31.691Z"
}
]
为空返回：所有期权详细定价
[]
失败返回：所有期权详细定价
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取某个期权合约的详细定价。
GET/api/option/v3/instruments/<underlying>/summary/<instrument_id>
GET/api/option/v3/instruments/BTC-USD/summary/BTC-USD-190927-12500-C
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| underlying | String | 是 | 标的指数，如BTC-USD |
| instrument_id | String | 是 | 合约ID，如果提供，只返回相应合约信息 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约ID |
| timestamp | String | 系统时间戳，ISO 8061格式 |
| best_bid | String | 买一价 |
| best_ask | String | 卖一价 |
| last | String | 最新成交价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量，按张数统计 |
| open_interest | String | 持仓量 |
| mark_price | String | 标记价格 |
| highest_buy | String | 最高买价 |
| lowest_sell | String | 最低卖价 |
| delta | String | 期权价格对underlying价格的敏感度 |
| gamma | String | delta对underlying价格的敏感度 |
| vega | String | 期权价格对隐含波动率的敏感度 |
| theta | String | 期权价格对剩余期限的敏感度 |
| leverage | String | 杠杆倍数 |
| mark_vol | String | 标记波动率 |
| bid_vol | String | bid波动率 |
| ask_vol | String | ask波动率 |
| realized_vol | String | 已实现波动率（目前该字段暂未启用） |
| estimated_price | String | 预估交割价 |
成功返回：某个期权详细定价
{
"instrument_id": "BTC-USD-200103-7500-C",
"best_ask": "0.011",
"best_bid": "0.0095",
"best_ask_size": "305",
"best_bid_size": "305",
"delta": "0.3110611374",
"gamma": "6.9373354861",
"high_24h": "0.0205",
"highest_buy": "0.0495",
"realized_vol": "0",
"bid_vol": "0.4688",
"ask_vol": "0.5078",
"mark_vol": "0.4797",
"last": "0.01",
"leverage": "99.4482",
"low_24h": "0.01",
"lowest_sell": "0.0005",
"mark_price": "0.01005549",
"theta": "-0.0022838375",
"vega": "0.0003687666",
"volume_24h": "713",
"open_interest": "404",
"estimated_price": "0",
"timestamp": "2019-12-30T11:05:19.691Z"
}
为空返回：某个期权详细定价
{}
失败返回：某个期权详细定价
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取期权合约的深度数据。
GET/api/option/v3/instruments/<instrument_id>/book
GET/api/option/v3/instruments/BTC-USD-190927-12500-C/book
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约ID，如BTC-USD-190927-12500-C |
| size | String | 否 | 返回深度数量，最大值可传200 |
当size不传时，返回200条；size传0时，返回0条；size最大200，传大于200的数时，返回200条。
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 系统时间戳，ISO 8061格式 |
返回的买卖方深度List中，每一个价格格式为[价格，数量， 强平单数量，订单数量]，比如["5621.8", "125", "0", "5"]
成功返回：
{
"asks": [
[
"0.0105",
"305",
"0",
"1"
]
],
"bids": [
[
"0.009",
"305",
"0",
"1"
]
],
"timestamp": "2019-12-30T10:50:59.607Z"
}
为空返回：
{"asks":[],"bids":[],"timestamp":"2019-12-30T10:50:59.607Z"}
失败返回：
{
"error_message": "Instrument does not exist",
"error_code": "36002"
}
获取期权合约的成交记录。
GET/api/option/v3/instruments/<instrument_id>/trades
GET/api/option/v3/instruments/BTC- USD-190927-12500-C/trades?after=18&before=3&limit=50
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-190927-12500-C |
| after | String | 否 | 请求此id之前(更旧的数据)的分页内容，传的值为对应的trade_id |
| before | String | 否 | 请求此id之后(更新的数据)的分页内容，传的值为对应的trade_id |
| limit | String | 否 | 分页返回的结果集数量，最大为100，不填默认返回100条 |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交id |
| price | String | 成交价格 |
| qty | String | 成交数量 |
| side | String | 成交方向：buy/sell |
| timestamp | String | 成交时间，ISO 8601格式 |
成功返回：
[
{
"timestamp":"2019-12-27T00:06:19.208Z",
"trade_id":"9",
"price":"0.016",
"qty":"50",
"side":"buy"
},
{
"timestamp":"2019-12-26T21:08:19.277Z",
"trade_id":"8",
"price":"0.017",
"qty":"100",
"side":"sell"
}
]
为空返回：
[]
失败返回：
{
"error_message": "Instrument does not exist",
"error_code": "36002"
}
获取某个期权合约的最新成交价、买一价、卖一价和对应的量。
GET/api/option/v3/instruments/<instrument_id>/ticker
GET/api/option/v3/instruments/BTC-USD-190927-12500-C/ticker
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-190927-12500-C |
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| instrument_id | String | 合约名称，如BTC-USD-190927-12500-C |
| best_bid | String | 买一价 |
| best_bid_size | String | 买一价对应的数量 |
| best_ask | String | 卖一价 |
| best_ask_size | String | 卖一价对应的数量 |
| last | String | 最新成交价 |
| last_qty | String | 最新成交数量 |
| open_interest | String | 持仓量 |
| open_24h | String | 24小时开盘价 |
| high_24h | String | 24小时最高价 |
| low_24h | String | 24小时最低价 |
| volume_24h | String | 24小时成交量（按张数统计） |
| timestamp | String | 系统时间戳，ISO 8601格式 |
成功返回：
{
"instrument_id": "BTC-USD-200103-7500-C",
"best_bid": "0.009",
"best_ask": "0.0105",
"last": "0.01",
"best_bid_size": "305",
"best_ask_size": "305",
"last_qty": "0",
"open_interest": "404",
"open_24h": "0.0115",
"high_24h": "0.0205",
"low_24h": "0.01",
"volume_24h": "713",
"timestamp": "2019-12-30T11:08:06.122Z"
}
为空返回：
{}
失败返回：
{
"error_message": "Invalid underlying index",
"error_code": "36001"
}
获取期权合约的K线数据。
GET/api/option/v3/instruments/<instrument_id>/candles
GET/api/option/v3/instruments/BTC- USD-190927-12500-C/candles?start=2019-03-24T02:31:00.000Z&end=2019-03-25T02:55:00.000Z&granularity=86400
| 参 数名 | 参 数类型 | 是 否必须 | 描 述 |
|---|---|---|---|
| instrument_id | String | 是 | 合约名称，如BTC-USD-190927-12500-C |
| start | String | 否 | 开始时间，ISO 8601格式的时间 |
| end | String | 否 | 结束时间，ISO 8601格式的时间 |
| granularity | String | 否 | 时间粒度，以秒为单位，默认值为60。如`[60/180/300 |
| 900/1800/3600/7200/14400/21600/43200/86400/604800]`，详见下解释说明。 |
start和end必须是ISO 8601格式的时间，否则报错；如未提供，默认返回200条数据。
granularity必须是枚举范围内的时间颗粒度，否则报错
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| timestamp | String | 开始时间，ISO 8601格式 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量(按张折算) |
| currency_volume | String | 交易量(按币种折算) |
时间粒度granularity必须是[60 180 300 900 1800 3600 7200 14400 21600 43200 86400 604800]中的任一值，否则请求将被拒绝。这些值分别对应的是[1min 3min 5min 15min 30min 1hour 2hour 4hour 6hour 12hour 1day 1week]的时间段。
K线数据可能不完整。
返回值数组顺分别为是：[timestamp,open,high,low,close,volume,currency_volume]
成功返回：
[
[
"2019-12-30T11:07:00.000Z",
"0.01",
"0.01",
"0.01",
"0.01",
"0",
"0"
],
[
"2019-12-30T11:06:00.000Z",
"0.01",
"0.01",
"0.01",
"0.01",
"0",
"0"
]
]
为空返回：
[]
失败返回：
{
"error_message": "Instrument does not exist",
"error_code": "36002"
}
指数接口
获取指数成分。此接口为公共接口，不需要身份验证。
GET/api/index/v3/<instrument_id>/constituents
GET/api/index/v3/BTC-USD/constituents
| 参数名 | 参数类型 | 是否必须 | 描述 |
|---|---|---|---|
| instrument_id | String | 是 | 指数币对，如BTC/USD指数则为BTC-USD，如BTC/USDT指数则为BTC- |
| USDT，如EOS/BTC指数则为EOS-BTC。 |
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| last | String | 最新指数价格 |
| original_price | Price | 原始价格 |
| weight | String | 权重 |
| usd_price | String | 折算成USD价格 |
| exchange | String | 交易所名称 |
| instrument_id | String | 指数币对，如BTC指数则为BTC-USD |
| timestamp | String | 系统时间戳 |
| symbol | String | 交易所币对名称，如BTC-USD |
指数币对"-"后面的币种表示指数价格的计价单位。
{
"code": 0,
"data": {
"last": "5562.42250000",
"constituents": [
{
"symbol": "BTC-USD",
"original_price": "5562.75",
"weight": "0.25",
"usd_price": "5562.75",
"exchange": "GEMINI"
},
{
"symbol": "BTC-USD",
"original_price": "5562.44",
"weight": "0.25",
"usd_price": "5562.44",
"exchange": "Coinbase"
},
{
"symbol": "BTC-USD",
"original_price": "5564.5",
"weight": "0.25",
"usd_price": "5564.5",
"exchange": "Bitstamp"
},
{
"symbol": "BTC-USD",
"original_price": "5560",
"weight": "0.25",
"usd_price": "5560",
"exchange": "kraken"
}
],
"instrument_id": "BTC-USD",
"timestamp": "2019-04-23T12:13:03.848Z"
},
"detailMsg": "",
"msg": ""
}
获取系统升级和维护的事件状态。
获取系统维护的状态。
GET /api/system/v3/status
GET/api/system/v3/status?status=2
| 参 数名 | 类 型 | 是 否必填 | 描 述 |
|---|---|---|---|
| status | String | 否 | 系统维护的状态 0:等待中 ; 1:进行中 ; 2:已完成 不填写此参数，默认返回 status为 0 和 |
1 的数据 |
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| title | String | 系统维护说明的标题 |
| status | String | 系统维护的状态 0:等待中 ; 1:进行中 ; 2:已完成 |
| start_time | String | 系统维护的开始时间,格式为ISO 8601标准格式 如: 2020-04-03T16:30:00.000Z |
| end_time | String | 系统维护的结束时间,格式为ISO 8601标准格式 如: 2020-04-03T17:40:00.000Z |
| href | String | 系统维护详情的超级链接,若无返回值，默认值为空，如 href: "" |
| product_type | String | 产品类型 0 :Websocket ; 1:币币 ; 2:交割 ; 3:永续 ; 4:期权 |
[
{
"title": "Spot System Optimization",
"href": "",
"product_type": "1",
"status": "2",
"start_time": "2020-04-10T04:30:00.000Z",
"end_time": "2020-04-10T04:40:00.000Z"
},
{
"title": "Spot System Optimization",
"href": "",
"product_type": "1",
"status": "2",
"start_time": "2020-04-10T02:30:00.000Z",
"end_time": "2020-04-10T02:40:00.000Z"
}
]
v3API将使用统一30000开头的错误码
公共错误码包括签名以及各个业务线统一的错误码
| 错误提示 | 错误码 | http状态码 |
|---|---|---|
| 成功（下单成功，撤单成功，操作成功等） | 0 | 200 |
| 长时间没有接收到数据 | 4001 | 400 |
| 缓冲区无法写入数据关闭 | 4002 | 400 |
| 请求头"OK_ACCESS_KEY"不能为空 | 30001 | 400 |
| 请求头"OK_ACCESS_SIGN"不能为空 | 30002 | 400 |
| 请求头"OK_ACCESS_TIMESTAMP"不能为空 | 30003 | 400 |
| 请求头"OK_ACCESS_PASSPHRASE"不能为空 | 30004 | 400 |
| 无效的OK_ACCESS_TIMESTAMP | 30005 | 400 |
| 无效的OK_ACCESS_KEY | 30006 | 400 |
| 无效的Content_Type，请使用"application/json"格式 | 30007 | 400 |
| 请求时间戳过期 | 30008 | 400 |
| 系统错误 | 30009 | 500 |
| api 校验失败 | 30010 | 401 |
| 无效的ip | 30011 | 400 |
| 无效的授权 | 30012 | 401 |
| 无效的sign | 30013 | 401 |
| 请求太频繁 | 30014 | 429 |
| 请求头"OK_ACCESS_PASSPHRASE"错误 | 30015 | 400 |
| 您使用的是v1的apiKey，请调用v1接口。若您希望调用v3接口，请注册v3的apiKey。 | 30016 | 400 |
| apikey所属broker ID不匹配 | 30017 | 400 |
| apikey所属域名不匹配 | 30018 | 400 |
| 接口已下线或无法使用 | 30019 | 400 |
| body 不能为空 | 30020 | 400 |
| 非法的json数据 | 30021 | 400 |
| Api已被冻结，请联系客服处理 | 30022 | 401 |
| {0}参数不能为空 必填参数不能为空（各个业务接口返回各个接口的参数） | 30023 | 400 |
| {0}参数值填写错误（各个业务接口返回各个接口的参数） | 30024 | 400 |
| {0}参数类型错误（各个业务接口返回各个接口的参数） | 30025 | 400 |
| 用户请求频率过快，超过该接口允许的限额（调用时超过频率限制） | 30026 | 429 |
| 登录失败（操作了别人的订单） | 30027 | 401 |
| 非本人操作（Userid错误等） | 30028 | 400 |
| 用户被冻结 | 30029 | 400 |
| 请求接口失败，请您重试（请求接口失败，请您重试） | 30030 | 400 |
| 币种不存在 | 30031 | 400 |
| 币对不存在 | 30032 | 400 |
| 券商域名不存在（验证apikey所属交易所，为空，报这个错误） | 30033 | 400 |
| 券商ID不存在（验证apikey所属交易所ID，为空，报这个错误） | 30034 | 400 |
| 该网站暂不支持交易（该交易所请求，交易时，如果该交易已关闭，则提示报这个错误） | 30035 | 400 |
| 查询接口时，没有相应数据可以返回（各个接口返回各个接口的内容） | 30036 | 400 |
| 接口已下线或无法使用 | 30037 | 400 |
| 撮合引擎正在升级，请大约1分钟后尝试 | 30038 | 400 |
| 错误提示 | 错误码 | http状态码 |
|---|---|---|
| 提现冻结（提现接口，账户被冻结） | 34001 | 400 |
| 请先添加提现地址（提现接口，地址未添加） | 34002 | 400 |
| 该币种暂不支持提现至XX，敬请谅解（提现接口，地址不正确） | 34003 | 400 |
| 提现手续费小于最小值（提现接口，手续费输入有误） | 34004 | 400 |
| 提现手续费大于最大值（提现接口，提现手续费输入有误） | 34005 | 400 |
| 提现金额小于最小提现金额（最小提现金额提现接口，提现金额输入有误） | 34006 | 400 |
| 提现金额大于单笔提现最大金额（单笔提现最大金额提现接口，提现金额输入有误） | 34007 | 400 |
| 您的余额不足（划转和提现接口，余额不足） | 34008 | 400 |
| 今日提现金额累计超过每日限额（提现接口，提现金额超限） | 34009 | 400 |
| 转账金额必须大于零（划转接口，金额输入不正确） | 34010 | 400 |
| 不符合条件（划转提现接口，不符合条件，如kyc等级不够） | 34011 | 400 |
| NEO最小提现数量为1，且提现数量必须为整数（提现接口，某些币特殊限制） | 34012 | 400 |
| 需要传instrument ID（划转接口，转入或转出是币币杠杆时instrument ID未传） | 34013 | 400 |
| 划转受限（划转接口，划转资金受限） | 34014 | 400 |
| 子账户不存在（划转接口，转入或转出是子账户时，子账户不存在） | 34015 | 400 |
| 划转冻结（划转接口，源或目的不允许划转） | 34016 | 400 |
| 账户冻结（划转和提现接口，源或目的不允许划转） | 34017 | 400 |
| 交易密码错误（交易密码错误） | 34018 | 400 |
| 您需要绑定邮箱后，才能提现（提现接口，需要先绑定邮箱） | 34019 | 400 |
| 您需设置资金密码后，才能提现（提现接口，需要先设置资金密码） | 34020 | 400 |
| 不是认证地址（提现接口，不是认证的地址） | 34021 | 400 |
| 提现接口，子账号不允许提现 | 34022 | 400 |
| 请于转账前确认已开通合约交易 | 34023 | 400 |
| 请先开通余币宝服务 | 34025 | 400 |
| 划转过于频繁，请降低划转频率 | 34026 | 400 |
| 提现手续费应填写为提币数量的*% | 34027 | 400 |
| 参数不正确，请参考API文档 | 34036 | 400 |
| 获取子账户余额，account type 不支持 | 34037 | 400 |
| 您在法币区的交易异常，现已被限制划转功能，请您联系在线客服以解除限制 | 34038 | 400 |
| 您在法币区的交易异常，现已被限制划转功能，请您在网页或APP进行法币划转操作以完成身份验证 | 34039 | 400 |
| 错误提示 | 错误码 | http状态码 |
|---|---|---|
| 您尚未开通此币种对应杠杆业务（没有开通该币种杠杆业务时调接口会报错） | 33001 | 400 |
| 您的此币种对应杠杆账号已被冻结（杠杆账户被冻结） | 33002 | 400 |
| 没有借款余额（没有足够的余额进行借币） | 33003 | 400 |
| 借币数量不能小于最小借币数（借币时借币的数量） | 33004 | 400 |
| 还款金额不能小于等于0（还款金额不对） | 33005 | 400 |
| 没有该借币订单（还币或者查询的时候没有借币订单会报此错误） | 33006 | 400 |
| 不存在该状态 | 33007 | 400 |
| 借款数量超出可借数量（如保证金充足，可调整杠杆倍数以提高可借数量） | 33008 | 400 |
| 用户ID为空 | 33009 | 400 |
| 价格发现第二阶段您不可撤单（集合竞价时候不可以撤单） | 33010 | 400 |
| 没有最新行情信息 | 33011 | 400 |
| 撤单失败 | 33012 | 400 |
| 下单失败 | 33013 | 400 |
| 订单不存在（重复撤单，订单号不对等） | 33014 | 400 |
| 批量操作超过最大数量限制（批量下单，批量撤单时候会出现） | 33015 | 400 |
| 该币对没有开通杠杆业务 | 33016 | 400 |
| 下单大于最大可用余额（下单余额不足） | 33017 | 400 |
| 该参数值填写错误，要填写小于1的数值 | 33018 | 400 |
| 暂不支持该请求（有些交易所不支持杠杆业务） | 33020 | 400 |
| 币与币对不匹配 | 33021 | 400 |
| 币对与订单不匹配 | 33022 | 400 |
| 价格发现期间您只可下市价单（集合竞价时只可以下市价单） | 33023 | 400 |
| 交易金额小于最小交易值 | 33024 | 400 |
| 没有基准币数量（下单时上币时候币对配置不全） | 33025 | 400 |
| 订单已完成交易（撤单时完成交易的订单不能撤单） | 33026 | 400 |
| 订单已撤销或者撤销中（撤单时已经撤销和撤销中的订单不能撤单） | 33027 | 400 |
| 交易价格小数位数超过限制 | 33028 | 400 |
| 交易数量小数位数超过限制 | 33029 | 400 |
| client_oid 或 order_id 至少填一个 | 33059 | 400 |
| client_oid 或 order_id 必须且只能填一个 | 33060 | 400 |
| 集合竞价开始后只能下限价单 | 33034 | 400 |
| 该委托类型无法进行撤单操作（fok ioc 订单无法撤销） | 33035 | 400 |
| 超过最大限制数量 | 33036 | 400 |
| 买单委托价格需小于等于触发价格的130% | 33037 | 400 |
| 卖单委托价格需大于等于触发价格的70% | 33038 | 400 |
| 回调幅度限制为0<x<=5% | 33039 | 400 |
| 买单激活价格需小于最新成交价格 | 33040 | 400 |
| 卖单激活价格需大于最新成交价格 | 33041 | 400 |
| 委托深度限制为0<x<=1% | 33042 | 400 |
| 委托总数需要大于0 | 33043 | 400 |
| 单笔均值 委托总数 1/1000 <=x<=委托总数 | 33044 | 400 |
| 价格不能为0 包括：触发价格，委托价格，激活价格，价格限制 | 33045 | 400 |
| 扫单范围应该为 0<x<=1% | 33046 | 400 |
| 扫单比例应该为0<x<=100% | 33047 | 400 |
| 单笔上限：委托总数/1000<x<=委托总数 | 33048 | 400 |
| 委托总量应为 X>0 | 33049 | 400 |
| 委托间隔应该为 5<= x<=120s | 33050 | 400 |
| 撤销数量不能超过限制：止盈止损和跟踪委托不超过10单，冰山委托和时间加权委托不超过6单 | 33051 | 400 |
| 两个参数必须填一个 | 33059 | 400 |
| 两个参数只能填一个 | 33060 | 400 |
| 市价委托单笔价值不能超过10万 USD | 33061 | 400 |
| 杠杆倍数过高，借币仓位已超过该杠杆倍数的最大仓位，请重新调整杠杆倍数 | 33062 | 400 |
| 杠杆倍数过低，账户中保证金不足，请重新调整杠杆倍数 | 33063 | 400 |
| 杠杆倍数设置不能小于2，请重新调整杠杆倍数 | 33064 | 400 |
| 杠杆倍数超过最大杠杆倍数，请重新调整杠杆倍数 | 33065 | 400 |
| 错误提示 | 错误码 | http状态码 |
|---|---|---|
| 合约账户被冻结（当用户被强平后再下单时） | 32001 | 400 |
| 用户合约账户不存在（当用户只是注册了账号没有开通合约） | 32002 | 400 |
| 撤单中，请耐心等待（当用户反复撤单时，或当交割或结算时） | 32003 | 400 |
| 您当前没有未成交的订单（用户撤销未成交订单时） | 32004 | 400 |
| 超过最大下单量（当用户下单量超过规定数量会出现该异常） | 32005 | 400 |
| 委托价格或触发价格超过100万美元（下单当用户委托价格或触发价格超过100万美元） | 32006 | 400 |
| 合约相同方向只支持一个杠杆，当用户有10倍杠杆的持仓，在开20倍的时候等 | 32007 | 400 |
| 当前最多可开仓位（全仓）， 当用户开仓(全仓)的时候大于最多可开仓位 | 32008 | 400 |
| 当前最多可开仓位（逐仓），当用户开仓(逐仓)的时候大于最多可开仓位 | 32009 | 400 |
| 当前有持仓，无法设置杠杆 | 32010 | 400 |
| 虚拟合约状态错误，使用了过期的合约 | 32011 | 400 |
| 合约撤单失败，系统异常时，撤单失败 | 32012 | 400 |
| 币种类型为空 | 32013 | 400 |
| 您的平仓张数大于该仓位的可平张数 | 32014 | 400 |
| 开仓前保证金率低，开仓的是保证金率低于100% | 32015 | 400 |
| 开仓后保证金率低，开仓后的是保证金率低于100% | 32016 | 400 |
| 暂无对手价 | 32017 | 400 |
| 下单数量不足1张，请重新选择 | 32018 | 400 |
| 下单价格高于前一分钟的103%或低于97% | 32019 | 400 |
| 价格不在限价范围内 | 32020 | 400 |
| 杠杆比率错误，设置杆杆的时候不是设置的10倍或者20倍 | 32021 | 400 |
| 根据相关法律，您所在的国家或地区不能使用该功能，有的地区不能开合约 | 32022 | 400 |
| 账户存在借款 | 32023 | 400 |
| 合约交割中，无法下单 | 32024 | 400 |
| 合约清算中，无法下单，清算的时候无法下单 | 32025 | 400 |
| 您的账户已被限制开仓操作，禁止开仓 | 32026 | 400 |
| 撤单数量超过20 | 32027 | 400 |
| 用户被强平冻结 | 32028 | 400 |
| client_oid 或order_id只能传一个 | 32029 | 400 |
| 该委托类型无法进行撤单操作 | 32030 | 400 |
| client_oid 或者 order_id是必要的参数 | 32031 | 400 |
| 用户不存在 | 32038 | 400 |
| 用户存在挂单或持仓 | 32040 | 400 |
| 当前仓位不存在 | 32041 | 400 |
| 超过保证金最大/最小限额 | 32042 | 400 |
| 账户模式不正确 | 32043 | 400 |
| 下单后保证金率小于对应档位要求的最低保证金率 | 32044 | 400 |
| 委托数量超过100万 | 32045 | 400 |
| 每个用户最多可同时持有10笔未成交的止盈止损 | 32046 | 400 |
| 系统错误（当合约暂停或者极端情况会出现） | 32047 | 400 |
| 跟踪委托回调幅度错误 | 32048 | 400 |
| 每个用户最多可同时持有10笔未成交的跟踪委托 | 32049 | 400 |
| 回调幅度错误 | 32050 | 400 |
| 冰山委托深度错误 | 32051 | 400 |
| 委托数量超过10万 | 32052 | 400 |
| 每个用户最多可同时持有6笔未成交的冰山委托 | 32053 | 400 |
| 禁止开仓 | 32054 | 400 |
| 撤单失败 | 32055 | 400 |
| 冰山委托单笔均值() | 32056 | 400 |
| 委托价为0，暂无法进行市价全平操作 | 32057 | 400 |
| 每个用户最多可同时持有6笔未成交的时间加权 | 32058 | 400 |
| 委托总数量需大于单笔上限 | 32059 | 400 |
| 下单类型错误 | 32060 | 400 |
| 时间加权单笔上限错误（时间加权单笔上线错误） | 32061 | 400 |
| 时间加权扫单范围出错 | 32062 | 400 |
| 时间加权扫单比例出错 | 32063 | 400 |
| 委托间隔错误，5-120s之间 | 32064 | 400 |
| 市价全平的数量大于阈值（BTC 最多为 999 张，其他合约未 9999 张） | 32065 | 400 |
| 当前存在挂单，请撤销所有挂单后进行杠杆倍数修改 | 32066 | 400 |
| 调整后，账户权益<所需保证金，请重新调整杠杆倍数 | 32067 | 400 |
| 调整后本仓位保证金不足开仓所需保证金，请重新调整杠杆倍数或追加保证金后调整 | 32068 | 400 |
| 杠杆倍数过低，账户中没有足够的可用保证金可以追加（请重新调整杠杆倍数） | 32069 | 400 |
| 用户有持仓或者挂单（取消持仓或挂单） | 32070 | 400 |
| 您的当前强平模型不支持此操作 | 32071 | 400 |
| 您下单后仓位总张数所处档位的最高可用杠杆为{0}（请修改杠杆后重新下单） | 32072 | 400 |
| 当前币种不支持此操作 | 32073 | 400 |
| 您当前持仓、开仓挂单及本次下单张数已超过该币种最大限制可开张数 | 32074 | 400 |
| 账户风险率过高 | 32075 | 400 |
| 市价全平需先进行撤销平仓挂单操作（市价全平需先进行撤销平仓挂单操作） | 32076 | 400 |
| 您该币种合约账户保证金不足，已触发强制平仓 | 32077 | 400 |
| 您在该币种下存在挂单，请撤销所有挂单后切换 | 32078 | 400 |
| 当前仓位风险过高，请增加保证金或减少仓位后切换 | 32079 | 400 |
| 交割结算后30分钟内不能转出 | 32080 | 400 |
| 下单张数需要是%%的整数倍，请重新下单。 | 32083 | 400 |
| 市价单价格超过限价 | 32086 | 400 |
| 市价单下单数量超出最大值 | 32087 | 400 |
| 订单类型填写错误 | 32088 | 400 |
| 市价委托时不必填委托价格 | 32089 | 400 |
| 错误提示 | 错误码 | http状态码 |
|---|---|---|
| 系统错误， 一般是路径参数有误 | 1 | 400 |
| 合约不存在，用户调用不存在的合约时 | 35001 | 400 |
| 合约正在结算时 | 35002 | 400 |
| 合约暂停 | 35003 | 400 |
| 合约待资金结算 | 35004 | 400 |
| 用户不存在，用户未开通合约时 | 35005 | 400 |
| 账户风险率过高，用户下单前后保证金率不足时 | 35008 | 400 |
| 平仓数量大于可平数量（用户下平仓单数量大于可平数量时） | 35010 | 400 |
| 下单数量错误（用户下单数量不足1张时） | 35012 | 400 |
| 下单价格不在限价范围（用户下单价格不在限价范围里时） | 35014 | 400 |
| 杠杆倍数超过允许范围（用户调整的杠杆不在范围内时） | 35015 | 400 |
| 用户存在挂单（用户修改杠杆时） | 35017 | 400 |
| 下单数量超过最大允许的数量（用户下单数量超过设置的最大值时） | 35019 | 400 |
| 下单价格超过最大允许的价格（用户下单价格超过设置的最大值时） | 35020 | 400 |
| 下单数量超过用户当前档位（用户下单数量超过当前档位的最大值时） | 35021 | 400 |
| 合约状态错误（合约处于暂停或关闭状态时） | 35022 | 400 |
| 该用户合约未初始化 | 35024 | 400 |
| 用户账户余额为空 | 35025 | 400 |
| 用户合约配置未初始化 | 35026 | 400 |
| 订单不存在 | 35029 | 400 |
| 批量下单时，超过最大下单数量 | 35030 | 400 |
| 批量撤单时，超过最大撤单数量 | 35031 | 400 |
| 用户状态无效 | 35032 | 400 |
| 缓存中无最新成交价 | 35037 | 400 |
| 开仓张数大于可开张数 | 35039 | 400 |
| 无效的order type，当以对手价下单时，order_type只能选择0:普通委托 | 35040 | 400 |
| 订单已完成，无法撤单 | 35044 | |
| 账户余额是负数 | 35046 | 400 |
| 账户余额不足 | 35047 | 400 |
| 用户合约正在强平冻结 | 35048 | 400 |
| 订单类型不合适 | 35049 | 400 |
| 档位配置为空 | 35050 | 400 |
| 全仓保证金不足 | 35052 | 400 |
| 账户风险过高 | 35053 | 400 |
| 账户余额不足 | 35055 | 400 |
| 无最新成交 | 35057 | 400 |
| 无限价 | 35058 | 400 |
| 必传参数不能为空 | 30023 | 400 |
| 参数错误 | 30024 | 400 |
| 两个参数必须填一个（order id和client id 必须填一个） | 35059 | 400 |
| 两个参数只能填一个（order id和client id 只能填一个） | 35060 | 400 |
| instrument_id 不正确 | 35061 | 400 |
| match_price 不正确 | 35062 | 400 |
| order_size 不正确 | 35063 | 400 |
| instrument_id 不正确 | 35064 | 400 |
| 结算后30分钟内不能转出 | 40029 | 400 |
| 委托间隔错误 | 35066 | 400 |
| 时间加权扫单比例错误 | 35067 | 400 |
| 时间加权扫单范围错误 | 35068 | 400 |
| 时间加权单笔上限错误 | 35069 | 400 |
| 策略委托类型错误 | 35070 | 400 |
| 委托总数量需大于单笔上限 | 35071 | 400 |
| 每个用户最多可同时持有6笔未成交的时间加权单 | 35072 | 400 |
| 委托价为0，暂无法进行市价全平操作 | 35073 | 400 |
| 冰山委托单笔均值错误 | 35074 | 400 |
| 撤单失败 | 35075 | 400 |
| LTC20倍杠杆、禁止开仓 | 35076 | 400 |
| 每个用户最多可同时持有6笔未成交的冰山委托 | 35077 | 400 |
| 委托数量超过10万 | 35078 | 400 |
| 冰山委托深度错误 | 35079 | 400 |
| 回调幅度错误 | 35080 | 400 |
| 跟踪委托回调幅度错误 | 35081 | 400 |
| 您当前持仓、开仓挂单及本次下单张数已超过该币种最大限制可开张数 | 35082 | 400 |
| 每个用户最多可同时持有10笔未成交的止盈止损单 | 35083 | 400 |
| 委托数量超过100万 | 35084 | 400 |
| 委托数量不在正确范围内 | 35085 | 400 |
| 价格超过100万 | 35086 | 400 |
| 价格超过100万 | 35087 | 400 |
| 单笔均值错误 | 35088 | 400 |
| 价格超过100万 | 35089 | 400 |
| 没有可以撤的止盈止损单 | 35090 | 400 |
| 没有可以撤的跟踪委托单 | 35091 | 400 |
| 没有可以撤的冰山委托单 | 35092 | 400 |
| 没有可以撤的时间加权委托单 | 35093 | 400 |
| 止盈止损单最新成交价错误 | 35094 | 400 |
| 合约名非法 | 35095 | 400 |
| 策略委托订单状态错误 | 35096 | 400 |
| 订单状态和订单id不能同时存在 | 35097 | 400 |
| 订单状态或订单id必须存在一个 | 35098 | 400 |
| 策略委托订单id错误 | 35099 | 400 |
| 市价全平操作过于频繁 | 35102 | 400 |
| 持仓量超过市价全平最大限制 | 35103 | 400 |
| 市价委托不支持指定价格 | 35104 | 400 |
| 市价委托单笔数量不能超过最大限制 | 35105 | 400 |
| 订单状态或订单id必须存在一个 | 35106 | 400 |
| 市价止盈止损单笔委托数量不能超过最大限制 | 35107 | 400 |
| 止盈止损市价单不能指定价格 | 35108 | 400 |
| 消息内容 | 错误码 | HTTP状态码 | 场景 |
|---|---|---|---|
| Invalid underlying index. | 36001 | 400 | 指数不存在 |
| Instrument does not exist. | 36002 | 400 | 合约不存在 |
| Instrument status is invalid. | 36005 | 400 | 合约状态无效 |
| Account does not exist. | 36101 | 400 | 用户不存在 |
| Account status is invalid. | 36102 | 400 | 用户状态无效 |
| Account is suspended due to ongoing liquidation. | 36103 | 400 | 用户处于爆仓冻结 |
| Account is not enabled for options trading. | 36104 | 400 | 用户未开通期权交易权限 |
| Please enable the account for option contract. | 36105 | 400 | 请先开通期权合约账户 |
| Funds cannot be transferred in or out, as account is suspended. | 36106 | 400 | |
| 账户被冻结，暂无法转入或者转出 | |||
| Funds cannot be transferred out within 30 minutes after option exercising or | |||
| settlement. | 36107 | 400 | 行权或结算后30分钟内不能从合约转出 |
| Funds cannot be transferred in or out, as equity of the account is less than | |||
| zero. | 36108 | 400 | 账户权益小于0，暂无法转入或转出 |
| Funds cannot be transferred in or out during option exercising or settlement. | |||
| 36109 | 400 | 行权或结算中，暂无法转入或转出 | |
| New order function is blocked. | 36201 | 400 | 下单功能被冻结 |
| Account does not have permission to short option. | 36202 | 400 | 用户没有期权卖方权限 |
| Invalid format for client_oid. | 36203 | 400 | client_order_id 格式错误 |
| Invalid format for request_id. | 36204 | 400 | request_id 格式错误 |
| Instrument id does not match underlying index. | 36205 | 400 | 合约ID不匹配指数 |
| Order_id and client_oid can not be used at the same time. | 36206 | 400 | |
| orderId or client_order_id 只能有一个 | |||
| Either order price or fartouch price must be present. | 36207 | 400 | |
| 对手价格和下单价格不能同时为空 | |||
| Either order price or size must be present. | 36208 | 400 | 价格和数量不能同时为空 |
| Either order_id or client_oid must be present. | 36209 | 400 | |
| order_id和client_oid不能同时为空 | |||
| Either order_ids or client_oids must be present. | 36210 | 400 | |
| order_ids和client_oids不能同时为空 | |||
| Exceeding max batch size for order submission. | 36211 | 400 | 超过最大下单数量 |
| Exceeding max batch size for oder cancellation. | 36212 | 400 | 超过最大修改订单数量 |
| Exceeding max batch size for order amendment. | 36213 | 400 | 超过最大撤单数量 |
| Instrument does not have valid bid/ask quote. | 36214 | 400 | 订单深度中无买一卖一价 |
| Order does not exist. | 36216 | 400 | 订单不存在 |
| Order submission failed. | 36217 | 400 | 订单下单失败 |
| Order cancellation failed. | 36218 | 400 | 订单撤销失败 |
| Order amendment failed. | 36219 | 400 | 订单修改失败 |
| Order is pending cancel. | 36220 | 400 | 订单正在撤单中 |
| Order qty is not valid multiple of lot size. | 36221 | 400 | 下单张数不是一手张数的倍数 |
| Order price is breaching highest buy limit. | 36222 | 400 | 买单高于最高买价 |
| Order price is breaching lowest sell limit. | 36223 | 400 | 卖单低于最低卖价 |
| Exceeding max order size. | 36224 | 400 | 超出单笔最大挂单张数 |
| Exceeding max open order count for instrument. | 36225 | 400 | 超出合约最大挂单单数 |
| Exceeding max open order count for underlying. | 36226 | 400 | 超出标的最大挂单单数 |
| Exceeding max open size across all orders for underlying | 36227 | 400 | |
| 超出标的最大挂单张数 | |||
| Exceeding max available qty for instrument. | 36228 | 400 | 超出合约最大可开张数 |
| Exceeding max available qty for underlying. | 36229 | 400 | 超出标的最大可开张数 |
| Exceeding max position limit for underlying. | 36230 | 400 | 超出标的最大持仓张数 |
| Order submission failed due to insufficient margin. | 36238 | 400 | |
| 用户保证金不足，下单失败 | |||
| Order amendment failed due to insufficient margin. | 36239 | 400 | |
| 用户保证金不足，修改失败 |
以下是现货V3 WebscoketAPI，除了account有单独频道，其余频道数据对币币和杠杆用户通用。
WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信， 使得数据可以快速地双向传播。通过一次简单的握手就可以建立客户端和服务器连接， 服务器根据业务规则可以主动推送信息给客户端。其优点如下：
- 客户端和服务器进行数据传输时，请求头信息比较小，大概2个字节。
- 客户端和服务器皆可以主动地发送数据给对方。
- 不需要多次创建TCP请求和销毁，节约宽带和服务器的资源。
强 烈建议开发者使用WebSocket API获取市场行情和买卖深度等信息。
地址： wss://real.OKEx.com:8443/ws/v3
访问时需要科学上网
连接说明：
所有返回数据都进行了压缩，需要用户将接收到的数据进行解压。
连接上ws后30s未订阅或订阅后30s内服务器未向用户推送数据，系统会自动断开连接
请求格式：
{"op": "<value>", "args": ["<value1>","<value2>"]}
其中 op 的取值为 1--subscribe 订阅； 2-- unsubscribe 取消订阅 ；3--login 登录
args: 取值为频道名，可以定义一个或者多个频道
成功响应格式:
{"event": "<value>","channel":"<value>"}
{"table":"channel","data":"[{"<value1>","<value2>"}]"}
其中spot/depth 频道为了区分是首次全量和后续的增量返回格式将会是
{"table":"channel", "action":"<value>","data":"[{"<value1>","<value2>"}]"}
失败响应格式:
{"event":"error","message":"<error_message>","errorCode":"<errorCode>"}
用户可以选择订阅一个或者多个频道，多个频道总长度不能超过4096个字节
{"op": "subscribe", "args": ["<SubscriptionTopic>"]}
说明 ：op 的取值是 subscribe
args 数组内容为频道名称 ：<channelname>:<filter>
其中`channelname 是以 business/channel组成
现货推送业务business为spot， channel为此业务下每个具体的名称，如果channel的名字不能以一个字母区分将会以 " _ " 进行连接
例：
"spot/ticker:BTC-USDT"or "spot/margin_account:BTC-USDT"
filter 是可筛选数据，具体参考每个频道说明
示例：
send:
{"op": "subscribe", "args": ["spot/ticker:ETH-USDT","spot/candle60s:ETH-USDT"]}
response:
{"event":"subscribe","channel":"spot/ticker:ETH-USDT"}
{"event":"subscribe","channel":"spot/candle60s:ETH-USDT"}
{"table":"spot/ticker","data":[{"instrument_id":"ETH-USDT","last":"8.8","best_bid":"3","best_ask":"8.1","open_24h":"5.1","high_24h":"8.8","low_24h":"3",
"base_volume_24h":"13.77340909","quote_volume_24h":"78.49886361","timestamp":"2018-12-20T03:13:41.664Z"}]}
{"table":"spot/candle60s","data":[{"candle":["2018-12-20T06:18:00.000Z","8.8","8.8","8.8","8.8","0"],"instrument_id":"ETH-USDT"}]}
可以取消一个或者多个频道
{"op": "unsubscribe", "args": [<SubscriptionTopic>]}
例如：
请求：
{"op": "unsubscribe", "args": ["spot/ticker:BTC-USDT", "spot/candle60s:BTC-USDT"]}
返回：
{"event":"unsubscribe","channel":"spot/ticker:BTC-USDT"}
{"event":"unsubscribe","channel":"spot/candle60s:BTC-USDT"}
签名方式说明参考API概述里的验证部分
登录订阅格式：
{"op":"login","args":["<api_key>","<passphrase>","<timestamp>","<sign>"]}
响应：
{"event":"login","success":true}
例：
{"op":"login","args":["985d5b66-57ce-40fb-b714-afc0b9787083","123456","1538054050.975",
"7L+zFQ+CEgGu5rzCj4+BdV2/uUHGqddA9pI6ztsRRPs="]}
api_key :为用户申请的APIKEY
passphrase :为申请v3 api时所填写
timestamp :为时间戳 是 unix epoch时间，单位是秒， 时间戳30秒后会过期 推荐使用time endponit 查询API 服务器的时间，如果你的服务器时间和API 服务器时间有偏差的话
sign :为签名字符串，签名规则参照请求说明（API概述验证部分）
其 中timestamp示例:const timestamp = '' + Date.now() / 1000
其 中sign 示例 : sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp +'GET'+ '/users/self/verify', secret))
method 一律默认为'GET'。
requestPath 一律默认为'/users/self/verify'
如果登录失败会自动断开链接
连 接限制：1次/s
订 阅限制：每小时240次
连接上ws后如果一直没有数据返回，30s 后自动断开链接， 建议用户进行以下操作:
1，每次接收到消息后，用户设置一个定时器 ，定时N秒。
2，如果定时器被触发（N 秒内没有收到新消息），发送字符串 'ping'。
3，期待一个文字字符串'pong'作为回应。如果在 N秒内未收到，请发出错误或重新连接。
出现网络问题会自动断开连接
此功能可以帮助用户校验深度数据的准确性
每次推送depth频道的深度数据都有时间戳，且有checksum 校验（即checksum值）。 用户订阅depth 频道首次会接收到Example Response深度，后续推送的都是增量数据。checksum值为：每次增量更新合并后此Example Response深度的前25档bids和asks组成的字符串的crc32值， 用户可以拿自己的checksum的值和订阅的checksum值进行比较，如果不匹配可以重新订阅。
深度合并规则说明： 首次发送Example Response深度数据，后续每次发送增量的数据，拿增量去遍历Example Response中的asks和bids的price ,如果发现有相同价格 则看数量，数量为0删除此深度，数量有变化则替换此数据； 无相同价格则按照顺序排序。
计算说明: checksum的值为有符号整型(32位)
checksum的字符串都是以冒号连接的ask和bid中的price和数量，例如：
例子1：bid和ask成对档的情况下，要校验的字符串为：bid:ask:bid:ask:...
"data": [{
"instrument_id": "BTC-USDT",
"asks": [["3366.8", "9", 10],[ "3368","8",3]],
"bids": [
["3366.1", "7", 0],[ "3366","6",3 ]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": -1881014294
}]
该例子对应的checksum字符串为：3366.1:7:3366.8:9:3366:6:3368:8
例子2：bid和ask不成对档的情况 ，要校验的字符串为：bid:ask:ask:ask:...
"data": [{
"instrument_id": "BTC-USDT",
"asks": [["3366.8", "9", 10],[ "3368","8",3],[ "3372","8",3 ]],
"bids": [
["3366.1", "7", 0]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": 831078360
}]
此例子对应的checksum String 将会是 3366.1:7:3366.8:9:3368:8:3372:8
depth 频道用户收到推送数据为：
首次Example Response
{
"table": "spot/depth",
"action": "partial",
"data": [{
"instrument_id": "ETH-USDT",
"asks": [
["8.8", "96.99999966", 1],
["9", "39", 3],
["9.5", "100", 1],
["12", "12", 1],
["95", "0.42973686", 3],
["11111", "1003.99999795", 1]
],
"bids": [
["5", "7", 4],
["3", "5", 3],
["2.5", "100", 2],
["1.5", "100", 1],
["1.1", "100", 1],
["1", "1004.9998", 1]
],
"timestamp": "2018-12-18T07:27:13.655Z",
"checksum": 468410539
}]
}
增量：
{
"table": "spot/depth",
"action": "update",
"data": [{
"instrument_id": "BTC-USDT",
"asks": [],
"bids": [
["3983", "789", 0]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": -1200119424
}]
}
无需登录的频道包括：行情频道，K线频道，交易数据频道，资金费率频道，限价范围频道，深度数据频道，标记价格频道
需登录的频道包括：用户账户频道，用户交易频道，用户持仓频道
无需登录的频道名称如下：
spot/ticker // 行情数据频道
spot/trade // 交易信息频道
spot/depth //深度数据频道，首次Example Response，后续增量
spot/depth5 //深度数据频道，每次返回前5档
需登录的频道如下
spot/account //用户币币账户信息频道
spot/margin_account //用户杠杆账户信息频道
spot/order //用户交易数据频道
获取币币账户信息，需用用户登录
{"op": "subscribe", "args": ["spot/account:BTC"]}
其中spot/account为频道名，BTC为currency
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| currency | String | 币种 |
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易或资金划转的数量 |
{
"table":"spot/account",
"data":[
{
"balance":"2.215374581132125",
"available":"1.632774581132125",
"currency":"USDT",
"id":"",
"hold":"0.5826"
}
]
}
获取用户杠杆账户信息：
{"op": "subscribe", "args": ["spot/margin_account:ETH-USDT"]}
其中spot/margin_account为频道名，ETH-USDT为instrument_id
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| instrument_id | String | 杠杆币对名称 |
| balance | String | 余额 |
| hold | String | 冻结（不可用） |
| available | String | 可用于交易或资金划转的数量 |
| borrowed | String | 已借币（已借未还的部分） |
| lending_fee | String | 利息（未还的利息） |
| maint_margin_ratio | String | 维持保证金率 |
| tiers | String | 当前借币数量档位 |
| liquidation_price | String | 强平价 |
{
'table': 'spot/margin_account',
'data': [{
'currency:USDT': {
'available': '0.00000000930213',
'balance': '0.00000000930213',
'borrowed': '0',
'hold': '0',
'lending_fee': '0'
},
"liquidation_price":"4.6499",
'tiers': '1',
'maint_margin_ratio': '0.08',
'instrument_id': 'ETH-USDT',
'currency:ETH': {
'available': '0.0202516022462802',
'balance': '0.0202516022462802',
'borrowed': '0.01',
'hold': '0',
'lending_fee': '0.0000001666'
}
}]
}
用户委托策略频道
{"op": "subscribe", "args": ["spot/order_algo:LTC-USDT"]}
其中spot/order_algo为频道名，LTC-USDT为instrument_id
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_id | string | 委托ID |
| order_type | string | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权委托 |
||
| mode | String | 1、币币 2、杠杆 |
| size | string | 委托数量 |
| instrument_id | string | 币对名称 |
| side | String | buy or sell |
| timestamp | string | 委托时间 |
| status | string | 订单状态 |
1：待生效 |
||
2：已生效 |
||
3：已撤销 |
||
4：部分生效 |
||
5：暂停生效 |
||
6：委托失败 |
||
【只有冰山和加权有4、5状态】 |
||
| cancel_code | String | 0:委托超时撤单 1:用户主动撤单 2:余额不足撤单 |
止盈止损
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_price | string | 委托价格 |
| trigger_price | string | 触发价格 |
| stop_type | string | 1：大于或等于触发价格 2：小于或等于触发价格 |
| algo_type | String | 1:限价 2:市场价； |
跟踪委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| callback_rate | string | 回调幅度 |
| trigger_price | string | 激活价格 |
冰山委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_variance | string | 委托深度 |
| avg_amount | string | 单笔均值 |
| price_limit | string | 价格限制 |
| deal_value | string | 已下单数量 |
时间加权委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| sweep_range | string | 扫单范围 |
| sweep_ratio | string | 扫单比例 |
| single_limit | string | 单笔上限 |
| price_limit | string | 价格限制 |
| time_interval | string | 委托间隔 |
| deal_value | string | 已下单数量 |
{
"table":"spot/order_algo",
"data":[
{
"algo_id":"456154",
"algo_price":"15",
"cancel_code":"",
"created_at":"2020-01-08T02:42:36.791Z",
"instrument_id":"ltc_usdt",
"mode":"1",
"order_id":"0",
"order_type":"1",
"side":"buy",
"size":"3",
"status":"1",
"stop_type":"2",
"timestamp":"2020-01-08T02:42:36.796Z",
"trigger_price":"20"
}
]
}
获取用户交易数据，需用用户登录
{"op": "subscribe", "args": ["spot/order:LTC-USDT"]}
其中spot/order为频道名，LTC-USDT为instrument_id
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| order_id | String | 订单ID |
| client_oid | String | 由用户设置的订单ID |
| price | String | 委托价格 |
| size | String | 委托数量（交易货币数量） |
| notional | String | 买入金额，市价买入时返回 |
| instrument_id | String | 币对名称 |
| side | String | buy 或 sell |
| type | String | limit或market（默认是limit） |
| timestamp | String | 订单状态更新时间 |
| filled_size | String | 已成交数量 |
| filled_notional | String | 已成交金额 |
| margin_trading | String | 1：币币交易订单 |
2：杠杆交易订单 |
||
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
| last_fill_px | String | 最新成交价格（如果没有，推0） |
| last_fill_id | String | 成交ID。和交易频道trade_id对应（如果没有，推0） |
| last_fill_qty | String | 最新成交数量（如果没有，推0） |
| last_fill_time | String | 最新成交时间（如果没有，推1970-01-01T00:00:00.000Z） |
| state | String | -2:失败 |
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
||
| created_at | String | 订单创建时间 |
| last_fill_id | String | 成交ID。和交易频道trade_id对应（如果没有，推0） |
status为state旧版参数，会短期兼容，建议尽早切换state。
{
"table":"spot/order",
"data":[
{
"client_oid":"",
"filled_notional":"0",
"filled_size":"0",
"instrument_id":"ETC-USDT",
"last_fill_px":"0",
"last_fill_qty":"0",
"last_fill_time":"1970-01-01T00:00:00.000Z",
"margin_trading":"1",
"notional":"",
"order_id":"3576398568830976",
"order_type":"0",
"price":"5.826",
"side":"buy",
"size":"0.1",
"state":"0",
"status":"open",
"timestamp":"2019-09-24T06:45:11.394Z",
"type":"limit",
"created_at":"2019-09-24T06:45:11.394Z"
}
]
}
获取现货最新成交价、买一价、卖一价和24交易量，每100ms推送一次数据。
{"op": "subscribe", "args": ["spot/ticker:ETH-USDT"]}
其中spot/ticker为频道名，ETH-USDT为instrument_id
| |
---|---|---
参 数名 | 参 数类型 | 描 述
instrument_id | String | 币对名称
last | String | 最新成交价
last_qty | String | 最新成交的数量
best_ask | String | 卖一价
best_ask_size | String | 卖一价对应的量
best_bid | String | 买一价
best_bid_size | String | 买一价对应的数量
open_24h | String | 24小时开盘价
high_24h | String | 24小时最高价
low_24h | String | 24小时最低价
base_volume_24h | String | 24小时成交量，按交易货币统计
quote_volume_24h | String | 24小时成交量，按计价货币统计
timestamp | String | 系统时间戳
{
"table":"spot/ticker",
"data":[
{
"instrument_id":"ETH-USDT",
"last":"146.24",
"last_qty":"0.082483",
"best_bid":"146.24",
"best_bid_size":"0.006822",
"best_ask":"146.25",
"best_ask_size":"80.541709",
"open_24h":"147.17",
"high_24h":"147.48",
"low_24h":"143.88",
"base_volume_24h":"117387.58",
"quote_volume_24h":"17159427.21",
"timestamp":"2019-12-11T02:31:40.436Z"
}
]
}
获取现货的K线数据，每500ms推送一次数据。
频道列表：
spot/candle60s // 1分钟k线数据频道
spot/candle60s // 1分钟k线数据频道
spot/candle180s // 3分钟k线数据频道
spot/candle300s // 5分钟k线数据频道
spot/candle900s // 15分钟k线数据频道
spot/candle1800s // 30分钟k线数据频道
spot/candle3600s // 1小时k线数据频道
spot/candle7200s // 2小时k线数据频道
spot/candle14400s // 4小时k线数据频道
spot/candle21600s // 6小时k线数据频道
spot/candle43200s // 12小时k线数据频道
spot/candle86400s // 1day k线数据频道
spot/candle604800s // 1week k线数据频道
{"op": "subscribe", "args": ["spot/candle60s:ETH-USDT"]}
其中spot/candle60s为频道名，ETH-USDT为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| timestamp | String | 开始时间 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量 |
| instrument_id | String | 币对 |
{
"table":"spot/candle60s",
"data":[
{
"candle":[
"2019-04-16T10:49:00.000Z",
"162.03",
"162.04",
"161.96",
"161.98",
"336.452694"
],
"instrument_id":"ETH-USDT"
}
]
}
获取最近的成交数据，每300ms推送一次数据。
{"op": "subscribe", "args": ["spot/trade:ETH-USDT"]}
其中spot/trade为频道名，ETH-USDT为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交id |
| price | String | 成交价格 |
| size | String | 成交数量 |
| side | String | 成交方向（buy 或 sell） |
| timestamp | String | 成交时间 |
| instrument_id | String | 币对 |
{
"table": "spot/trade",
"data": [{
"instrument_id": "ETH-USDT",
"price": "162.12",
"side": "buy",
"size": "11.085",
"timestamp": "2019-05-06T06:51:24.389Z",
"trade_id": "1210447366"
}]
}
每次返回前五档的深度数据，此数据为每100毫秒的快照数据，即每隔100毫秒，快照当前时刻市场订单簿的5档深度数据并推送。
{"op": "subscribe", "args": ["spot/depth5:ETH-USDT"]}
其中spot/depth5为频道名，ETH-USDT为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 时间戳 |
| instrument_id | String | 币对 |
asks和bids值数组举例说明： ["411.8","10","8"] 411.8为深度价格，10为此价格数量，8为此深度由几笔订单组成。
{
"table":"spot/depth5",
"data":[
{
"asks":[
[
"161.96",
"7.37567",
3
],
[
"161.97",
"1.308",
1
],
[
"161.98",
"2.463509",
1
],
[
"161.99",
"5.185",
2
],
[
"162",
"29.184592",
5
]
],
"bids":[
[
"161.94",
"4.552355",
1
],
[
"161.91",
"7.949",
3
],
[
"161.9",
"2.213",
1
],
[
"161.89",
"11.999998",
1
],
[
"161.88",
"6.585142",
3
]
],
"instrument_id":"ETH-USDT",
"timestamp":"2019-04-16T11:03:03.712Z"
}
]
}
订阅后首次返回市场订单簿的400档深度数据并推送；然后每隔100毫秒，快照这个时间段内有更改的订单簿数据，并推送。
{"op": "subscribe", "args": ["spot/depth:ETH-USDT"]}
其中spot/depth为频道名，ETH-USDT为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 时间戳 |
| instrument_id | String | 币对 |
| checksum | String | 检验和 |
asks和bids值数组举例说明： ["411.8","10",8"] 411.8为深度价格，10为此价格数量，8为此深度由几笔订单组成。
首次Example Response
{
"table":"spot/depth",
"action":"partial",
"data":[
{
"instrument_id":"ETH-USDT",
"asks":[
[
"162.5",
"14.29884",
2
],
[
"162.51",
"2.084362",
1
],
...
[
"168.51",
"7.760755",
2
],
[
"168.57",
"0.02",
1
]
],
"bids":[
[
"162.49",
"1.556106",
3
],
[
"162.47",
"0.00913",
1
],
...
[
"155.15",
"70",
1
],
[
"155.13",
"3",
1
]
],
"timestamp":"2019-04-16T10:17:28.507Z",
"checksum":1141851215
}
]
}
增量：
{
"table":"spot/depth",
"action":"update",
"data":[
{
"instrument_id":"ETH-USDT",
"asks":[
[
"162.5",
"0",
0
],
[
"162.61",
"1.209",
2
],
[
"168.69",
"0.006",
1
],
[
"168.73",
"0.002082",
1
]
],
"bids":[
[
"162.49",
"1.512544",
2
],
[
"162.47",
"0.05333",
2
],
[
"162.46",
"14.608508",
3
],
[
"162.43",
"10.61874",
3
],
[
"162.41",
"27.303906",
2
],
[
"162.4",
"14.762929",
6
],
[
"162.39",
"11.045909",
1
],
[
"162.36",
"19.230907",
8
],
[
"162.31",
"3.927598",
4
],
[
"162.3",
"5.353085",
5
],
[
"162.29",
"6.569261",
12
],
[
"162.25",
"8.308575",
3
]
],
"timestamp":"2019-04-16T10:17:29.045Z",
"checksum":227291232
}
]
}
订阅后首次返回市场订单簿的400档深度数据并推送；后续只要订单簿深度有变化就推送有更改的数据。
{"op": "subscribe", "args": ["spot/depth_l2_tbt:BTC-USDT"]}
其中spot/depth_l2_tbt为频道名，BTC-USDT为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| asks | List | 卖方深度 |
| bids | List | 买方深度 |
| timestamp | String | 时间戳 |
| instrument_id | String | 币对 e.g BTC-USDT |
| checksum | String | 检验和 |
asks和bids值数组举例说明：
["8582.97","40","0","40"]
8582.97为深度价格，40为此价格的数量，0为此价格的现货杠杆强平数量，此数据暂未提供，均返回"0"，40为此价格的订单个数。
{
"table":"spot/depth_l2_tbt",
"action":"partial",
"data":[
{
"instrument_id":"BTC-USDT",
"asks":[
["9580.3","0.20939963","0","2"],
["9582.7","0.33242846","0","3"],
["9583.9","0.41760039","0","1"]
],
"bids":[
["9576.7","0.31658067","0","2"],
["9574.4","0.15659893","0","2"],
["9574.2","0.0105","0","1"]
],
"timestamp":"2020-02-06T03:35:42.492Z"
"checksum":-2144245240
}
]
}
以下是交割合约V3 WebscoketAPI
WebSocket是HTML5一种新的协议（Protocol）。它实现了客户端与服务器全双工通信， 使得数据可以快速地双向传播。通过一次简单的握手就可以建立客户端和服务器连接， 服务器根据业务规则可以主动推送信息给客户端。其优点如下：
- 客户端和服务器进行数据传输时，请求头信息比较小，大概2个字节。
- 客户端和服务器皆可以主动地发送数据给对方。
- 不需要多次创建TCP请求和销毁，节约宽带和服务器的资源。
强 烈建议开发者使用WebSocket API获取市场行情和买卖深度等信息。
地址： wss://real.okex.com:8443/ws/v3
访问时需要科学上网
连接说明：
所有返回数据都进行了压缩，需要用户将接收到的数据进行解压。
连接上ws后30s未订阅或订阅后30s内服务器未向用户推送数据，系统会自动断开连接
请求格式：
{"op": "<value>", "args": ["<value1>","<value2>"]}
其中 op 的取值为 1--subscribe 订阅； 2-- unsubscribe 取消订阅 ；3--login 登录
args: 取值为频道名，可以定义一个或者多个频道
成功响应格式:
{"event": "<value>","channel":"<value>"}
{"table":"channel","data":"[{"<value1>","<value2>"}]"}
其中futures/depth 频道为了区分是首次全量和后续的增量返回格式将会是
{"table":"channel", "action":"<value>","data":"[{"<value1>","<value2>"}]"}
失败响应格式:
{"event":"error","message":"<error_message>","errorCode":"<errorCode>"}
用户可以选择订阅一个或者多个频道，多个频道总长度不能超过4096个字节。
{"op": "subscribe", "args": ["<SubscriptionTopic>"]}
说明 ：op 的取值是 subscribe
args 数组内容为频道名称 ：<channelname>:<filter>
其中`channelname 是以 business/channel组成
交割推送业务business为futures， channel为此业务下每个具体的名称，如果channel的名字不能以一个字母区分将会以 " _ " 进行连接
例：
"futures/ticker:BTC-USD-170310"or "futures/price_range:BTC-USD-170310"
filter 是可筛选数据，具体参考每个频道说明
示例：
send:
{"op": "subscribe", "args": ["futures/ticker:BTC-USD-170310", "futures/candle60s:BTC-USD-170310"]}
response:
{"event":"subscribe","channel":"futures/ticker:BTC-USD-170310"}
{"event":"subscribe","channel":"futures/candle60s:BTC-USD-170310"}
{"table":"futures/ticker","data":[{"last":3916.9594,"best_bid":3916.508,"high_24h":3918.1759,
"low_24h":3916.508,"volume_24h":234,"best_ask":3916.9614,"instrument_id":"BTC-USD-170310","timestamp":"2018-12-20T02:33:01.448Z"}]}
{"table":"futures/candle60s","data":[{"candle":["2018-12-20T02:35:00.000Z","3916.9594",
"3916.9594","3916.9594","3916.9594","0","0.0"],"instrument_id":"BTC-USD-170310"}]}
可以取消一个或者多个频道
{"op": "unsubscribe", "args": [<SubscriptionTopic>]}
例如：
请求：
{"op": "unsubscribe", "args": ["futures/ticker:BTC-USD-170310", "futures/candle60s:BTC-USD-170310"]}
返回：
{"event":"unsubscribe","channel":"futures/ticker:BTC-USD-170310"}
{"event":"unsubscribe","channel":"futures/candle60s:BTC-USD-170310"}
签名方式说明参考API概述里的验证部分
登录订阅格式：
{"op":"login","args":["<api_key>","<passphrase>","<timestamp>","<sign>"]}
响应：
{"event":"login","success":true}
例：
{"op":"login","args":["985d5b66-57ce-40fb-b714-afc0b9787083","123456","1538054050.975",
"7L+zFQ+CEgGu5rzCj4+BdV2/uUHGqddA9pI6ztsRRPs="]}
api_key :为用户申请的APIKEY
passphrase :为申请v3 api时所填写
timestamp :为时间戳 是 unix epoch时间，单位是秒， 时间戳30秒后会过期 推荐使用time endponit 查询API 服务器的时间，如果你的服务器时间和API 服务器时间有偏差的话
sign :为签名字符串，签名规则参照请求说明（API概述验证部分）
其 中timestamp示例:const timestamp = '' + Date.now() / 1000
其 中sign 示例 : sign=CryptoJS.enc.Base64.Stringify(CryptoJS.HmacSHA256(timestamp +'GET'+ '/users/self/verify', secret))
method 一律默认为'GET'。
requestPath 一律默认为'/users/self/verify'
如果登录失败会自动断开链接
连 接限制：1次/s
订 阅限制：每小时240次
连接上ws后如果一直没有数据返回，30s 后自动断开链接， 建议用户进行以下操作:
1，每次接收到消息后，用户设置一个定时器 ，定时N秒。
2，如果定时器被触发（N 秒内没有收到新消息），发送字符串 'ping'。
3，期待一个文字字符串'pong'作为回应。如果在 N秒内未收到，请发出错误或重新连接。
出现网络问题会自动断开连接
此功能可以帮助用户校验深度数据的准确性
每次推送depth频道的深度数据都有时间戳，且有checksum 校验（即checksum值）。 用户订阅depth 频道首次会接收到400档深度，后续推送的都是增量数据。checksum值为：每次增量更新后此400档深度的前 25档 bids 和 asks组成的字符串的crc32值， 用户可以拿自己的checksum的值和订阅的checksum值进行比较，如果不匹配可以重新订阅。
深度合并规则说明： 首次发送400档深度数据，后续每次发送增量的数据。去遍历400档中的asks和bids的price ,如果发现有相同价格 则看数量，数量为0删除此深度，数量有变化则替换此数据； 无相同价格则按照顺序排序。
计算说明: checksum的值为有符号整型(32位)
checksum的字符串都是以冒号连接的ask和bid中的price和数量，例如：
例子1：bid和ask成对档的情况下，要校验的字符串为：bid:ask:bid:ask:...
"data": [{
"instrument_id": "BTC-USD-181228",
"asks": [[3366.8, 9, 10, 3],[ 3368,8,3,4 ]],
"bids": [
[3366.1, 7, 0, 3],[ 3366,6,3,4 ]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": -1881014294
}]
该例子对应的checksum字符串为：3366.1:7:3366.8:9:3366:6:3368:8
例子2：bid和ask不成对档的情况 ，要校验的字符串为：bid:ask:ask:ask:...
"data": [{
"instrument_id": BTC-USD-181228,
"asks": [[3366.8, 9, 10, 3],[ 3368,8,3,4 ],[ 3372,8,3,4 ]],
"bids": [
[3366.1, 7, 0, 3]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": 831078360
}]
此例子对应的checksum String 将会是 3366.1:7:3366.8:9:3368:8:3372:8
depth 频道用户收到推送数据为：
首次400档
{
"table": "futures/depth",
"action": "partial",
"data": [{
"instrument_id": "BTC-USD-181228",
"asks": [[3983, 888, 10, 3],....],
"bids": [
[3983, 789, 0, 3],....
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": 200119424
}]
}
后续更新：
{
"table": "futures/depth",
"action": "update",
"data": [{
"instrument_id": "BTC-USD-181228",
"asks": [],
"bids": [
[3983, 789, 0, 3]
],
"timestamp": "2018-12-04T09:38:36.300Z",
"checksum": -1200119424
}]
}
无需登录的频道包括：行情频道，K线频道，交易数据频道，资金费率频道，限价范围频道，深度数据频道，标记价格频道
需登录的频道包括：用户账户频道，用户交易频道，用户持仓频道
无需登录的频道名称如下：
futures/ticker // 行情数据频道
futures/candle60s // 1分钟k线数据频道
futures/trade // 交易信息频道
futures/estimated_price //获取预估交割价
futures/price_range //限价范围频道
futures/depth_l2_tbt //全量深度数据频道，首次全部深度数据，后续有更改的数据。
futures/depth //深度数据频道，首次Example Response，后续有更改的数据。
futures/depth5 //深度数据频道，每次返回前5档。
futures/mark_price// 标记价格频道
需登录的频道如下
futures/account //用户账户信息频道
futures/position //用户持仓信息频道
futures/order //用户交易数据频道
获取用户持仓信息，需用用户登录
{"op": "subscribe", "args": ["futures/position:BTC-USD-170317"]}
其中futures/position为频道名，BTC-USD-170317为instrument_id
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
逐仓:fixed |
||
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_margin | String | 多仓保证金 |
| long_liqui_price | String | 多仓强平价格 |
| long_pnl_ratio | String | 多仓盈亏比 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 结算基准价 |
| realised_pnl | String | 已实现盈余 |
| long_leverage | String | 多仓杠杆倍数 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_margin | String | 空仓保证金 |
| short_liqui_price | String | 空仓强平价格 |
| short_pnl_ratio | String | 空仓盈亏比 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 结算基准价 |
| short_leverage | String | 空仓杠杆倍数 |
| instrument_id | String | 合约ID，如BTC-USDT-180909,BTC-USDT-191227 |
| created_at | String | 创建时间 |
| updated_at | String | 更新时间 |
| short_margin_ratio | String | 空仓保证金率 |
| short_maint_margin_ratio | String | 空仓维持保证金率 |
| short_pnl | String | 空仓收益 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| short_open_outstanding | string | 空仓开仓冻结张数 |
| short_settled_pnl | String | 空仓已结算收益 |
| long_margin_ratio | String | 多仓保证金率 |
| long_maint_margin_ratio | String | 多仓维持保证金率 |
| long_pnl | String | 多仓收益 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_open_outstanding | string | 多仓开仓冻结张数 |
| long_settled_pnl | String | 多仓已结算收益 |
| last | String | 最新成交价 |
| timestamp | String | 账户数据更新时间 |
{
"table":"futures/position",
"data":[
{
"long_qty":"0",
"long_avail_qty":"0",
"long_margin":"0",
"long_liqui_price":"0",
"long_pnl_ratio":"0.36112873",
"long_avg_cost":"9840.02",
"long_settlement_price":"9840.02",
"realised_pnl":"0",
"short_qty":"0",
"short_avail_qty":"0",
"short_margin":"0",
"short_liqui_price":"0",
"short_pnl_ratio":"-0.33163704",
"short_avg_cost":"9870.15",
"short_settlement_price":"9870.15",
"instrument_id":"BTC-USD-190927",
"long_leverage":"10",
"short_leverage":"10",
"created_at":"2019-09-06T03:39:50.019Z",
"updated_at":"2019-09-20T10:32:56.003Z",
"timestamp":"2019-09-20T10:32:56.003Z",
"margin_mode":"fixed",
"short_margin_ratio":"10000.0",
"short_maint_margin_ratio":"0.005",
"short_pnl":"0.0",
"short_unrealised_pnl":"0.0",
"long_margin_ratio":"10000.0",
"long_maint_margin_ratio":"0.005",
"long_pnl":"0.0",
"long_unrealised_pnl":"0.0",
"long_open_outstanding":"2",
"short_open_outstanding":"0",
"long_settled_pnl":"0",
"short_settled_pnl":"0",
"last":"10206.46"
}
]
}
| 全仓参数名 | 参数类型 | 描述 |
|---|---|---|
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| liquidation_price | String | 预估强平价 |
| long_qty | String | 多仓数量 |
| long_avail_qty | String | 多仓可平仓数量 |
| long_avg_cost | String | 开仓平均价 |
| long_settlement_price | String | 结算基准价 |
| realised_pnl | String | 已实现盈余 |
| leverage | String | 杠杆倍数 |
| short_qty | String | 空仓数量 |
| short_avail_qty | String | 空仓可平仓数量 |
| short_avg_cost | String | 开仓平均价 |
| short_settlement_price | String | 结算基准价 |
| instrument_id | String | 合约ID，如BTC-USDT-180213 |
| created_at | String | 创建时间 |
| updated_at | String | 更新时间 |
| short_margin | String | 空仓保证金 |
| short_pnl | String | 空仓收益 |
| short_pnl_ratio | String | 空仓收益率 |
| short_unrealised_pnl | String | 空仓未实现盈亏 |
| long_margin | String | 多仓保证金 |
| long_pnl | String | 多仓收益 |
| long_pnl_ratio | String | 多仓收益率 |
| long_unrealised_pnl | String | 多仓未实现盈亏 |
| long_open_outstanding | string | 多仓开仓冻结张数 |
| short_open_outstanding | string | 空仓开仓冻结张数 |
| long_settled_pnl | String | 多仓已结算收益 |
| short_settled_pnl | String | 空仓已结算收益 |
| last | String | 最新成交价 |
| timestamp | String | 账户数据更新时间 |
{
"table":"futures/position",
"data":[
{
"long_qty":"0",
"long_avail_qty":"0",
"long_avg_cost":"10195.63",
"long_settlement_price":"10195.63",
"realised_pnl":"0",
"short_qty":"0",
"short_avail_qty":"0",
"short_avg_cost":"10868.07",
"short_settlement_price":"10868.07",
"liquidation_price":"0.0",
"instrument_id":"BTC-USD-190927",
"leverage":"10",
"created_at":"2019-09-06T03:39:50.019Z",
"updated_at":"2019-09-19T03:54:16.570Z",
"timestamp":"2019-09-19T03:54:16.570Z",
"margin_mode":"crossed",
"short_margin":"0.0",
"short_pnl":"0.0",
"short_pnl_ratio":"1.04333472",
"short_unrealised_pnl":"0.0",
"long_margin":"0.0",
"long_pnl":"0.0",
"long_pnl_ratio":"-0.359905739",
"long_unrealised_pnl":"0.0",
"long_open_outstanding":"2",
"short_open_outstanding":"0",
"long_settled_pnl":"0",
"short_settled_pnl":"0",
"last":"9840.19"
}
]
}
获取账户信息，需用用户登录
币本位保证金合约还是使用 目前的格式 示例：{"op": "subscribe", "args": ["futures/account:BTC"]}
USDT保证的合约，使用underlying 示例：{"op": "subscribe", "args": ["futures/account:BTC-USDT"]}
其中futures/account为频道名，BTC为币本位保证金合约账户
| 全 仓参数名 | 参 数类型 | 描 述 |
|---|---|---|
| currency | String | 账户余额币种，如：BTC,USDT |
| margin_mode | String | 账户类型 |
全仓：crossed |
||
| equity | String | 账户权益 |
| total_avail_balance | String | 账户余额 |
| margin | String | 已用保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| margin_ratio | String | 保证金率 |
| margin_frozen | String | 持仓已用保证金 |
| margin_for_unfilled | String | 挂单冻结保证金 |
| maint_margin_ratio | String | 维持保证金率 |
| liqui_mode | string | 强平模式：tier（梯度强平） |
| available | string | 可用保证金 |
| open_max | string | 最大可开张数 |
| can_withdraw | string | 可划转数量 |
| timestamp | string | 账户数据更新时间 |
| underlying | string | 标的指数，如：BTC-USD,BTC-USDT |
{
"table":"futures/account",
"data":[
{
"BTC":{
"available":"0.01",
"can_withdraw":"0.01",
"currency":"BTC",
"equity":"0.01",
"liqui_mode":"tier",
"maint_margin_ratio":"0.005",
"margin":"0",
"margin_for_unfilled":"0",
"margin_frozen":"0",
"margin_mode":"crossed",
"margin_ratio":"10000",
"open_max":"0",
"realized_pnl":"0",
"timestamp":"2019-11-01T03:34:15.896Z",
"total_avail_balance":"0.01",
"underlying":"BTC-USD",
"unrealized_pnl":"0"
}
}
]
}
| 逐仓参数名 | 参数类型 | 描述 |
|---|---|---|
| currency | String | 账户余额币种，如：BTC,USDT |
| margin_mode | String | 账户类型 |
逐仓：fixed |
||
| instrument_id | String | 合约ID，如BTC-USD-191227,BTC-USDT-191227 |
| fixed_balance | String | 逐仓账户余额 |
| available_qty | String | 逐仓可用余额 |
| margin_frozen | String | 冻结的保证金(成交以后仓位所需的) |
| margin_for_unfilled | String | 挂单冻结保证金 |
| realized_pnl | String | 已实现盈亏 |
| unrealized_pnl | String | 未实现盈亏 |
| equity | String | 账户权益（账户动态权益） |
| total_avail_balance | String | 账户余额（账户静态权益） |
| liqui_mode | string | 强平模式 |
tier（梯度强平） |
||
| long_open_max | string | 多仓最大可开张数 |
| short_open_max | string | 空仓最大可开张数 |
| can_withdraw | string | 可划转数量 |
| timestamp | String | 账户数据更新时间 |
{
"table":"futures/account",
"data":[
{
"BTC":{
"can_withdraw":"0.01",
"contracts":[
{
"available_qty":"0.01",
"fixed_balance":"0",
"instrument_id":"BTC-USD-191227",
"long_open_max":"18",
"margin_for_unfilled":"0",
"margin_frozen":"0",
"realized_pnl":"0",
"short_open_max":"9",
"timestamp":"2019-11-01T03:39:15.293Z",
"unrealized_pnl":"0"
}
],
"currency":"BTC",
"equity":"0.01",
"liqui_mode":"tier",
"margin_mode":"fixed",
"timestamp":"2019-11-01T03:39:15.298Z",
"total_avail_balance":"0.01"
}
}
]
}
获取用户交易数据，需用用户登录
{"op": "subscribe", "args": ["futures/order:BTC-USD-170317"]}
其中futures/order为频道名，BTC-USD-170317为instrument_id
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USDT-180213,BTC-USDT-191227 |
| client_oid | String | 由用户设置的订单ID |
| size | String | 委托数量 |
| timestamp | String | 订单状态变化时间 |
| filled_qty | String | 成交数量 |
| fee | String | 手续费 |
| order_id | String | 订单ID |
| price | String | 委托价格 |
| error_code | String | 错误码 |
| pnl | String | 收益 |
| price_avg | String | 成交均价 |
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| contract_val | String | 合约面值 |
| leverage | String | 杠杆倍数 |
| order_type | String | 0：普通委托 |
1：只做Maker（Post only） |
||
2：全部成交或立即取消（FOK） |
||
3：立即成交并取消剩余（IOC） |
||
4：市价委托 |
||
| last_fill_px | String | 最新成交价格（如果没有，推0） |
| last_fill_id | String | 最新成交id（如果没有，推0），和trade频道推送的trade_id一致 |
| last_fill_qty | String | 最新成交数量（如果没有，推0） |
| last_fill_time | String | 最新成交时间（如果没有，推1970-01-01T00:00:00.000Z） |
| state | String | -2:失败 |
-1:撤单成功 |
||
0:等待成交 |
||
1:部分成交 |
||
2:完全成交 |
||
3:下单中 |
||
4:撤单中 |
timestamp会根据订单状态变化分别返回相应的创建时间、成交时间、撤销时间等，具体状态用户可根据state参数判断。
status为state旧版参数，会短期兼容，建议尽早切换state。
{
"table":"futures/order",
"data":[
{
"leverage":"100",
"last_fill_time":"2019-12-12T03:06:39.197Z",
"filled_qty":"1",
"fee":"-0.000357715",
"price_avg":"7154.3",
"type":"2",
"client_oid":"",
"last_fill_qty":"1",
"instrument_id":"BTC-USDT-191213",
"last_fill_px":"7154.3",
"size":"1",
"price":"7154.3",
"last_fill_id":"132886",
"error_code":"0",
"state":"2",
"contract_val":"0.0001",
"order_id":"4022861767908353",
"order_type":"0",
"timestamp":"2019-12-12T03:06:39.197Z",
"status":"2"
}
]
}
用户委托策略频道
{"op": "subscribe", "args": ["futures/order_algo:LTC-USD-200327"]}
其中futures/order_algo为频道名，LTC-USD-200327为instrument_id
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_id | string | 委托ID |
| order_type | string | 1：止盈止损 |
2：跟踪委托 |
||
3：冰山委托 |
||
4：时间加权委托 |
||
| leverage | String | 杠杆倍数 |
| size | string | 委托数量 |
| instrument_id | string | 币对名称 |
| type | String | 订单类型 |
1:开多 |
||
2:开空 |
||
3:平多 |
||
4:平空 |
||
| timestamp | string | 委托时间 |
| status | string | 订单状态 |
1：待生效 |
||
2：已生效 |
||
3：已撤销 |
||
4：部分生效 |
||
5：暂停生效 |
||
6：委托失败 |
||
【只有冰山和加权有4、5状态】 |
止盈止损
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_price | string | 委托价格 |
| trigger_price | string | 触发价格 |
| real_amount | string | 实际委托量 |
| algo_type | String | 1:限价 2:市场价； |
跟踪委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| callback_rate | string | 回调幅度 |
| trigger_price | string | 激活价格 |
| real_amount | string | 实际委托量 |
冰山委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| algo_variance | string | 委托深度 |
| avg_amount | string | 单笔均值 |
| price_limit | string | 价格限制 |
| deal_value | string | 已下单数量 |
时间加权委托
| 参 数名 | 类 型 | 描 述 |
|---|---|---|
| sweep_range | string | 扫单范围 |
| sweep_ratio | string | 扫单比例 |
| single_limit | string | 单笔上限 |
| price_limit | string | 价格限制 |
| time_interval | string | 委托间隔 |
| deal_value | string | 已下单数量 |
{
"table":"futures/order_algo",
"data":[
{
"algo_id":"409",
"leverage":"10",
"real_amount":"0",
"size":"2.0",
"trigger_price":"47",
"algo_price":"47",
"type":"1",
"order_type":"1",
"instrument_id":"LTC-USDT-200327",
"timestamp":"2020-01-08T02:23:53.999Z",
"status":"1"
}
]
}
全量合约订阅频道
每次交割过后有新合约上线且可交易后，就推一次所有币种的全量合约数据（无需登录）。
{"op": "subscribe", "args": ["futures/instruments"]}
其中futures/instruments为频道名
| 参数名 | 参数类型 | 描述 |
|---|---|---|
| instrument_id | String | 合约ID，如BTC-USD-190322 ,BTC-USDT-191227 |
| underlying | String | 标的指数，如：BTC-USD |
| base_currency | String | 交易货币币中，如BTC-USD中的BTC |
| quote_currency | String | 计价货币币种，如：BTC-USD-190322中的USD |
| settlement_currency | String | 盈亏结算和保证金币种，如BTC |
| contract_val | String | 合约面值(美元) |
| listing | String | 上线日期 |
| delivery | String | 交割日期 |
| tick_size | String | 下单价格精度 |
| trade_increment | String | 下单数量精度 |
| alias | String | 本周: this_week |
次周: next_week |
||
季度: quarter |
||
次季度 bi_quarter |
||
| is_inverse | String | true or false ,是否 币本位保证金合约 |
| contract_val_currency | String | 合约面值计价币种 如 USD,BTC,LTC,ETC,XRP,EOS |
{
"table":"futures/instruments",
"data":[
[
{
"instrument_id":"BTC-USD-191115",
"underlying_index":"BTC",
"quote_currency":"USD",
"tick_size":"0.01",
"contract_val":"100",
"listing":"2019-11-01",
"delivery":"2019-11-15",
"trade_increment":"1",
"alias":"next_week",
"underlying":"BTC-USD",
"base_currency":"BTC",
"settlement_currency":"BTC",
"is_inverse":"true",
"contract_val_currency":"USD"
},
{
"instrument_id":"TRX-USD-191115",
"underlying_index":"TRX",
"quote_currency":"USD",
"tick_size":"0.00001",
"contract_val":"10",
"listing":"2019-11-01",
"delivery":"2019-11-15",
"trade_increment":"1",
"alias":"next_week",
"underlying":"TRX-USD",
"base_currency":"TRX",
"settlement_currency":"TRX",
"is_inverse":"true",
"contract_val_currency":"USD"
}
]
]
}
获取合约的最新成交价、买一价、卖一价和24交易量等信息，每100ms推送一次数据。
{"op": "subscribe", "args": ["futures/ticker:BTC-USD-170310"]}
其中futures/ticker为频道名，BTC-USD-170310为instrument_id
| |
---|---|---
参 数名 | 参 数类型 | 描 述
instrument_id | String | 合约名称，如BTC-USD-170310,BTC-USDT-191227
last | String | 最新成交价
best_ask | String | 卖一价
best_bid | String | 买一价
high_24h | String | 24小时最高价
low_24h | String | 24小时最低价
volume_24h | String | 24小时成交量（按张数统计）
timestamp | String | 系统时间戳
open_interest | String | 持仓量
open_24h | String | 24小时开盘价
volume_token_24h | String | 成交量（按币统计）
last_qty | String | 最新成交的数量
best_ask_size | String | 卖一价对应的量
best_bid_size | String | 买一价对应的数量
{
"table":"futures/ticker",
"data":[
{
"last":"43.259",
"open_24h":"49.375",
"best_bid":"43.282",
"high_24h":"49.488",
"low_24h":"41.649",
"volume_24h":"11295421",
"volume_token_24h":"2430793.6742",
"best_ask":"43.317",
"open_interest":"1726003",
"instrument_id":"LTC-USD-200327",
"timestamp":"2020-03-12T08:31:45.288Z",
"best_bid_size":"171",
"best_ask_size":"2",
"last_qty":"1"
}
]
}
获取合约的K线数据，每500ms推送一次数据。
频道列表：
futures/candle60s // 1分钟k线数据频道
futures/candle180s // 3分钟k线数据频道
futures/candle300s // 5分钟k线数据频道
futures/candle900s // 15分钟k线数据频道
futures/candle1800s // 30分钟k线数据频道
futures/candle3600s // 1小时k线数据频道
futures/candle7200s // 2小时k线数据频道
futures/candle14400s // 4小时k线数据频道
futures/candle21600s // 6小时k线数据频道
futures/candle43200s // 12小时k线数据频道
futures/candle86400s // 1dayk线数据频道
futures/candle604800s // 1week k线数据频道
{"op": "subscribe", "args": ["futures/candle180s:BTC-USD-191227"]}
其中futures/candle180s为频道名，BTC-USD-191227为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| timestamp | String | 开始时间 |
| open | String | 开盘价格 |
| high | String | 最高价格 |
| low | String | 最低价格 |
| close | String | 收盘价格 |
| volume | String | 交易量（张） |
| currency_volume | String | 按币折算的交易量 |
| instrument_id | String | 合约BTC-USD-170310,BTC-USDT-191227 |
k线衔接规则：
1）次周合约交割时：老次周合约对接新当周合约，老当周合约对接新次周合约，季度合约不变；
2）季度合约交割时：老当周合约对接新季度合约，老季度合于对接新次周合约，老次周合约对接新当周合约；
{
"table":"futures/candle180s",
"data":[
{
"candle":[
"2019-09-25T10:00:00.000Z",
"8533.02",
"8553.74",
"8527.17",
"8548.26",
"45247",
"529.5858061"
],
"instrument_id":"BTC-USD-191227"
}
]
}
获取最近的成交数据，每300ms推送一次数据。
{"op": "subscribe", "args": ["futures/trade:BTC-USD-170310"]}
其中futures/trade为频道名，BTC-USD-170310为instrument_id
| 参 数名 | 参 数类型 | 描 述 |
|---|---|---|
| trade_id | String | 成交id |
| price | String | 成交价格 |
| qty | String | 成交数量 |
| side | String | 成交方向（buy 或 sell） |
| timestamp | String | 成交时间 |
| instrument_id | String | 合约ID，如BTC-USD-170310,BTC-USDT-191227 |
{