OKCOIN.COM

此组别内的文章

查看更多

WebSocket API参考

Avatar
OKCoin
  • 更新于

现货行情 API

获取OKCoin最新市场现货行情数据

接口及描述
ok_sub_spot_X_ticker  订阅行情数据

websocket.send("{'event':'addChannel','channel':'ok_sub_spot_X_ticker'}");

① X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

示例

# Request
{'event':'addChannel','channel':'ok_sub_spot_btc_usd_ticker'}
# Response
[{
    "channel":"ok_sub_spot_btc_usd_ticker",
    "data":{
        "buy":2478.3,
        "high":2555,
        "last":2478.51,
        "low":2466,
        "sell":2478.5,
        "timestamp":1411718074965,
        "vol":49020.30
    }
}]

返回值说明

buy(double): 买一价
high(double): 最高价
last(double): 最新成交价
low(double): 最低价
sell(double): 卖一价
timestamp(long)：时间戳
vol(double): 成交量(最近的24小时)

 

接口及描述
ok_sub_spot_X_depth  订阅现货市场深度(200增量数据返回)

websocket.send("{'event':'addChannel','channel':'ok_sub_spot_X_depth'}");

① X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

示例

# Request
{'event':'addChannel','channel':'ok_sub_spot_btc_usd_depth'}
# Response
[{
    "channel":"ok_sub_spot_btc_usd_depth",
    "data":{
        "bids":[
            ["2473.88","2.025"],
            ["2473.5","2.4"],
            ["2470","12.203"]
        ],
        "asks":[
            ["2484","17.234"],
            ["2483.01","6"],
            ["2482.88","3"]
        ],
        "timestamp":1411718972024
    }
}]

返回值说明

使用描述:
	1，第一次返回全量数据
	2，根据接下来数据对第一次返回数据进行，如下操作
	删除（量为0时）
	修改（价格相同量不同）
	增加（价格不存在）
bids([string, string]):买方深度
asks([string, string]):卖方深度
timestamp(string):服务器时间戳

 

接口及描述
ok_sub_spot_X_depth_Y  订阅市场深度

websocket.send("{'event':'addChannel','channel':'ok_sub_spot_X_depth_Y'}");

X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd
Y值为: 5, 10, 20(获取深度条数)

示例

# Request
{'event':'addChannel','channel':'ok_sub_spot_btc_usd_depth_20'}
# Response
[{
    "channel":"ok_sub_spot_btc_usd_depth_20",
    "data":{
        "bids":[
            ["2473.88","2.025"],
            ["2473.5","2.4"],
            ["2470","12.203"]
        ],
        "asks":[
            ["2484","17.234"],
            ["2483.01","6"],
            ["2482.88","3"]
        ],
        "timestamp":1411718972024
    }
}]

返回值说明

bids([string, string]):买方深度
asks([string, string]):卖方深度
timestamp(long):服务器时间戳

 

接口及描述
ok_sub_spot_X_deals  订阅成交记录

websocket.send("{'event':'addChannel','channel':'ok_sub_spot_X_deals'}");

X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

示例

# Request
{'event':'addChannel','channel':'ok_sub_spot_btc_usd_deals'}
# Response
[{
    "channel":"ok_sub_spot_btc_usd_deals",
    "data":[["1001","2463.86","0.052","16:34:07","ask"]]
}]

返回值说明

增量数据返回
[交易序号, 价格, 成交量, 时间, 买卖类型]
[string, string, string, string, string]

 

接口及描述
ok_sub_spot_X_kline_Y  订阅K线数据

websocket.send("{'event':'addChannel','channel':'ok_sub_spot_X_kline_Y'}");

① X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd
② Y值为：1min, 3min, 5min, 15min, 30min, 1hour, 2hour, 4hour, 6hour, 12hour, day, 3day, week

示例

# Request
{'event':'addChannel','channel':'ok_sub_spot_btc_usd_kline_1min'}
# Response
[{
    "channel":"ok_sub_spot_btc_usd_kline_1min",
    "data":[
        ["1490337840000","995.37","996.75","995.36","996.75","9.112"],
        ["1490337840000","995.37","996.75","995.36","996.75","9.112"]
    ]
}]

返回值说明

[时间,开盘价,最高价,最低价,收盘价,成交量]
[string, string, string, string, string, string]

 

