REST API for SPOT    

开始使用    

REST，即Representational State Transfer的缩写，是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便，正得到越来越多网站的采用。其优点如下：

• 在RESTful架构中，每一个URL代表一种资源；
• 客户端和服务器之间，传递这种资源的某种表现层；
• 客户端通过四个HTTP指令，对服务器端资源进行操作，实现“表现层状态转化”。

建议开发者使用REST API进行币币交易或者资产提现等操作。

请求交互    

REST访问的根URL：https://www.okex.com/api/v1     访问时需要科学上网 所有请求基于Https协议，请求头信息中contentType需要统一设置为：application/x-www-form-urlencoded    

请求交互说明

1. 请求参数：根据接口请求参数规定进行参数封装。
2. 提交请求参数：将封装好的请求参数通过POST 或GET 方式提交至服务器。
3. 服务器响应：服务器首先对用户请求数据进行参数安全校验，通过校验后根据业务逻辑将响应数据以JSON格式返回给用户。
4. 数据处理：对服务器响应数据进行处理。

API参考

币币行情 API

获取OKEx币币行情数据

1. Get /api/v1/ticker   获取OKEx币币行情

URL https://www.okex.com/api/v1/ticker.do

示例

# RequestGET https://www.okex.com/api/v1/ticker.do?symbol=ltc_btc# Response{"date":"1410431279","ticker":{"buy":"33.15","high":"34.15","last":"33.15","low":"32.05","sell":"33.16","vol":"10532696.39199642"}}

返回值说明

date: 返回数据时服务器时间buy: 买一价high: 最高价last: 最新成交价low: 最低价sell: 卖一价vol: 成交量(最近的24小时)

请求参数

2. Get /api/v1/depth 获取OKEx币币市场深度

URL https://www.okex.com/api/v1/depth.do

示例

# RequestGET https://www.okex.com/api/v1/depth.do?symbol=ltc_btc# Response{"asks": [[792, 5],[789.68, 0.018],[788.99, 0.042],[788.43, 0.036],[787.27, 0.02]],"bids": [[787.1, 0.35],[787, 12.071],[786.5, 0.014],[786.2, 0.38],[786, 3.217],[785.3, 5.322],[785.04, 5.04]]}

返回值说明

asks :卖方深度bids :买方深度

请求参数

3. Get /api/v1/trades 获取OKEx币币交易信息(600条)

URL https://www.okex.com/api/v1/trades.do

示例

# RequestGET https://www.okex.com/api/v1/trades.do?symbol=ltc_btc&since=7622718804# Response[{        "date": "1367130137","date_ms": "1367130137000","price": 787.71,"amount": 0.003,"tid": "230433","type": "sell"},{        "date": "1367130137","date_ms": "1367130137000","price": 787.65,"amount": 0.001,"tid": "230434","type": "sell"},{"date": "1367130137","date_ms": "1367130137000","price": 787.5,"amount": 0.091,"tid": "230435","type": "sell"}]

返回值说明

date:交易时间date_ms:交易时间(ms)price: 交易价格amount: 交易数量tid: 交易生成IDtype: buy/sell

请求参数

4. Get /api/v1/kline 获取OKEx币币K线数据(每个周期数据条数2000左右)

URL https://www.okex.com/api/v1/kline.do

示例

# RequestGET https://www.okex.com/api/v1/kline.do?symbol=ltc_btc&type=1min# Response[    [        1417449600000,        2339.11,        2383.15,        2322,        2369.85,        83850.06    ],    [        1417536000000,        2370.16,        2380,        2352,        2367.37,        17259.83    ]]

返回值说明

[1417536000000,时间戳2370.16,开2380,高2352,低2367.37,收17259.83交易量]

请求参数

币币交易 API

用于OKEx币币交易

1. POST /api/v1/userinfo 获取用户信息

URL https://www.okex.com/api/v1/userinfo.do访问频率 6次/2秒  

示例

# RequestPOST https://www.okex.com/api/v1/userinfo.do# Response{    "info": {        "funds": {            "free": {                "btc": "0",                "ltc": "0",                "eth": "0"            },            "freezed": {                "btc": "0",                "ltc": "0",                "eth": "0"            }        }    },    "result": true}

