合约接口

设定仓位模式与杠杆率

post

Path parameters

symbolstringRequired

Body

application/json

crossbooleanOptional

仓位类型：true=全仓，false=逐仓

leverageinteger · int32Optional

仓位杠杆率：1~上限

Responses

200

OK

application/json

stringOptional

post

/v1/contracts/positions/{symbol}/settings

HTTPcURLJavaScriptPython

POST /v1/contracts/positions/{symbol}/settings HTTP/1.1
Host: dex-api.benpay.com
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "cross": true,
  "leverage": 1
}

200

OK

text

对一个仓位保证金进行转入或转出

post

Path parameters

symbolstringRequired

Body

application/json

addMarginnumberOptional

增加或移除的保证金，负数表示移除

Responses

200

OK

application/json

stringOptional

post

/v1/contracts/positions/{symbol}/margin

HTTPcURLJavaScriptPython

POST /v1/contracts/positions/{symbol}/margin HTTP/1.1
Host: dex-api.benpay.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "addMargin": 1
}

200

OK

text

创建一个订单

post

Body

application/json

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标志：是否隐藏

reduceOnlybooleanOptional

ReduceOnly标志：仅减仓，不会反向开仓

Responses

200

OK

application/json

stringOptional

post

/v1/contracts/orders

HTTPcURLJavaScriptPython

POST /v1/contracts/orders HTTP/1.1
Host: dex-api.benpay.com
Content-Type: application/json
Accept: */*
Content-Length: 188

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

200

OK

text

取消指定ID或symbol的订单

post

Path parameters

idOrSymbolstringRequired

Responses

200

OK

application/json

stringOptional

post

/v1/contracts/orders/{idOrSymbol}/cancel

HTTPcURLJavaScriptPython

POST /v1/contracts/orders/{idOrSymbol}/cancel HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

text

取消全部订单

post

Query parameters

symbolstringOptionalDefault: ""

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

post

/v1/contracts/orders/cancel

HTTPcURLJavaScriptPython

POST /v1/contracts/orders/cancel HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

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

当前所有用户未平仓头寸的总额

get

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/market/positions

HTTPcURLJavaScriptPython

GET /v1/market/positions HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

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

查询所有仓位

get

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/positions

HTTPcURLJavaScriptPython

GET /v1/contracts/positions HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

{
  "success": true,
  "data": [
    {
      "id": "text",
      "symbolId": 1,
      "userId": 1,
      "cross": true,
      "leverage": 1,
      "riskLevel": 1,
      "maxQuantity": 1,
      "margin": 1,
      "realizedPNL": 1,
      "symbol": "text",
      "liquidationPrice": 1,
      "createdAt": 1,
      "updatedAt": 1,
      "direction": "LONG",
      "quantity": 1,
      "entryPrice": 1,
      "minimumMaintenanceMarginRate": 1,
      "empty": true
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

根据Symbol查询仓位，返回null表示没有初始化仓位

get

Path parameters

symbolstringRequired

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/positions/{symbol}

HTTPcURLJavaScriptPython

GET /v1/contracts/positions/{symbol} HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "id": "text",
    "symbolId": 1,
    "userId": 1,
    "cross": true,
    "leverage": 1,
    "riskLevel": 1,
    "maxQuantity": 1,
    "margin": 1,
    "realizedPNL": 1,
    "symbol": "text",
    "liquidationPrice": 1,
    "createdAt": 1,
    "updatedAt": 1,
    "direction": "LONG",
    "quantity": 1,
    "entryPrice": 1,
    "minimumMaintenanceMarginRate": 1,
    "empty": true
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

根据订单ID查询订单

get

Path parameters

orderIdinteger · int64Required

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/orders/{orderId}

HTTPcURLJavaScriptPython

GET /v1/contracts/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,
    "frozenMargin": 1,
    "frozenQuantity": 1,
    "finalStatus": true
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询订单成交记录

get

Path parameters

orderIdinteger · int64Required

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/orders/{orderId}/matches

HTTPcURLJavaScriptPython

GET /v1/contracts/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

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/orders/open

HTTPcURLJavaScriptPython

GET /v1/contracts/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,
      "frozenMargin": 1,
      "frozenQuantity": 1,
      "finalStatus": true
    }
  ],
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

根据订单ID查询活动订单

get

Path parameters

orderIdinteger · int64Required

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/orders/open/{orderId}

HTTPcURLJavaScriptPython

GET /v1/contracts/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,
    "frozenMargin": 1,
    "frozenQuantity": 1,
    "finalStatus": true
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询历史订单

get

Query parameters

rangestringOptionalDefault: ""

symbolstringOptionalDefault: ""

offsetIdinteger · int64OptionalDefault: 0

limitinteger · int32OptionalDefault: 100

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/orders/closed

HTTPcURLJavaScriptPython

GET /v1/contracts/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,
        "frozenMargin": 1,
        "frozenQuantity": 1,
        "finalStatus": true
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

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

get

Query parameters

rangestringOptional

查询范围(数据分片)

Example: 202502

symbolstringOptional

交易对名称

Example: XBTC

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

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/match/clearings

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "orderId": 1,
        "counterOrderId": 1,
        "type": "TAKER",
        "sequenceId": 1,
        "userId": 1,
        "counterUserId": 1,
        "symbolId": 1,
        "price": 1,
        "quantity": 1,
        "direction": "LONG",
        "feeCurrencyId": 1,
        "fee": 1,
        "orderCreatedAt": 1,
        "createdAt": 1
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

分页查询用户资金流水记录

get

Query parameters

rangestringOptional

查询范围(数据分片)

Example: 202502

fromMillisnumberOptional

起始时间毫秒数

Default: 0LExample: 1738339200000

toMillisnumberOptional

结束时间毫秒数

Default: 0LExample: 1739894400000

offsetIdstringOptional

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

Default: 0Example: 0

limitnumberOptional

分页大小

Default: 0Example: 100

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/fund/flows

HTTPcURLJavaScriptPython

GET /v1/contracts/fund/flows HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": "text",
    "results": [
      {
        "createdAt": 1,
        "type": "text",
        "changed": 1,
        "currencyId": 1,
        "symbolId": 1
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

查询期货交易手续费率

get

Query parameters

symbolstringOptionalDefault: ""

timestampinteger · int64OptionalDefault: 0

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/fee/rate

HTTPcURLJavaScriptPython

GET /v1/contracts/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

*/*

