Sign in

v1

latestSwagger 2.02026-07-179553242.0 KB
Instrument

Get instruments.

This returns all instruments and indices, including those that have settled or are unlisted. Use this endpoint if you want to query for individual instruments or use a complex filter. Use /instrument/active to return active instruments, or use a filter like {"state": "Open"}.

The instrument type is specified by the typ param.

  • Perpetual Contracts - FFWCSX
  • Perpetual Contracts (FX underliers) - FFWCSF
  • Spot - IFXXXP
  • Futures - FFCCSX
  • BitMEX Basket Index - MRBXXX
  • BitMEX Crypto Index - MRCXXX
  • BitMEX FX Index - MRFXXX
  • BitMEX Lending/Premium Index - MRRXXX
  • BitMEX Volatility Index - MRIXXX
get/instrument

Query parameters

symbolstring

Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

You can also send a timeframe, e.g. XBT:quarterly. Timeframes are nearest, daily, weekly, monthly, quarterly, biquarterly, and perpetual.

Symbols are case-insensitive.

filterstring JSON

Generic table filter. Send JSON key/value pairs, such as {"key": "value"}. You can key on individual fields, and do more advanced querying on timestamps. See the Timestamp Docs for more details.

columnsstring JSON

Array of column names to fetch. If omitted, will return all columns.

Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.

countinteger

Number of results to fetch. Must be a positive integer.

startinteger

Starting point for results.

reverseboolean

If true, will sort results newest first.

startTimestring date-time

Starting date filter for results.

endTimestring date-time

Ending date filter for results.

Response

Request was successful

symbolstring required
rootSymbolstring
statestring
typstring
listingstring date-time
frontstring date-time
expirystring date-time
settlestring date-time
listedSettlestring date-time
positionCurrencystring
underlyingstring
quoteCurrencystring
underlyingSymbolstring
referencestring
referenceSymbolstring
calcIntervalstring date-time
publishIntervalstring date-time
publishTimestring date-time
maxOrderQtyinteger
maxPricenumber double
lotSizeinteger
tickSizenumber double
multiplierinteger
settlCurrencystring
underlyingToPositionMultiplierinteger
underlyingToSettleMultiplierinteger
quoteToSettleMultiplierinteger
isQuantoboolean
isInverseboolean
initMarginnumber double
maintMarginnumber double
riskLimitinteger
riskStepinteger
limitnumber double
taxedboolean
deleverageboolean
makerFeenumber double
takerFeenumber double
settlementFeenumber double
fundingBaseSymbolstring
fundingQuoteSymbolstring
fundingPremiumSymbolstring
fundingTimestampstring date-time
fundingIntervalstring date-time
fundingRatenumber double
indicativeFundingRatenumber double
rebalanceTimestampstring date-time
rebalanceIntervalstring date-time
prevClosePricenumber double
limitDownPricenumber double
limitUpPricenumber double
totalVolumeinteger
volumeinteger
volume24hinteger
prevTotalTurnoverinteger
totalTurnoverinteger
turnoverinteger
turnover24hinteger
homeNotional24hnumber double
foreignNotional24hnumber double
prevPrice24hnumber double
vwapnumber double
highPricenumber double
lowPricenumber double
lastPricenumber double
lastPriceProtectednumber double
lastTickDirectionstring
lastChangePcntnumber double
bidPricenumber double
midPricenumber double
askPricenumber double
impactBidPricenumber double
impactMidPricenumber double
impactAskPricenumber double
hasLiquidityboolean
openInterestinteger
openValueinteger
fairMethodstring
fairBasisRatenumber double
fairBasisnumber double
fairPricenumber double
markMethodstring
markPricenumber double
indicativeSettlePricenumber double
settledPriceAdjustmentRatenumber double
settledPricenumber double
instantPnlboolean
minTicknumber double
timestampstring date-time

Example response

