Trading Instruments

Retrieve information about all available trading instruments, including contract specifications and trading rules.

GET /v1/market/instruments

Trading Instruments

cURL

curl --request GET \
  --url https://api.roxom.com/v1/market/instruments \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Signature: <api-key>'

200

{
  "data": {
    "instruments": [
      {
        "baseDecimals": 1,
        "contractSize": 1,
        "id": "<string>",
        "lotSizeFilter": {
          "maxLimitOrderValue": "<string>",
          "maxMarketOrderValue": "<string>",
          "minOrderValue": "<string>",
          "quantityTickSize": "<string>",
          "maxPositionValue": "<string>"
        },
        "priceFilter": {
          "tickSize": "<string>",
          "marketOrderSlippage": "<string>",
          "maxOrderSlippage": "<string>"
        },
        "quoteDecimals": 1,
        "symbol": "<string>",
        "calendarFilter": {
          "calendarId": "<string>",
          "normalSessionEndTime": "<string>",
          "normalSessionStartTime": "<string>",
          "timezone": "<string>"
        },
        "fundingFeeFilter": {
          "fundingFeePeriodMins": 123,
          "fundingFeeRateStep": "<string>",
          "maxFundingFeeRate": "<string>",
          "minFundingFeeRate": "<string>",
          "nextFundingTimeMs": 123
        },
        "marginTradingFilter": {
          "leverageStep": "<string>",
          "maintenanceMarginRatio": "<string>",
          "maxLeverage": "<string>",
          "minLeverage": "<string>"
        }
      }
    ]
  },
  "error": true
}

Authorizations

X-API-Key · string · header · required

Your API key

X-API-Signature · string · header · required

The signature of the request

Query Parameters

instrumentType · enum<string>

Available options: perpetual, spot, btc, digital, stock, index

tradeable · boolean | null

unit · enum<string>

Available options: sats, btc

Response

200 - application/json

Represents a successful API response wrapper

data · object · required

Show child attributes

error · boolean · required