Instrument catalogue - Hyperprop Platform API

GET /organization/instruments lists every instrument your organization’s trading accounts can trade, with the specification you need to size orders and value positions. It only includes the markets your organization is enabled for. Requires view permission on traders, so a read-only key can call it.

curl "https://api.hyperprop.com/platform/v1/organization/instruments" \
  -H "X-API-Key: hp_live_your_key_here"

{
  "success": true,
  "data": {
    "markets": ["BINANCE", "CBOT", "CME", "COMEX", "NYMEX"],
    "count": 2,
    "instruments": [
      {
        "id": "8a1d2c3e-4b5f-4a6b-9c7d-0e1f2a3b4c5d",
        "symbol": "BTCUSDT",
        "rootSymbol": "BTC",
        "name": "Bitcoin USDT Perpetual",
        "market": "BINANCE",
        "assetClass": "perpetual",
        "status": "active",
        "quoteCurrency": "USDT",
        "tickSize": 0.1,
        "pointValue": 0.001,
        "tickValue": 0.0001,
        "contractSize": 0.001,
        "sizeUnit": "BTC",
        "quantityPrecision": 3,
        "minQuantity": 1,
        "maxLimitOrderQuantity": 1000000,
        "maxMarketOrderQuantity": 120000,
        "sessionCalendar": "crypto_24x7",
        "expiryDate": null,
        "isFrontMonth": true,
        "perpetual": { "baseAsset": "BTC", "maxLeverage": 125, "minOrderValue": 100, "fundingIntervalHours": 8 }
      },
      {
        "id": "3f0c9a52-6a1e-4d38-9a3c-1b0f2e7d4c11",
        "symbol": "MNQZ6",
        "rootSymbol": "MNQ",
        "name": "Micro E-mini Nasdaq-100",
        "market": "CME",
        "assetClass": "future",
        "status": "active",
        "quoteCurrency": "USD",
        "tickSize": 0.25,
        "pointValue": 2,
        "tickValue": 0.5,
        "contractSize": 1,
        "sizeUnit": "contracts",
        "quantityPrecision": 0,
        "minQuantity": 1,
        "maxLimitOrderQuantity": null,
        "maxMarketOrderQuantity": null,
        "sessionCalendar": "cme",
        "expiryDate": "2026-12-18",
        "isFrontMonth": true,
        "perpetual": null
      }
    ]
  }
}

Fields

Field	Description
`symbol`	The symbol orders, positions, fills and the real-time stream use
`rootSymbol`	Product root for futures (`MNQ`), base asset for perpetuals (`BTC`)
`market`	`CME`, `CBOT`, `NYMEX`, `COMEX`, `BINANCE`, `HYPERLIQUID` or `HDL`
`assetClass`	`future` or `perpetual`
`status`	`active` instruments can be traded
`quoteCurrency`	The currency of prices, `pointValue`, `tickValue` and P&L. Futures are in `USD`; a perpetual uses its quote asset
`tickSize`	Minimum price increment
`pointValue`	Value of a 1.0 price move for one unit of quantity, in `quoteCurrency`
`tickValue`	Value of one tick for one unit of quantity: `tickSize × pointValue`
`contractSize`, `sizeUnit`	One unit of quantity is `contractSize` `sizeUnit`: 1 contract for futures, for example 0.001 BTC for a perpetual
`quantityPrecision`	Decimals to show a size in `sizeUnit` with
`minQuantity`	Smallest order, in units of quantity
`maxLimitOrderQuantity`, `maxMarketOrderQuantity`	Largest single limit and market order, in units of quantity. `null` means the instrument sets no limit; a trading rule can still limit sizes per account
`sessionCalendar`	Trading hours: `cme` follows the CME Globex futures sessions (closed at weekends and during the daily break), `crypto_24x7` trades around the clock
`expiryDate`	Futures expiry date; `null` for perpetuals
`perpetual`	Perpetuals only: `baseAsset`, `maxLeverage` (a plan can set a lower one), `minOrderValue` in `quoteCurrency`, `fundingIntervalHours`

Quantities and values

Order and position quantity is always a whole number of units:

size in sizeUnit = quantity × contractSize
unrealized P&L    = (price − entry price) × quantity × pointValue      (long; reversed for short)

A quantity of 500 on BTCUSDT is 0.5 BTC; on MNQZ6 it is 500 contracts. Read contractSize and pointValue from the catalogue rather than hard-coding them.

Filters

Query parameter	Description
`market`	Only this market, for example `CME` (case-insensitive)
`assetClass`	`future` or `perpetual`
`includeInactive`	`true` also lists instruments that can no longer be traded, such as expired futures

Keeping it current

Futures roll to new contract months, so refresh the list at least once a day instead of storing symbols permanently. Responses can be up to a minute old. The list is short enough to fetch in one call; it isn’t paginated.

⌘I