The /instrument
endpoint provides detailed information about tradable contracts on BitMEX. Here's a description of the fields returned:
Field Name |
Data Type |
Description |
---|---|---|
|
|
The contract symbol (e.g., 'XBTUSD'). |
|
|
Root symbol for the instrument, used for grouping on the frontend. |
|
|
State of the instrument (e.g., |
|
|
Type of the instrument (e.g., |
|
|
Date and time the contract was listed (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Front month time (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Date when the instrument expires (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Date when the instrument is expired; always the same as expiry (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Date when the instrument was listed to expired (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Currency for position of this contract. If not null, 1 contract = 1 positionCurrency. |
|
|
Defines the underlying asset of the instrument (e.g. XBT). |
|
|
Currency of the quote price. |
|
|
Symbol of the underlying asset. |
|
|
Venue of the reference symbol. |
|
|
Symbol of index being referenced (e.g. .BXBT). |
|
|
The time between two consecutive calculations. Only available for BTMX reference indices (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
The time between two consecutive publishes. Available for all indices (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
The time of the publish. Only available for BTMX reference indices (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Maximum order quantity - Contract specific and applies to contracts only. |
|
|
Maximum price - Applies to contracts only. |
|
|
Lot size - The minimum unit in an order quantity - Applies to contracts only. |
|
|
Minimum price movement of a trading instrument. |
|
|
Contract-specific multiplier which determines the worth of the contract. |
|
|
Currency that PnL is denominated in (e.g. XBT). |
|
|
Multiplier from underlying currency to position currency. |
|
|
Multiplier from underlying currency to settle currency. |
|
|
Multiplier from quote currency to settle currency. |
|
|
Indicates if the contract is quanto or not. |
|
|
Indicates if the contract is inverse or not. |
|
|
Initial margin requirement - Contract specific. |
|
|
Maintenance margin requirement - Contract specific. |
|
|
The max-leverage Risk Limit for this instrument. |
|
|
When increasing your Risk Limit, the Risk Step is the size that the Risk Limit increases per multiple of the maintenance margin. |
|
|
The limit of daily price change. |
|
|
Depreciated - whether it can be taxed (legacy) |
|
|
Whether it can be deleveraged |
|
|
Maker Fee |
|
|
Taker Fee |
|
|
Settlement Fee rate. |
|
|
Depreciated - Insurance fee rate (legacy). |
|
|
Funding base currency. (Only applies to quanto contracts) |
|
|
Funding quote currency. (Only applies to quanto contracts) |
|
|
Funding premium index. (Only applies to quanto contracts) |
|
|
Next funding time. (Only applies to quanto contracts) (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
The time between two consecutive fundings. (Only applies to quanto contracts) (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
The funding rate (if applicable) of the instrument. |
|
|
Indicative funding rate for the next 8-hour period. |
|
|
Depreciated - Next rebalance time (legacy) (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Depreciated - The time between two consecutive rebalances (legacy) (e.g., ""2020-09-14T02:26:42.916Z""). |
|
|
Close price of the previous trading session. |
|
|
Down limit of the order price. |
|
|
Up limit of the order price. |
|
|
Lifetime volume. |
|
|
Volume of the current trading session. |
|
|
24-hour volume, sum size (trade table) i.e., lastQty from execution. |
|
|
Lifetime turnover up to this session start time. |
|
|
Lifetime turnover. |
|
|
Turnover of the current trading session |
|
|
24-hour turnover, sum grossValue (trade table) i.e., abs execCost from execution. |
|
|
The volume24hr of underlying currency. |
|
|
The volume24hr of quote currency. |
|
|
Price from 24 hours ago. |
|
|
Volume-weighted average price of the last 24 hours. |
|
|
Highest price in the last 24 hours. |
|
|
Lowest price in the last 24 hours. |
|
|
Last price. |
|
|
Last price protected by price band (see https://www.bitmex.com/app/fairPriceMarking#Last-Price-Protected-Marking) |
|
|
The relationship between the last trade’s price and the previous ones (MinusTick, ZeroMinusTick, ZeroPlusTick, PlusTick). |
|
|
Change percentage in the past 24 hours. |
|
|
Last bid price. |
|
|
Average price of bidPrice and askPrice. |
|
|
Last ask price. |
|
|
Impact bid price (see https://www.bitmex.com/app/fairPriceMarking#Impact-Bid-Ask-and-Mid-Price). |
|
|
Impact mid price. |
|
|
Impact ask price. |
|
|
Whether the impact bid and ask prices are within one maintenance margin percentage. |
|
|
Open interest in terms of number of contracts. |
|
|
The open value in the settlement currency of the contract. |
|
|
Method used for fair price calculation, it can be FundingRate or ImpactMidPrice. |
|
|
Fair basis rate annualized. |
|
|
Fair basis. |
|
|
The fair price of the instrument. |
|
|
Method used for mark price, it can be FairPrice or LastPrice or LastPriceProtected. |
|
|
Mark price. |
|
|
This is the price of the index associated with the instrument. |
|
|
|
|
|
The price of the underlying asset for option. Option underlying price. Null for others. |
|
|
Settled price, for settled contracts. Null for others |
|
|
|
|
|
|
|
|
|
|
|
Timestamp (e.g., ""2020-09-14T02:26:42.916Z""). |