现货交易 API

快速进行现货交易

接口及描述
login  登录事件(个人信息推送)

 

示例

# Request
{"event":"login","parameters":{"api_key":"xxx","sign":"xxx"}}
# Response
[
    {
        "binary": 0,
        "channel": "login",
        "data": {
            "result": true
        }
    }
]

请求参数

参数名 描述

api_key

用户申请的apiKey

sign

请求参数的签名

说明

个人信息推送，个人数据有变化时会自动推送，其它旧的个人数据订阅类型可不订阅，
如:
ok_sub_spot_X_order,ok_sub_spot_X_balance

 

接口及描述
lok_spot_order  下单交易

websocket.send("{'event':'addChannel','channel':'ok_spot_order','parameters': {'api_key':'XXXX','sign':'XXXX','symbol':'btc_usd','type':'buy','price':'50','amount':'0.02'}}");

示例

# Request
{
    'event':'addChannel',
    'channel':'ok_spot_order',
    'parameters':{
        'api_key':'XXXX',
        'sign':'XXXX',
        'symbol':'btc_usd',
        'type':'buy',
        'price':'50',
        'amount':'0.02'
    }
}
# Response
[{
    "channel":"ok_spot_order",
    "data":{
        "order_id":125433029,
        "result":true
    }
}]

返回值说明

order_id(long)：订单号
result(boolean)：执行结果

请求参数

参数名 描述

api_key

用户申请的apiKey

sign

请求参数的签名

symbol

btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

type

买卖类型： 限价单（buy/sell） 市价单（buy_market/sell_market）

price

下单价格 [限价买单(必填)： 大于等于0，小于等于1000000 | 市价买单(必填)： BTC :最少买入0.01个BTC 的金额(金额>0.01*卖一价) / LTC :最少买入0.1个LTC 的金额(金额>0.1*卖一价) / ETH :最少买入0.01个ETH 的金额(金额>0.01*卖一价)]（市价卖单不传price）

amount

交易数量 [限价卖单（必填）：BTC 数量大于等于0.01 / LTC 数量大于等于0.1 / ETH 数量大于等于0.01 | 市价卖单（必填）： BTC :最少卖出数量大于等于0.01 / LTC :最少卖出数量大于等于0.1 / ETH :最少卖出数量大于等于0.01]（市价买单不传amount）

 

接口及描述
ok_spot_cancel_order  取消订单

websocket.send("{'event':'addChannel','channel':'ok_spot_cancel_order', 'parameters': {'api_key':'XXXX','sign':'XXXX','symbol':'btc_usd','order_id':'125433027'}}");

示例

# Request 
{
    'event':'addChannel',
    'channel':'ok_spot_cancel_order',
    'parameters':{
        'api_key':'XXXX',
        'sign':'XXXX',
        'symbol':'btc_usd',
        'order_id':'125433027'
    }
}
# Response
[{
    "channel":"ok_spot_cancel_order",
    "data":{
        "order_id":125433027,
        "result":true
    }
}]

返回值说明

order_id(long)：订单号
result(boolean)：执行结果

请求参数

参数名 描述

api_key

用户申请的apiKey

sign

请求参数的签名

symbol

btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

order_id

订单Id

 

 

接口及描述
ok_spot_userinfo  查询账户信息

websocket.send("{'event':'addChannel','channel':'ok_spot_userinfo','parameters': {'api_key':'XXXX','sign':'XXXX'}}");

示例

# Request 
{
    'event':'addChannel',
    'channel':'ok_spot_userinfo',
    'parameters':{
        'api_key':'XXXX',
        'sign':'XXXX'
    }
}
# Response
[{
    "channel": "ok_spot_userinfo",
    "data": {
        "info": {
            "funds": {
                "asset": {
                    "net": "0",
                    "total": "0"
                },
                "borrow": {
                    "btc": "0",
                    "usd": "0",
                    "ltc": "0",
                    "eth": "0"
                },
                "free": {
                    "btc": "0",
                    "usd": "0",
                    "ltc": "0",
                    "eth": "0"
                },
                "freezed": {
                    "btc": "0",
                    "usd": "0",
                    "ltc": "0",
                    "eth": "0"
                },
                "union_fund": {
                    "btc": "0",
                    "ltc": "0",
                    "eth": "0"
                }
            }
        },
        "result": true
    }
}]

