现货接口

创建一个现货订单

post
Body
clientOrderIdstringOptional

客户端自定义OrderID,可不填

typestring · enumOptional

订单类型: LIMIT=限价单, MARKET=市价单

Possible values:
directionstring · enumOptional

订单方向:LONG, SHORT

Possible values:
symbolstringOptional

订单交易对,例如:XBTC

pricenumberOptional

订单价格

quantitynumberOptional

订单数量

fillOrKillbooleanOptional

FOK(Fill or Kill)标志:完全成交或全部取消

immediateOrCancelbooleanOptional

IOC(Immediate or Cancel)标志:立即执行或取消

postOnlybooleanOptional

PostOnly标志:仅做市

hiddenbooleanOptional

Hidden标志:是否隐藏

Responses
200

OK

application/json
Responsestring
post
POST /v1/spots/orders HTTP/1.1
Host: dex-api.benpay.com
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "clientOrderId": "text",
  "type": "LIMIT",
  "direction": "LONG",
  "symbol": "text",
  "price": 1,
  "quantity": 1,
  "fillOrKill": true,
  "immediateOrCancel": true,
  "postOnly": true,
  "hidden": true
}
200

OK

text

取消指定ID或symbol的订单

post
Path parameters
idOrSymbolstringRequired
Responses
200

OK

application/json
Responsestring
post
POST /v1/spots/orders/{idOrSymbol}/cancel HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

text

根据ID查询订单

get
Path parameters
orderIdinteger · int64Required
Responses
200

OK

*/*
get
GET /v1/spots/orders/{orderId} HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "id": 1,
    "clientOrderId": "text",
    "sequenceId": 1,
    "baseCurrencyId": 1,
    "quoteCurrencyId": 1,
    "userId": 1,
    "symbolId": 1,
    "quantity": 1,
    "unfilledQuantity": 1,
    "type": "LIMIT",
    "status": "PENDING",
    "direction": "LONG",
    "features": 1,
    "fillPrice": 1,
    "price": 1,
    "makerFeeRate": 1,
    "takerFeeRate": 1,
    "fee": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "immediateOrCancel": true,
    "fillOrKill": true,
    "postOnly": true,
    "symbol": "text",
    "finalStatus": true
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

根据ID查询订单的成交详情

get
Path parameters
orderIdinteger · int64Required
Responses
200

OK

*/*
get
GET /v1/spots/orders/{orderId}/matches HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": [
    {
      "taker": true,
      "price": 1,
      "quantity": 1,
      "fee": 1,
      "createdAt": 1
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询所有活动订单

get
Responses
200

OK

*/*
get
GET /v1/spots/orders/open HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": [
    {
      "id": 1,
      "clientOrderId": "text",
      "sequenceId": 1,
      "baseCurrencyId": 1,
      "quoteCurrencyId": 1,
      "userId": 1,
      "symbolId": 1,
      "quantity": 1,
      "unfilledQuantity": 1,
      "type": "LIMIT",
      "status": "PENDING",
      "direction": "LONG",
      "features": 1,
      "fillPrice": 1,
      "price": 1,
      "makerFeeRate": 1,
      "takerFeeRate": 1,
      "fee": 1,
      "createdAt": 1,
      "updatedAt": 1,
      "immediateOrCancel": true,
      "fillOrKill": true,
      "postOnly": true,
      "symbol": "text",
      "finalStatus": true
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

根据ID查询活动订单

get
Path parameters
orderIdinteger · int64Required
Responses
200

OK

*/*
get
GET /v1/spots/orders/open/{orderId} HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "id": 1,
    "clientOrderId": "text",
    "sequenceId": 1,
    "baseCurrencyId": 1,
    "quoteCurrencyId": 1,
    "userId": 1,
    "symbolId": 1,
    "quantity": 1,
    "unfilledQuantity": 1,
    "type": "LIMIT",
    "status": "PENDING",
    "direction": "LONG",
    "features": 1,
    "fillPrice": 1,
    "price": 1,
    "makerFeeRate": 1,
    "takerFeeRate": 1,
    "fee": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "immediateOrCancel": true,
    "fillOrKill": true,
    "postOnly": true,
    "symbol": "text",
    "finalStatus": true
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

按月查询历史订单

get
Query parameters
rangestringOptional

查询范围,如2025年2月传入:202502

Example: 202502
symbolstringOptional

交易对名称

Example: BTC_USD
fromMillisnumberOptional

起始时间毫秒数

Default: 0Example: 1738339200000
toMillisnumberOptional

结束时间毫秒数

Default: 0Example: 1739894400000
offsetIdnumberOptional

订单id偏移量(上次查询返回的nextOffsetId)

Default: 0Example: 0
limitnumberOptional

分页大小

Default: 0Example: 100
Responses
200

OK

*/*
get
GET /v1/spots/orders/closed HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "clientOrderId": "text",
        "sequenceId": 1,
        "baseCurrencyId": 1,
        "quoteCurrencyId": 1,
        "userId": 1,
        "symbolId": 1,
        "quantity": 1,
        "unfilledQuantity": 1,
        "type": "LIMIT",
        "status": "PENDING",
        "direction": "LONG",
        "features": 1,
        "fillPrice": 1,
        "price": 1,
        "makerFeeRate": 1,
        "takerFeeRate": 1,
        "fee": 1,
        "createdAt": 1,
        "updatedAt": 1,
        "immediateOrCancel": true,
        "fillOrKill": true,
        "postOnly": true,
        "symbol": "text",
        "finalStatus": true
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

分页查询用户订单的清算记录

get
Query parameters
rangestringOptional

查询范围(数据分片)

Example: 202502
symbolstringOptional

交易对名称

Example: BTC_USD
directionstringOptional

方向.LONG/SHORT/空字符串

Example: LONG
fromMillisnumberOptional

起始时间毫秒数

Default: 0LExample: 1738339200000
toMillisnumberOptional

结束时间毫秒数

Default: 0LExample: 1739894400000
offsetIdnumberOptional

订单id偏移量(上次查询返回的nextOffsetId)

Default: 0Example: 0
limitnumberOptional

分页大小

Default: 0Example: 100
Responses
200

OK

*/*
get
GET /v1/spots/match/clearings HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "orderId": 1,
        "userId": 1,
        "sequenceId": 1,
        "direction": "LONG",
        "type": "MAKER",
        "matchPrice": 1,
        "matchQuantity": 1,
        "orderStatusAfterClearing": "PENDING",
        "orderUnfilledQuantityAfterClearing": 1,
        "feeCurrency": "text",
        "fee": 1,
        "rate": 1,
        "createdAt": 1,
        "symbol": "text"
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询现货交易手续费率

get
Query parameters
symbolstringOptionalDefault: ""
timestampinteger · int64OptionalDefault: 0
Responses
200

OK

*/*
get
GET /v1/spots/fee/rate HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "taker": 1,
    "maker": 1,
    "timestamp": 1
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询现货余额

get
Responses
200

OK

*/*
get
GET /v1/spots/balances HTTP/1.1
Host: dex-api.benpay.com
Accept: */*
200

OK

{
  "success": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": [
      1
    ]
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Last updated