返回值说明

free:账户余额freezed:账户冻结余额

请求参数

2. POST /api/v1/trade 下单交易

URL https://www.okex.com/api/v1/trade.do访问频率 20次/2秒

示例

# RequestPOST https://www.okex.com/api/v1/trade.do# Response{"result":true,"order_id":123456}

返回值说明

result:true代表成功返回order_id:订单ID

请求参数

3. POST /api/v1/batch_trade 批量下单

URL https://www.okex.com/api/v1/batch_trade.do访问频率 20次/2秒

示例

# RequestPOST https://www.okex.com/api/v1/batch_trade.do# Response{"order_info":[{"order_id":41724206},{"error_code":10011,"order_id":-1},{"error_code":10014,"order_id":-1}],"result":true}

返回值说明

result:订单交易成功或失败order_id:订单ID备注:     只要其中任何一单下单成功就返回true     返回的订单信息和orders_data上传的订单顺序一致     如果下单失败：order_id为-1，error_code为错误代码

请求参数

4. POST /api/v1/cancel_order 撤销订单

URL https://www.okex.com/api/v1/cancel_order.do访问频率 20次/2秒

示例

# RequestPOST https://www.okex.com/api/v1/cancel_order.do# Response#多笔订单返回结果(成功订单ID,失败订单ID){"success":"123456,123457","error":"123458,123459"}

返回值说明

result:true撤单请求成功，等待系统执行撤单；false撤单失败(用于单笔订单)order_id:订单ID(用于单笔订单)success:撤单请求成功的订单ID，等待系统执行撤单(用于多笔订单)error:撤单请求失败的订单ID(用户多笔订单)

请求参数

5. POST /api/v1/order_info   获取用户的订单信息

URL https://www.okex.com/api/v1/order_info.do访问频率 20次/2秒(未成交)

示例

# RequestPOST https://www.okex.com/api/v1/order_info.do# Response{    "result": true,    "orders": [        {            "amount": 0.1,            "avg_price": 0,            "create_date": 1418008467000,            "deal_amount": 0,            "order_id": 10000591,            "orders_id": 10000591,            "price": 500,            "status": 0,            "symbol": "btc_usd",            "type": "sell"        },        {            "amount": 0.2,            "avg_price": 0,            "create_date": 1417417957000,            "deal_amount": 0,            "order_id": 10000724,            "orders_id": 10000724,            "price": 0.1,            "status": 0,            "symbol": "btc_usd",            "type": "buy"        }    ]}

返回值说明

amount:委托数量create_date: 委托时间avg_price:平均成交价deal_amount:成交数量order_id:订单IDorders_id:订单ID(不建议使用)price:委托价格status:-1:已撤销  0:未成交  1:部分成交  2:完全成交 3:撤单处理中type:buy_market:市价买入 / sell_market:市价卖出

请求参数

6. POST /api/v1/orders_info 批量获取用户订单

URL https://www.okex.com/api/v1/orders_info.do访问频率 20次/2秒

示例

# RequestPOST https://www.okex.com/api/v1/orders_info.do# Response{"result":true,"orders":[{"order_id":15088,"status":0,"symbol":"btc_usd","type":"sell","price":811,"amount":1.39901357,"deal_amount":1,"avg_price":811} ,{"order_id":15088,"status":-1,"symbol":"btc_usd","type":"sell","price":811,"amount":1.39901357,"deal_amount":1,"avg_price":811}]}

返回值说明

amount：限价单请求：下单数量 /市价单请求：卖出的btc/ltc数量deal_amount：成交数量avg_price：平均成交价create_date：委托时间order_id：订单IDprice：限价单请求：委托价格 / 市价单请求：买入的usd金额status： -1：已撤销  0：未成交 1：部分成交 2：完全成交 4:撤单处理中type:buy_market：市价买入 /sell_market：市价卖出result：结果信息

请求参数

7. POST /api/v1/order_history 获取历史订单信息，只返回最近两天的信息

URL https://www.okex.com/api/v1/order_history.do

示例

# RequestPOST https://www.okex.com/api/v1/order_history.do# Response{"current_page": 1,"orders": [{"amount": 0,"avg_price": 0,"create_date": 1405562100000,"deal_amount": 0,"order_id": 0,"price": 0,"status": 2,"symbol": "btc_usd","type": "sell”}],"page_length": 1,"result": true,"total": 3}

