# 交易API

# 1. 交易下单

HTTP请求

    # Request
    POST api/v1/user/trade

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒
side String (Bid/Ask 买/卖)
entrustPrice float64 价格
entrustVolume float64 数量
tradeType String Market/Limit 市价/限价
action String Open/Close 开仓/平仓

返回值说明

参数名 参数类型 描述
orderId String 订单ID
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
            "orderId": "11141",
        }
    }

# 2. 一键平仓下单

查询持仓信息后,可根据仓位ID进行一键平仓操作。注意,一键平仓是以市价委托进行触发的。

HTTP请求

    # Request
    POST api/v1/user/oneClickClosePosition

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
positionId Int64 一键平仓对应的仓位ID
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
orderId String 一键平仓产生的委托订单ID
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
        }
    }

# 3. 全部一键平仓下单

将当前账户下所有仓位进行一键平仓操作。注意,一键平仓是以市价委托进行触发的。

HTTP请求

    # Request
    POST api/v1/user/oneClickCloseAllPositions

请求方式

POST

请求参数

参数名 参数类型 必填 描述
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
orders String数组 全部一键平仓产生的多个委托订单ID
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
          "orders": ["123", "456", "789"]
        }
    }

# 4. 撤销订单

将处于当前委托状态的订单进行撤销操作。

HTTP请求

    # Request
    POST api/v1/user/cancelOrder

请求方式

POST

请求参数

参数名 参数类型 必填 描述
orderId String 订单ID
symbol String 合约名称中需有"-",如BTC-USDT
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
orderId String 订单ID
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
            "orderId": "11141",
        }
    }

# 5. 批量撤销订单

将合约下处于当前委托状态的全部订单进行撤销操作。

HTTP请求

    # Request
    POST api/v1/user/batchCancelOrders

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
oids String 订单ID列表,多个订单id用逗号进行分隔
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
Success String数组 撤销成功的订单ID列表
Failed 结构数组 撤销失败的订单列表
orderId String 订单ID
errorCode Int64 错误码,0表示成功,不为0表示异常失败
errorMessage String 错误信息提示
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
          "success": ["725970815","725970736"],
          "failed":[
            {
              "orderId": "725971356",
              "errorCode": 80012,
              "errorMessage": "Service network failed"
            },
          ],
        }
    }

# 6. 撤销全部订单

将账户下处于当前委托状态的全部订单进行撤销操作。

HTTP请求

    # Request
    POST api/v1/user/cancelAll

请求方式

POST

请求参数

参数名 参数类型 必填 描述
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
        }
    }

# 7. 查询当前委托订单

查询一段时间周期内账户下处于当前委托状态的订单详情。

HTTP请求

    # Request
    POST api/v1/user/pendingOrders

请求方式

POST

请求参数

参数名 参数类型 必填 字段描述
symbol String 合约名称中需有"-",如BTC-USDT,为空则返回全部
apiKey String
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
entrustTm String 订单委托时间
side String 交易方向(Bid/Ask 买/卖)
tradeType String 委托类型(Market/Limit 市价/限价)
action String Open/Close 开仓/平仓
entrustPrice Float64 委托价格
entrustVolume Float64 委托数量
avgFilledPrice Float64 成交均价
filledVolume Float64 成交数量
orderId String 订单号
# Response
    {
       "code": 0,
       "msg": "",
       "data": {
            "orders": [
                {
                    "entrustTm": "2018-04-25T15:00:51.000Z",
                    "side": "Bid",
                    "tradeType": "Limit",
                    "action": "Open",
                    "entrustPrice": 6.021954,
                    "entrustVolume": 18.098,
                    "filledVolume": 0,
                    "avgFilledPrice": 0,
                    "orderId": "6030",
                    "symbol": "BTC-USDT",
                },
                {
                    "entrustTm": "2018-04-25T15:00:51.999Z",
                    "side": "Ask",
                    "tradeType": "Limit",
                    "action": "Close",
                    "entrustPrice": 6.021954,
                    "entrustVolume": 18.098,
                    "filledVolume": 0,
                    "avgFilledPrice": 0,
                    "orderId": "6030",
                    "symbol": "ETH-USDT",
                },
            ]
        }
    }

