REST_Request_Response

API请求、返回格式说明

Bibox REST API参数规范，支持批量请求，请务必认真阅读。

请求参数

• 需要apikey的请求格式

// Request
{
    "cmds": [ // 支持批量请求（cmd设置不同，用来区分返回结果）
        {
            "cmd": "orderpending/trade", // 下单
            "index": 1234567,
            "body": {
                "pair": "BIX_BTC",
                ... //其他参数
            }
        },
        {
            "cmd": "orderpending/cancelTrade", // 撤单
            "body": {
                "orders_id": 12345
            }
        }
    ],
    "apikey": "**************", // 您的apikey
    "sign": "**************" // 用您的apisecret签名(序列化后的)cmds的结果
}

• 不需要apikey的请求格式

// Request
{
    "cmds": [ // 支持批量请求（cmd设置不同，用来区分返回结果）
        {
            "cmd": "api/ticker", // 请求ticker
            "body": {
                "pair": "BIX_BTC"
            }
        },
        
        {
            "cmd": "api/depth", // 请求深度
            "body": {
                "pair": "BIX_BTC",
                "size": 10,
            }
        }
    ]
}

参数解释

cmds: 请求参数封装格式, 数组类型, 使用时必须先序列化，数组中每个元素代表一次独立的API调用
cmd: API接口名，请参考API Reference
body: cmd对应的请求参数，请参考API_Reference
apikey: 系统给您分配的 apikey
sign: 使用系统分配给您的 api secret 签名(格式化后的)cmds的结果

结果返回

• 请求成功返回

{
    "result":[
        {
            "cmd":"api/pairList",
            "result":[
                {
                    "id":1,
                    "pair":"BIX_BTC"
                },
                {
                    "id":2,
                    "pair":"ETH_BTC"
                }
            ]
        }
    ]
}

结果解释

cmd: API接口名，请参考API Reference
result(外): 批量请求的返回结果，不保证顺序一致性
result(里): 特定cmd接口对应的返回结果

• 请求失败返回

{
    "error":{
        "code":"1000",
        "msg":"something error"
    }
}

结果解释

code: 错误码
msg: 错误描述

• 批量请求返回

{
    "result":[
        { //成功
            "cmd":"api/pairList",
            "result":[
                {
                    "id":1,
                    "pair":"BIX_BTC"
                },
                {
                    "id":2,
                    "pair":"ETH_BTC"
                }
            ]
        },
        { //失败
            "cmd":"api/depth",
            "error":{
                "code":"1000",
                "msg":"something error"
            }
        }
    ]
}

示例

// Request
{
    "cmds": [
        {
            "cmd": "orderpending/cancelTrade",
            "index": 12345,
            "body": {
                "orders_id": 1000032341
            }
        }
    ],
    "apikey": "**************", // 您的apikey
    "sign": "**************" // 用您的apisecret签名(序列化后的)cmds的结果
}

// Response
{
    "result": [{
       "result":"撤销中",
       "index": 12345,
       "cmd":"orderpending/cancelTrade"
   }]
}