Get instruments
GET/instruments
Returns specifications for all currently listed markets and indices.
Request
Query Parameters
Possible values: [futures_inverse
, futures_vanilla
, flexible_futures
]
Contract type(s) to return statuses for.
By default, includes all futures instrument types.
Multi-value example: ?contractType=futures_inverse&contractType=futures_vanilla
Responses
- 200
- application/json
- Schema
- success
Schema
- Success Response
- ErrorResponse
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
flexible_futures
futures_inverse
futures_vanilla
- ]
accountInactive
: The Futures account the request refers to is inactiveapiLimitExceeded
: The API limit for the calling IP address has been exceededauthenticationError
: The request could not be authenticatedinsufficientFunds
: The amount requested for transfer is below the amount of funds availableinvalidAccount
: The Futures account the transfer request refers to is invalidinvalidAmount
: The amount the transfer request refers to is invalidinvalidArgument
: One or more arguments provided are invalidinvalidUnit
: The unit the transfer request refers to is invalidJson Parse Error
: The request failed to pass valid JSON as an argumentmarketUnavailable
: The market is currently unavailablenonceBelowThreshold
: The provided nonce is below the thresholdnonceDuplicate
: The provided nonce is a duplicate as it has been used in a previous requestnotFound
: The requested information could not be foundrequiredArgumentMissing
: One or more required arguments are missingServer Error
: There was an error processing the requestUnavailable
: The endpoint being called is unavailableunknownError
: An unknown error has occurred
instruments object[]required
A list containing structures for each available instrument. The list is in no particular order.
'Category of the contract: "Layer 1", "Layer 2", "DeFi", or "Privacy" (multi-collateral contracts only).'
For futures: The contract size of the Futures
For indices: Not returned because N/A
Trade precision for the contract (e.g. trade precision of 2 means trades are precise to the hundredth decimal place 0.01).
Amount of contract used to calculated the mid price for the mark price
Single-collateral contracts only: Contract's ISIN code
marginSchedules object
For futures: A map containing margin schedules by platform.
For indices: Not returned because N/A.
property name* MarginSchedule
retail object[]required
For futures: The lower limit of the number of contracts to which this margin level applies
For indices: Not returned because N/A
For futures: The lower limit of the number of non-contract units (i.e. quote currency units for linear futures) to which this margin level applies
For indices: Not returned because N/A.
For futures: The initial margin requirement for this level
For indices: Not returned because N/A
For futures: The maintenance margin requirement for this level
For indices: Not returned because N/A
professional object[]required
For futures: The lower limit of the number of contracts to which this margin level applies
For indices: Not returned because N/A
For futures: The lower limit of the number of non-contract units (i.e. quote currency units for linear futures) to which this margin level applies
For indices: Not returned because N/A.
For futures: The initial margin requirement for this level
For indices: Not returned because N/A
For futures: The maintenance margin requirement for this level
For indices: Not returned because N/A
retailMarginLevels object[]
Margin levels for retail clients.
For futures: The lower limit of the number of contracts to which this margin level applies
For indices: Not returned because N/A
For futures: The lower limit of the number of non-contract units (i.e. quote currency units for linear futures) to which this margin level applies
For indices: Not returned because N/A.
For futures: The initial margin requirement for this level
For indices: Not returned because N/A
For futures: The maintenance margin requirement for this level
For indices: Not returned because N/A
marginLevels object[]
Margin levels for professional clients.
For futures: The lower limit of the number of contracts to which this margin level applies
For indices: Not returned because N/A
For futures: The lower limit of the number of non-contract units (i.e. quote currency units for linear futures) to which this margin level applies
For indices: Not returned because N/A.
For futures: The initial margin requirement for this level
For indices: Not returned because N/A
For futures: The maintenance margin requirement for this level
For indices: Not returned because N/A
Maximum number of contracts that one can hold in a position
Perpetuals only: the absolute value of the maximum permissible funding rate
When the contract was first available for trading
True if the instrument is in post-only mode, false otherwise.
Unique identifier of fee schedule associated with the instrument
Market symbol.
Asset pair.
Base asset.
Quote asset.
Tag for the contract (currently does not return a value).
Tick size of the contract being traded.
True if the instrument can be traded, False otherwise.
Possible values: [flexible_futures
, futures_inverse
, futures_vanilla
]
The type of the instrument:
For futures: The underlying of the Futures
For indices: Not returned because N/A
For options: The underlying future of the option. Otherwise null.
True if this is a non-crypto market.
True if currently has MTF status.
Possible values: [success
]
Server time in Coordinated Universal Time (UTC)
Possible values: [accountInactive
, apiLimitExceeded
, authenticationError
, insufficientFunds
, invalidAccount
, invalidAmount
, invalidArgument
, invalidUnit
, Json Parse Error
, marketUnavailable
, nonceBelowThreshold
, nonceDuplicate
, notFound
, requiredArgumentMissing
, Server Error
, Unavailable
, unknownError
]
Possible values: [accountInactive
, apiLimitExceeded
, authenticationError
, insufficientFunds
, invalidAccount
, invalidAmount
, invalidArgument
, invalidUnit
, Json Parse Error
, marketUnavailable
, nonceBelowThreshold
, nonceDuplicate
, notFound
, requiredArgumentMissing
, Server Error
, Unavailable
, unknownError
]
Error description.
Possible values: [error
]
Server time in Coordinated Universal Time (UTC)
{
"instruments": [
{
"symbol": "PI_XBTUSD",
"pair": "XBT:USD",
"base": "XBT",
"quote": "USD",
"type": "futures_inverse",
"underlying": "rr_xbtusd",
"tickSize": 0.5,
"contractSize": 1,
"tradeable": true,
"impactMidSize": 1,
"maxPositionSize": 1000000,
"openingDate": "2022-01-01T00:00:00.000Z",
"marginLevels": [
{
"contracts": 0,
"initialMargin": 0.02,
"maintenanceMargin": 0.01
},
{
"contracts": 500000,
"initialMargin": 0.04,
"maintenanceMargin": 0.02
},
{
"contracts": 1000000,
"initialMargin": 0.06,
"maintenanceMargin": 0.03
},
{
"contracts": 3000000,
"initialMargin": 0.1,
"maintenanceMargin": 0.05
}
],
"fundingRateCoefficient": 8,
"maxRelativeFundingRate": 0.001,
"isin": "GB00J62YGL67",
"contractValueTradePrecision": 0,
"postOnly": false,
"feeScheduleUid": "eef90775-995b-4596-9257-0917f6134766",
"retailMarginLevels": [
{
"contracts": 0,
"initialMargin": 0.5,
"maintenanceMargin": 0.25
}
],
"category": "",
"tags": [],
"tradfi": false,
"mtf": true
},
{
"symbol": "FI_XBTUSD_220930",
"pair": "XBT:USD",
"base": "XBT",
"quote": "USD",
"type": "futures_inverse",
"underlying": "rr_xbtusd",
"lastTradingTime": "2022-09-30T15:00:00.000Z",
"tickSize": 0.5,
"contractSize": 1,
"tradeable": true,
"impactMidSize": 1,
"maxPositionSize": 1000000,
"openingDate": "2022-01-01T00:00:00.000Z",
"marginLevels": [
{
"contracts": 0,
"initialMargin": 0.02,
"maintenanceMargin": 0.01
},
{
"contracts": 500000,
"initialMargin": 0.04,
"maintenanceMargin": 0.02
},
{
"contracts": 1000000,
"initialMargin": 0.06,
"maintenanceMargin": 0.03
},
{
"contracts": 3000000,
"initialMargin": 0.1,
"maintenanceMargin": 0.05
}
],
"isin": "GB00JVMLP260",
"contractValueTradePrecision": 0,
"postOnly": false,
"feeScheduleUid": "eef90775-995b-4596-9257-0917f6134766",
"retailMarginLevels": [
{
"contracts": 0,
"initialMargin": 0.5,
"maintenanceMargin": 0.25
}
],
"category": "",
"tags": [],
"tradfi": false,
"mtf": false
},
{
"symbol": "PF_XBTUSD",
"pair": "XBT:USD",
"base": "XBT",
"quote": "USD",
"type": "flexible_futures",
"tickSize": 1,
"contractSize": 1,
"tradeable": true,
"impactMidSize": 1,
"maxPositionSize": 1000000,
"openingDate": "2022-01-01T00:00:00.000Z",
"marginLevels": [
{
"numNonContractUnits": 0,
"initialMargin": 0.02,
"maintenanceMargin": 0.01
},
{
"numNonContractUnits": 500000,
"initialMargin": 0.04,
"maintenanceMargin": 0.02
},
{
"numNonContractUnits": 2000000,
"initialMargin": 0.1,
"maintenanceMargin": 0.05
},
{
"numNonContractUnits": 5000000,
"initialMargin": 0.2,
"maintenanceMargin": 0.1
},
{
"numNonContractUnits": 10000000,
"initialMargin": 0.3,
"maintenanceMargin": 0.15
},
{
"numNonContractUnits": 30000000,
"initialMargin": 0.5,
"maintenanceMargin": 0.25
}
],
"fundingRateCoefficient": 8,
"maxRelativeFundingRate": 0.001,
"contractValueTradePrecision": 4,
"feeScheduleUid": "5b755fea-c5b0-4307-a66e-b392cd5bd931",
"postOnly": false,
"retailMarginLevels": [
{
"numNonContractUnits": 0,
"initialMargin": 0.02,
"maintenanceMargin": 0.01
},
{
"numNonContractUnits": 500000,
"initialMargin": 0.04,
"maintenanceMargin": 0.02
},
{
"numNonContractUnits": 2000000,
"initialMargin": 0.1,
"maintenanceMargin": 0.05
},
{
"numNonContractUnits": 5000000,
"initialMargin": 0.2,
"maintenanceMargin": 0.1
},
{
"numNonContractUnits": 10000000,
"initialMargin": 0.3,
"maintenanceMargin": 0.15
},
{
"numNonContractUnits": 30000000,
"initialMargin": 0.5,
"maintenanceMargin": 0.25
}
],
"category": "Layer 1",
"tags": [],
"tradfi": false,
"mtf": false
}
],
"result": "success",
"serverTime": "2022-06-28T09:29:04.243Z"
}