Market Data API

Get all asset trading pairs

get

Responses

200

OK

*/*

get

/v1/market/trades

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "currencies": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "spotsSymbols": [
      {
        "id": 1,
        "name": "text",
        "startTime": 1,
        "endTime": 1,
        "baseName": "text",
        "baseMinimumIncrement": 1,
        "baseScale": 1,
        "baseMaximumQuantity": 1,
        "quoteName": "text",
        "quoteMinimumIncrement": 1,
        "quoteScale": 1
      }
    ],
    "contractsSymbols": [
      {
        "id": 1,
        "name": "text",
        "startTime": 1,
        "endTime": 1,
        "baseName": "text",
        "baseMinimumIncrement": 1,
        "baseScale": 1,
        "baseMaximumQuantity": 1,
        "quoteName": "text",
        "quoteMinimumIncrement": 1,
        "quoteScale": 1,
        "type": "FUTURES",
        "riskLimit": {
          "id": 1,
          "initialMarginRate": 1,
          "maintenanceMarginRate": 1,
          "marginRateStep": 1,
          "maxLeverage": 1,
          "riskLimitBase": 1,
          "riskLimitStep": 1,
          "maxRiskLimitSteps": 1,
          "maxQuantity": 1,
          "createdAt": 1
        },
        "settlementFeeRate": 1
      }
    ]
  },
  "error": "text",
  "errorField": "text",
  "errorMessage": "text"
}

Get server timestamp

get

Responses

200

OK

*/*

get

/v1/market/timestamp

HTTPcURLJavaScriptPython

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

200

OK

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

Get latest trade data for trading pair

get

Path parameters

symbolstringRequired

Query parameters

maxResultsinteger · int32OptionalDefault: 100

Responses

200

OK

application/json

Responsestring

get

/v1/market/ticks/{symbol}

HTTPcURLJavaScriptPython

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

200

OK

text

Get market prices of coins (24h)

get

Responses

200

OK

*/*

get

/v1/market/prices

HTTPcURLJavaScriptPython

GET /v1/market/prices 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 K-line data for trading pair

get

Path parameters

symbolstringRequired

typestringRequired

Query parameters

startinteger · int64OptionalDefault: 0

endinteger · int64OptionalDefault: 0

Responses

200

OK

application/json

Responsestring

get

/v1/market/bars/{symbol}/{type}

HTTPcURLJavaScriptPython

GET /v1/market/bars/{symbol}/{type} HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

text

Get order book for trading pair

get

Path parameters

symbolstringRequired

Query parameters

depthinteger · int32OptionalDefault: 25

Responses

200

OK

application/json

Responsestring

get

/v1/market/orderBook/{symbol}

HTTPcURLJavaScriptPython

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

200

OK

text

Get latest prices for all indexes

get

Responses

200

OK

application/json

Responsestring

get

/v1/market/indexes

HTTPcURLJavaScriptPython

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

200

OK

text

Get historical prices for an index

get

Path parameters

namestringRequired

Query parameters

startinteger · int64OptionalDefault: 0

endinteger · int64OptionalDefault: 0

limitinteger · int32OptionalDefault: 1000

Responses

200

OK

*/*

get

/v1/market/indexes/{name}

HTTPcURLJavaScriptPython

GET /v1/market/indexes/{name} HTTP/1.1
Host: dex-api.benpay.com
Accept: */*

200

OK

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

Get the value of an index

get

Query parameters

namestringOptionalDefault: .BTC_FUNDING_8H

Responses

200

OK

*/*

get

/v1/market/indexes/indexValue

HTTPcURLJavaScriptPython

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

200

OK

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

Get latest index prices for perpetual trading

get

Responses

200

OK

*/*

get

/v1/market/indexPrices

HTTPcURLJavaScriptPython

GET /v1/market/indexPrices 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 all error codes

get

Responses

200

OK

application/json

get

/v1/market/errorCodes

HTTPcURLJavaScriptPython

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

200

OK

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