---
title: "Get instruments."
method: GET
path: "/instrument"
tags: ["Instrument"]
---

# Get instruments.

`GET /instrument`

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`

## Query parameters

- `symbol` string
- `filter` string, JSON
- `columns` string, JSON
- `count` integer
- `start` integer
- `reverse` boolean
- `startTime` string, date-time
- `endTime` string, date-time

## Response `200`

Request was successful

- Instrument[]
  - `symbol` string, required
  - `rootSymbol` string
  - `state` string
  - `typ` string
  - `listing` string, date-time
  - `front` string, date-time
  - `expiry` string, date-time
  - `settle` string, date-time
  - `listedSettle` string, date-time
  - `positionCurrency` string
  - `underlying` string
  - `quoteCurrency` string
  - `underlyingSymbol` string
  - `reference` string
  - `referenceSymbol` string
  - `calcInterval` string, date-time
  - `publishInterval` string, date-time
  - `publishTime` string, date-time
  - `maxOrderQty` integer
  - `maxPrice` number, double
  - `lotSize` integer
  - `tickSize` number, double
  - `multiplier` integer
  - `settlCurrency` string
  - `underlyingToPositionMultiplier` integer
  - `underlyingToSettleMultiplier` integer
  - `quoteToSettleMultiplier` integer
  - `isQuanto` boolean
  - `isInverse` boolean
  - `initMargin` number, double
  - `maintMargin` number, double
  - `riskLimit` integer
  - `riskStep` integer
  - `limit` number, double
  - `taxed` boolean
  - `deleverage` boolean
  - `makerFee` number, double
  - `takerFee` number, double
  - `settlementFee` number, double
  - `fundingBaseSymbol` string
  - `fundingQuoteSymbol` string
  - `fundingPremiumSymbol` string
  - `fundingTimestamp` string, date-time
  - `fundingInterval` string, date-time
  - `fundingRate` number, double
  - `indicativeFundingRate` number, double
  - `rebalanceTimestamp` string, date-time
  - `rebalanceInterval` string, date-time
  - `prevClosePrice` number, double
  - `limitDownPrice` number, double
  - `limitUpPrice` number, double
  - `totalVolume` integer
  - `volume` integer
  - `volume24h` integer
  - `prevTotalTurnover` integer
  - `totalTurnover` integer
  - `turnover` integer
  - `turnover24h` integer
  - `homeNotional24h` number, double
  - `foreignNotional24h` number, double
  - `prevPrice24h` number, double
  - `vwap` number, double
  - `highPrice` number, double
  - `lowPrice` number, double
  - `lastPrice` number, double
  - `lastPriceProtected` number, double
  - `lastTickDirection` string
  - `lastChangePcnt` number, double
  - `bidPrice` number, double
  - `midPrice` number, double
  - `askPrice` number, double
  - `impactBidPrice` number, double
  - `impactMidPrice` number, double
  - `impactAskPrice` number, double
  - `hasLiquidity` boolean
  - `openInterest` integer
  - `openValue` integer
  - `fairMethod` string
  - `fairBasisRate` number, double
  - `fairBasis` number, double
  - `fairPrice` number, double
  - `markMethod` string
  - `markPrice` number, double
  - `indicativeSettlePrice` number, double
  - `settledPriceAdjustmentRate` number, double
  - `settledPrice` number, double
  - `instantPnl` boolean
  - `minTick` number, double
  - `timestamp` string, date-time

## Other responses

- `400` — Parameter Error
- `401` — Unauthorized
- `403` — Access Denied
- `404` — Not Found

## Changes

- **2019-12-18** `fd2de3a82a03` — 1 info
  - added the non-success response with the status `403`
- **2018-05-30** `0c1c991454e3` — 1 info
  - removed the non-success response with the status `403`

[Change history](https://skmtc.dev/bitmex/apis/bitmex-api/changes/instrument/get.md)

---

[API](https://skmtc.dev/bitmex/apis/bitmex-api.md) · [All operations](https://skmtc.dev/bitmex/apis/bitmex-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bitmex/bitmex-api/revisions/04c6a16ffd27/schema)