# 8. 查询订单详情

HTTP请求

    # Request
    POST api/v1/user/queryOrderStatus

请求方式

POST

请求参数

参数名 参数类型 必填 描述
apiKey String 接口秘钥
timestamp String 发起请求的时间戳,单位为毫秒
symbol String 合约名称中需有"-",如BTC-USDT
orderId String 订单ID

返回值说明

参数名 参数类型 描述
entrustTm String 订单委托时间
side String 交易方向(Bid/Ask 买/卖)
tradeType String 委托类型(Market/Limit 市价/限价)
action String Open/Close 开仓/平仓
entrustPrice Float64 委托价格
entrustVolume Float64 委托数量
avgFilledPrice Float64 成交均价
filledVolume Float64 成交数量
orderId String 订单号
status String 订单状态(Filled or PartiallyFilled, Pending, Cancelled, Failed)

备注

Status 字段说明
Pending 尚未成交
PartiallyFilled 部分成交
Cancelled 已撤销
Filled 已完成
Failed 失败
    # Response
    {
        "code": 0,
        "msg": "",
        "data": {
            "entrustTm": "2018-04-25T15:00:51.000Z",
            "side": "Ask",
            "tradeType": "Limit",
            "action": "Close",
            "entrustPrice": 6.021954,
            "entrustVolume": 18.098,
            "filledVolume": 0,
            "avgFilledPrice": 0,
            "orderId": "6030",
            "status": "Filled"
        }
    }

# 9. 切换全仓/逐仓

修改专业合约账户的保证金模式,全仓模式或逐仓模式。

HTTP请求

    # Request
    POST api/v1/user/setMarginMode

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
marginMode String Isolated or Cross, 账户保证金模式,逐仓或者全仓
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
        }
    }

# 10. 修改杠杆

调整合约多仓或空仓的杠杆倍数。

HTTP请求

    # Request
    POST api/v1/user/setLeverage

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
side String 多仓或者空仓的杠杆,Long表示多仓,Short表示空仓
leverage String 杠杆倍数
apiKey String 接口密钥
timestamp String 发起请求的时间戳,单位为毫秒

返回值说明

参数名 参数类型 描述
code Int64 错误码,0表示成功,不为0表示异常失败
msg String 错误信息提示
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
        }
    }

# 11. 查询强平订单历史

HTTP请求

    # Request
    POST api/v1/user/forceOrders

请求方式

POST

请求参数

参数名 参数类型 必填 描述
symbol String 合约名称中需有"-",如BTC-USDT
autoCloseType String Liquidation 表示强平订单, ADL 表示减仓订单
lastOrderId int64 用于分页, 第一次填写0, 后续填写前一次返回结果里面的最后一个订单id
length int64 每次请求的长度, 最大值为100

返回值说明

参数名 参数类型 描述
symbol String 合约名称
tradeType String 订单类型, Limit是限价单, Market是市价单
action String Liquidation 表示强平订单, ADL 表示减仓订单
avgFilledPrice Float64 破产价格
entrustTm String 成交时间
filledVolume Float64 成交数量
orderId String 订单id
side String 交易方向, Bid买入, Ask卖出
profit Float64 盈亏
commission Float64 手续费
# Response
    {
        "code": 0,
        "msg": "",
        "data": {
        	"symbol": "BTC-USDT",
        	"tradeType": "Limit",
        	"action": "Liquidation",
        	"avgFilledPrice": 5938.23,
        	"entrustTm": "2018-04-25T15:00:51.000Z",
        	"filledVolume": 1.2123,
        	"orderId": 123456789,
        	"side": "Bid",
        	"profit": -11.34,
        	"commission": 0.4231
        }
    }

备注

Last Updated: 2021/12/2 下午2:37:08