Order
快速入门¶
Restful API¶
公共接口¶
用户接口¶
订单接口¶
WebSocket API¶
WebSocket接入说明¶
公共接口¶
用户接口¶
订单接口¶
1. 下单¶
HTTP请求
POST: /api/spot/v1/order/place_order
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| side | number | Y | 交易方向(1卖出2买入) |
| type | number | Y | 交易类型(1:限价交易 2:市价交易) |
| volume | string | Y | 委托量,限价时，计价币数量。市价时，基础币数量 |
| price | string | Y | 委托价 |
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单号 |
| side | number | Y | 交易方向(1卖出2买入) |
| type | number | Y | 交易类型(1:限价交易 2:市价交易) |
| volume | string | Y | 委托量,限价时，计价币数量。市价时，基础币数量 |
| price | string | Y | 委托价 |
| symbol | string | Y | 币对 |
| placeStatus | string | Y | 下单是否成功, 1成功 |
2. 批量下单¶
HTTP请求
POST: /api/spot/v1/order/place_order/batch
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| orderList | object[] | Y | 下单集合 |
orderList
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| side | number | Y | 交易方向(1卖出2买入) |
| type | number | Y | 交易类型(1:限价交易 2:市价交易) |
| volume | string | Y | 委托量,限价时，基础币数量。市价时，计价币数量 |
| price | string | Y | 委托价 |
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object[] | N | 下单集合信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单号 |
| side | number | Y | 交易方向(1卖出2买入) |
| type | number | Y | 交易类型(1:限价交易 2:市价交易) |
| volume | string | Y | 委托量 |
| price | string | Y | 委托价 |
| symbol | string | Y | 币对 |
| placeStatus | string | Y | 下单是否成功, 1成功 |
3. 撤单/批量撤单¶
HTTP请求
POST: /api/spot/v1/order/cancel
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| orderIdList | object[] | Y | 撤单集合 |
orderIdList
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单id |
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object | N |
4. 查询撮合订单¶
HTTP请求
POST: /api/spot/v1/order/deal/list
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单ID |
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| volume | string | Y | 成交数量 |
| price | string | Y | 成交价格 |
| fee | string | Y | 手续费 |
| feeCoin | string | Y | 手续费币种 |
| role | string | Y | 角色(1-Maker 2-Taker) |
| ctime | string | Y | 成交时间(ISO8601) |
| id | string | Y | 撮合订单id |
5. 查询历史委托订单¶
HTTP请求
POST: /api/spot/v1/order/history/page
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| page | number | N | 第几页 |
| pageSize | number | N | 每页条数 |
| startTime | string | N | 订单创建起始时间(ISO8601) |
| endTime | string | N | 订单创建结束时间(ISO8601) |
| status | string | N | 订单状态（1未成交,2已成交,3部分成交,4已撤单,7部分成交/已撤单） |
| side | string | N | 交易方向(1卖出2买入) |
| type | string | N | 订单类型(1限价2市价) |
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| total | number | Y | 总条数 |
| pageNum | string | Y | 第几页 |
| pageSize | object | N | 每页条数 |
| data | object[] | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单ID |
| userId | string | Y | 用户ID |
| orderType | string | Y | 订单类型，1.限价，2.市价 |
| amount | string | Y | 委托总价值 (计价币) |
| dealAmount | string | Y | 成交数量 |
| volume | string | Y | 已成交价值 (计价币) |
| leftAmount | string | Y | 剩余价值 (计价币) |
| volume | string | Y | 委托数量 (基准币) |
| dealVolume | string | Y | 已成交数量 (基准币) |
| leftVolume | string | Y | 剩余数量 (基准币) |
| status | string | Y | 订单状态（1未成交,2已成交,3部分成交,4已撤单,7部分成交/已撤单） |
| type | string | Y | 1.限价，2.市价 |
| side | string | Y | 交易方向(1卖出2买入) |
| price | string | Y | 委托价格 |
| avgPrice | string | Y | 平均成交价格 |
| progress | string | Y | 成交百分比 单位为1% 15.8为15.8% |
| ctime | string | Y | 订单创建时间 |
| utime | string | Y | 订单修改时间 |
| base | string | Y | 基准币 |
| quote | string | Y | 计价币 |
| symbol | string | Y | 币对 |
| fee | string | Y | 手续费 |
| feeCoin | string | Y | 手续费币种 |
6. 查询当前委托订单¶
HTTP请求
POST: /api/spot/v1/order/pending/list
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| symbol | string | Y | 币对 |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object[] | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单ID |
| userId | string | Y | 用户ID |
| orderType | string | Y | 订单类型，1.限价，2.市价 |
| amount | string | Y | 委托总价值 (计价币) |
| dealAmount | string | Y | 成交数量 |
| volume | string | Y | 已成交价值 (计价币) |
| leftAmount | string | Y | 剩余价值 (计价币) |
| volume | string | Y | 委托数量 (基准币) |
| dealVolume | string | Y | 已成交数量 (基准币) |
| leftVolume | string | Y | 剩余数量 (基准币) |
| status | string | Y | 订单状态（1未成交,2已成交,3部分成交,4已撤单,7部分成交/已撤单） |
| type | string | Y | 1.限价，2.市价 |
| side | string | Y | 交易方向(1卖出2买入) |
| price | string | Y | 委托价格 |
| avgPrice | string | Y | 平均成交价格 |
| progress | string | Y | 成交百分比 单位为1% 15.8为15.8% |
| ctime | string | Y | 订单创建时间 |
| utime | string | Y | 订单修改时间 |
| base | string | Y | 基准币 |
| quote | string | Y | 计价币 |
| symbol | string | Y | 币对 |
| fee | string | Y | 手续费 |
| feeCoin | string | Y | 手续费币种 |
7. 查询订单详情¶
HTTP请求
GET: /api/spot/v1/order/detail
请求参数
| 参数名 | 参数类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单ID |
返回数据
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| code | number | Y | 错误码 |
| msg | string | Y | 说明 |
| data | object[] | N | 订单信息 |
data
| 名称 | 类型 | 必须 | 备注 |
|---|---|---|---|
| orderId | string | Y | 订单ID |
| userId | string | Y | 用户ID |
| orderType | string | Y | 订单类型，1.限价，2.市价 |
| amount | string | Y | 委托总价值 (计价币) |
| dealAmount | string | Y | 成交数量 |
| volume | string | Y | 已成交价值 (计价币) |
| leftAmount | string | Y | 剩余价值 (计价币) |
| volume | string | Y | 委托数量 (基准币) |
| dealVolume | string | Y | 已成交数量 (基准币) |
| leftVolume | string | Y | 剩余数量 (基准币) |
| status | string | Y | 订单状态（1未成交,2已成交,3部分成交,4已撤单,7部分成交/已撤单） |
| type | string | Y | 1.限价，2.市价 |
| side | string | Y | 交易方向(1卖出2买入) |
| price | string | Y | 委托价格 |
| avgPrice | string | Y | 平均成交价格 |
| progress | string | Y | 成交百分比 单位为1% 15.8为15.8% |
| ctime | string | Y | 订单创建时间 |
| utime | string | Y | 订单修改时间 |
| base | string | Y | 基准币 |
| quote | string | Y | 计价币 |
| symbol | string | Y | 币对 |
| fee | string | Y | 手续费 |
| feeCoin | string | Y | 手续费币种 |