Example

# Request 
POST https://www.okcoin.com/api/v1/userinfo.do
# Response
{
    "info": {
        "funds": {
            "asset": {
                "net": "0",
                "total": "0"
            },
            "borrow": {
                "btc": "0",
                "usd": "0",
                "ltc": "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"
            }
        }
    },
    "result": true
}
  

Return Values

asset: account funds, including net fund and total fund
net:net Equity (Borrowed Value Excluded)
total:total Equity (Borrowed Value Included)
borrow: account borrowing information (only returned when this field is not null)
free: available fund
freezed: frozen fund
union_fund: fund management information (only returned when this field is not null)

Request Parameters

Example

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

Return Values

result: true means order placed successfully
order_id: order ID of the newly placed order

Request Parameters

Example

# Request
POST https://www.okcoin.com/api/v1/trade_history.do
# 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"
    }
]
  

Return Values

date: transaction time
date_ms: transaction time in milliseconds
price: transaction price
amount: quantity in BTC (or LTC)
tid: transaction ID
type: buy/sell

Request Parameters

Example

# Request 
POST https://www.okcoin.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
}
  

Return Values

result: true indicates order successfully placed
order_id: order ID
Note: return true if any one order is placed successfully
     returned orders info and 'orders_data' are in same sequence
     if fail to place order: order_id is -1

Request Parameters

Example

# Request 
POST https://www.okcoin.com/api/v1/cancel_order.do
# Response
# For batch orders, return (success order IDs, failed order IDs)
{"success":"123456,123457","error":"123458,123459"}
  

Return Values

result: true: cancel order request successful, wait to be processed, false: cancel order failed(applicable to single order)
order_id: order ID (applicable to single order)
success: ID of orders whose cancel request are successful, wait to be processed.(applicable to batch orders)
error: ID of orders whose cancel request are unsuccessful.(applicable to batch orders)

Request Parameters

Example

# Request 
POST https://www.okcoin.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"
        }
    ]
}
  

Return Values

amount: order quantity
avg_price: average transaction price
create_date: order time
deal_amount: filled quantity
order_id: order ID
orders_id: order ID (Deprecated)
price: order price
status: -1 = cancelled, 0 = unfilled, 1 = partially filled, 2 = fully filled, 4 = cancel request in process
type: buy_market = market buy order, sell_market = market sell order

Request Parameters

Example

# Request 
POST https://www.okcoin.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
		}
	]
}
  

Return Values

amount: for limit orders, returns the order quantity.  For market orders, returns the filled quantity
deal_amount: filled quantity
avg_price: average transaction price
create_date: order time
order_id: order ID
price: for limit orders, return the order price.  For market orders, returns the filled price
status: -1 = cancelled, 0 = unfilled, 1 = partially filled, 2 = fully filled, 4 = cancel request in process
type: buy_market = market buy order, sell_market = market sell order
result: request result

Request Parameters

Example

# Request 
POST https://www.okcoin.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
}
]
  

Return Values

current_page: current page number
orders: detailed order information
amount: order quantity
avg_price: average transaction price
create_date: order time
deal_amount: filled quantity
order_id: order ID
price: order price
status: -1 = cancelled, 0 = unfilled, 1 = partially filled, 2 = fully filled, 4 = cancel request in process
type: buy_market = market buy order, sell_market = market sell order
page_length: number of orders per page
result: true means request successfully handled

Example

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

Return Values

withdraw_id: withdrawal request ID
result: true means request successful

Request Parameters

Example

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

Return Values

result: true for success, false for error
withdraw_id: withdrawal request ID

Request Parameters

Example

# Request
POST https://www.okcoin.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
        }
    ]
}

Return Values

result: true for success, false for error
address: withdrawal address
amount: withdrawal amount
created_date: withdrawal time
chargefee: network transaction fee
status: withdrawal status (-3:Revoked;-2:Cancelled;-1:Failure;0:Pending;1:Pending;2:Complete;3:Email Confirmation;4:Verifying5:Wait Confirmation)
withdraw_id: withdrawal request ID

Request Parameters