[
  {
    "totalVolume": 9,
    "symbol": "symbol",
    "listedSettle": "2000-01-23T04:56:07.000+00:00",
    "vwap": 6.878052220127876,
    "typ": "typ",
    "reference": "reference",
    "deleverage": true,
    "prevTotalTurnover": 9,
    "riskLimit": 4,
    "fundingBaseSymbol": "fundingBaseSymbol",
    "prevPrice24h": 6.778324963048013,
    "limit": 1.2315135367772556,
    "highPrice": 5.944895607614016,
    "fairMethod": "fairMethod",
    "taxed": true,
    "state": "state",
    "expiry": "2000-01-23T04:56:07.000+00:00",
    "fundingPremiumSymbol": "fundingPremiumSymbol",
    "publishInterval": "2000-01-23T04:56:07.000+00:00",
    "calcInterval": "2000-01-23T04:56:07.000+00:00",
    "lastChangePcnt": 7.143538047012306,
    "publishTime": "2000-01-23T04:56:07.000+00:00",
    "askPrice": 6.519180951018382,
    "maintMargin": 2.027123023002322,
    "takerFee": 1.4894159098541704,
    "multiplier": 5,
    "fairBasis": 7.04836565559697,
    "volume24h": 8,
    "settlementFee": 6.84685269835264,
    "totalTurnover": 6,
    "turnover24h": 6,
    "underlying": "underlying",
    "quoteToSettleMultiplier": 9,
    "fairPrice": 5.533258397034986,
    "bidPrice": 0.8851374739011653,
    "fundingQuoteSymbol": "fundingQuoteSymbol",
    "quoteCurrency": "quoteCurrency",
    "volume": 6,
    "impactMidPrice": 4.652396432933246,
    "indicativeSettlePrice": 4.078845849666752,
    "settledPrice": 6.628464275087742,
    "maxOrderQty": 0,
    "prevClosePrice": 4.965218492984954,
    "maxPrice": 6.027456183070403,
    "underlyingToPositionMultiplier": 2,
    "hasLiquidity": true,
    "openInterest": 7,
    "instantPnl": true,
    "riskStep": 7,
    "settle": "2000-01-23T04:56:07.000+00:00",
    "isQuanto": true,
    "rootSymbol": "rootSymbol",
    "tickSize": 5.962133916683182,
    "markMethod": "markMethod",
    "markPrice": 3.2588565619047607,
    "underlyingSymbol": "underlyingSymbol",
    "fundingTimestamp": "2000-01-23T04:56:07.000+00:00",
    "settlCurrency": "settlCurrency",
    "makerFee": 1.0246457001441578,
    "lowPrice": 6.704019297950036,
    "underlyingToSettleMultiplier": 7,
    "fundingInterval": "2000-01-23T04:56:07.000+00:00",
    "listing": "2000-01-23T04:56:07.000+00:00",
    "indicativeFundingRate": 1.1730742509559433,
    "turnover": 3,
    "positionCurrency": "positionCurrency",
    "timestamp": "2000-01-23T04:56:07.000+00:00",
    "impactAskPrice": 8.969578798196912,
    "referenceSymbol": "referenceSymbol",
    "limitDownPrice": 5.025004791520295,
    "lastTickDirection": "lastTickDirection",
    "homeNotional24h": 1.284659006116532,
    "openValue": 3,
    "isInverse": true,
    "lotSize": 1,
    "minTick": 4.258773108174356,
    "settledPriceAdjustmentRate": 0.2025324113236393,
    "rebalanceTimestamp": "2000-01-23T04:56:07.000+00:00",
    "fairBasisRate": 3.0576100241049344,
    "lastPriceProtected": 3.0937452626664474,
    "midPrice": 7.058770351582356,
    "foreignNotional24h": 2.8841621266687802,
    "impactBidPrice": 0.10263654006109402,
    "initMargin": 3.616076749251911,
    "limitUpPrice": 9.965781217890562,
    "front": "2000-01-23T04:56:07.000+00:00",
    "rebalanceInterval": "2000-01-23T04:56:07.000+00:00",
    "fundingRate": 7.457744773683766,
    "lastPrice": 3.353193347011243
  }
]