successbooleanOptional

请求是否成功

datanumber[]Optional

响应数据，如果请求失败则为null

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/balances

HTTPcURLJavaScriptPython

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

200

OK

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

查询仓位清算历史记录

get

Query parameters

rangestringOptionalDefault: ""

symbolstringOptionalDefault: ""

typestringOptionalDefault: ""

directionstringOptional

offsetIdinteger · int64OptionalDefault: 0

limitinteger · int32OptionalDefault: 100

Responses

200

OK

*/*

successbooleanOptional

请求是否成功

errorstringOptional

如果请求失败，指示错误代码

errorFieldstringOptional

如果请求失败，指示出错的字段

errorMessagestringOptional

如果请求失败，指示详细错误信息

get

/v1/contracts/clearings/positions

HTTPcURLJavaScriptPython

GET /v1/contracts/clearings/positions HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

{
  "success": true,
  "data": {
    "hasMore": true,
    "nextOffsetId": 1,
    "results": [
      {
        "id": 1,
        "orderId": 1,
        "counterOrderId": 1,
        "userId": 1,
        "counterUserId": 1,
        "symbolId": 1,
        "sequenceId": 1,
        "direction": "LONG",
        "type": "OPEN",
        "clearingPrice": 1,
        "fee": 1,
        "rate": 1,
        "quantityChanged": 1,
        "quantityAfterClearing": 1,
        "realizedPNLChanged": 1,
        "createdAt": 1
      }
    ],
    "range": "text"
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}