This endpoint returns specifications for all currently listed Futures contracts and indices.
Authentication is not required.
Endpoint |
Request Type | Permissible API Keys |
/api/v3/instruments
|
GET | N/A |
Arguments
|
None
|
Sample Call |
https://www.cryptofacilities.com/derivatives/api/v3/instruments
|
Sample Return if Successful |
{ ... |
Field |
Type | Description |
result
|
String | Always success |
serverTime
|
ISO8601 datetime | The server date and time |
instruments
|
list of structures | A list containing a structures for each available instrument, see below. The list is in no particular order |
symbol
|
string | The symbol of the Futures or index, see Section 3.4.4 |
type
|
string | The type of the instrument, either futures_inverse, futures_vanilla, turbo_inverse, spot index or volatility index |
tradeable
|
boolean | True if the instrument can be traded, false otherwise |
underlying
|
string |
|
lastTradingTime
|
ISO8601 datetime |
|
tickSize
|
positive float |
|
contractSize
|
positive integer |
|
marginLevels
|
list of structures |
|
contracts
|
positive integer |
|
initialMargin
|
positive float |
|
maintenanceMargin
|
positive float |
|
Sample Return if Unsuccessful |
{ "result":"error", "serverTime":"2016-02-25T09:45:53.818Z", "error":"apiLimitExceeded", } |
Field |
Type | Description |
result
|
String | Always error |
serverTime
|
ISO8601 datetime | The server date and time |
error
|
string |
The reason the API call failed, either of:
|