返回值说明

current_page:当前页码orders:委托详细信息amount:委托数量avg_price:平均成交价create_date:委托时间deal_amount:成交数量order_id:订单IDprice:委托价格status:-1:已撤销   0:未成交 1:部分成交 2:完全成交 4:撤单处理中type:buy_market:市价买入 / sell_market:市价卖出page_length:每页数据条数result:true代表成功返回

请求参数

8. POST /api/v1/withdraw 提币BTC/LTC/ETH/ETC/BCH

URL https://www.okex.com/api/v1/withdraw.do

示例

# RequestPOST https://www.okex.com/api/v1/withdraw.do# Response{    "withdraw_id":301,    "result":true}

返回值说明

withdraw_id:提币申请Idresult:true表示请求成功

请求参数

9. POST /api/v1/cancel_withdraw   取消提币BTC/LTC/ETH/ETC/BCH

URL https://www.okex.com/api/v1/cancel_withdraw.do

示例

# RequestPOST https://www.okex.com/api/v1/cancel_withdraw.do# Response{    "result":true,    "withdraw_id":301}

返回值说明

withdraw_id:提币申请Idresult:true表示请求成功

请求参数

10. POST /api/v1/withdraw_info 查询提币BTC/LTC/ETH/ETC/BCH信息

URL https://www.okex.com/api/v1/withdraw_info.do

示例

# RequestPOST https://www.okex.com/api/v1/withdraw_info.do# Response{    "result": true,    "withdraw": [        {            "address": "15KGp……",            "amount": 2.5,            "created_date": 1447312756190,            "chargefee": 0.1,            "status": 0,            "withdraw_id": 45001        }    ]}

返回值说明

result:true表示请求成功address:提现地址amount:提现金额created_date:提现时间chargefee:网络手续费status:提现状态（-3:撤销中;-2:已撤销;-1:失败;0:等待提现;1:提现中;2:已汇出;3:邮箱确认;4:人工审核中5:等待身份认证）withdraw_id:提币申请Id

请求参数

11. POST /api/v1/account_records 获取用户提现/充值记录

URL https://www.okex.com/api/v1/account_records.do

示例

# RequestPOST https://www.okex.com/api/v1/account_records.do# Response{    "records": [        {            "addr": "1CWKbfwxSkEWP8W45D76j3BX8vPieoSCyL",            "account": "12312",            "amount": 0,            "bank": "中国银行",            "benificiary_addr": "350541545",            "transaction_value": 111,            "fee": 0,            "date": 1418008467000,"status": 1        }    ],    "symbol": "btc"}

返回值说明

addr: 地址account: 账户名称amount: 金额bank: 银行benificiary_addr: 收款地址transaction_value: 提现扣除手续费后金额fee: 手续费date: 时间symbol: btc, ltc, eth, etc, bch, usdtstatus: 记录状态,如果查询充值记录:(-1:充值失败;0:等待确认;1:充值成功),如果查询提现记录:(-3:撤销中;-2:已撤销;-1:失败;0:等待提现;1:提现中;2:已汇出;3:邮箱确认;4:人工审核中;5:等待身份认证)

请求参数

12. POST /api/v1/funds_transfer   资金划转

URL https://www.okex.com/api/v1/funds_transfer.do

示例

# RequestPOST https://www.okex.com/api/v1/funds_transfer.do# Response{    "result":true}或{    "error_code":20029,    "result":false}

返回值说明

result:划转结果。若是划转失败，将给出错误码提示。

请求参数

13. POST /api/v1/wallet_info 获取用户钱包账户信息

URL https://www.okex.com/api/v1/wallet_info.do访问频率 6次/2秒  

示例

# RequestPOST https://www.okex.com/api/v1/wallet_info.do# Response{    "info": {        "funds": {            "free": {                "btc": "0",                "ltc": "0",                "eth": "0"            },            "holds": {                "btc": "0",                "ltc": "0",                "eth": "0"            }        }    },    "result": true}

返回值说明

free:账户余额holds:账户锁定余额

请求参数