返回值说明

asset:账户资产，包含净资产及总资产
borrow:账户借款信息(只有在账户有借款信息时才会返回)
free:账户余额
freezed:账户冻结余额
union_fund:账户理财信息(只有在账户有理财信息时才返回)

请求参数

参数名 描述

api_key

用户申请的apiKey

sign

请求参数的签名

 

接口及描述
ok_spot_orderinfo  查询订单信息

websocket.send("{'event':'addChannel','channel':'ok_spot_orderinfo','parameters': {'api_key':'XXXX','symbol':'btc_usd','order_id':'20914907','sign':'XXXX'}}");

示例

# Request
{
    'event':'addChannel',
    'channel':'ok_spot_orderinfo',
    'parameters':{
        'api_key':'XXXX',
        'sign':'XXXX',
        'symbol':'btc_usd',
        'order_id':'20914907'
    }
}
# Response
[{
    "channel": "ok_spot_orderinfo",
    "data": {
        "orders": [{
            "amount": 0.1,
            "avg_price": 1.961,
            "create_date": 1422502117000,
            "deal_amount": 0.1,
            "order_id": 20914907,
            "orders_id": 20914907,
            "price": 0,
            "status": 2,
            "symbol": "btc_usd",
            "type": "sell_market"
        }],
        "result": true
    }
}]

返回值说明

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

请求参数

参数名 描述

api_key

用户申请的apiKey

sign

请求参数的签名

symbol

btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

order_id

订单ID

 

 

接口及描述
ok_sub_spot_X_order  交易数据

 

X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

示例

# Response
[
    {
        "channel": "ok_sub_spot_X_order",
        "data": {
            "averagePrice": "0",
            "completedTradeAmount": "0",
            "createdDate": 1422258604000,
            "id": 268013884,
            "orderId": 268013884,
            "sigTradeAmount": "0",
            "sigTradePrice": "0",
            "status": -1,
            "symbol": "btc_usd",
            "tradeAmount": "1.105",
            "tradePrice": "0",
            "tradeType": "buy",
            "tradeUnitPrice": "1853.74",
            "unTrade": "0"
        }
    }
]

返回值说明

createdDate(string):创建日期
orderId(long):订单id
tradeType(string):交易类型（buy:买入；sell:卖出；buy_market:按市价买入；sell_market:按市价卖出）
sigTradeAmount(string):单笔成交数量
sigTradePrice(string):单笔成交价格
tradeAmount(string):委托数量（市价卖代表要卖总数量；限价单代表委托数量）
tradeUnitPrice(string):委托价格（市价买单代表购买总金额； 限价单代表委托价格）
symbol(string):btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd
completedTradeAmount(string):已完成成交量
tradePrice(string):成交金额
averagePrice(string):平均成交价
unTrade(string):当按市场价买币时表示剩余金额，其他情况表示此笔交易剩余买/卖币的数量
status(int):-1已撤销,0等待成交,1部分成交,2完全成交,4撤单处理中

说明

登录后无需订阅，兼容旧的订阅方式，旧的订阅方式相当于登录操作。
Response:
[
    {
        "binary": 0,
        "channel": "login",
        "data": {
            "result": true
        }
    }
]

 

接口及描述
ok_sub_spot_X_balance  账户信息

 

X值为：btc_usd, ltc_usd, eth_usd, etc_usd, bcc_usd

示例

# Response
[{
    "channel": "ok_sub_spot_X_balance",
    "data": {
        "info": {
            "free": {
                "btc": 0.0001,
                "usd": 2.2687485,
                "ltc": 1.479023,
                "eth": 1.479022
            },
            "freezed": {
                "btc": 0,
                "usd": 0.000045,
                "ltc": 0,
                "eth": 0
            }
        }
    }
}]

返回值说明

lend:账户放款信息(只有在账户有放款信息时才会返回)
borrow:账户借款信息(只有在账户有借款信息时才会返回)
free:账户余额
freezed:账户冻结余额

说明

登录后无需订阅，兼容旧的订阅方式，旧的订阅方式相当于登录操作。
Response:
[
    {
        "binary": 0,
        "channel": "login",
        "data": {
            "result": true
        }
    }
]

相关文章

返回顶部