Instruments

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://futures.kraken.com/derivatives/api/v3/instruments
Sample Return if Successful

{  
  "result":"success",
  "instruments":[  
    {  
      "symbol":"fi_ethusd_180928",
      "type":"futures_inverse",
      "underlying":"rr_ethusd",
      "lastTradingTime":"2018-09-28T15:00:00.000Z",
      "tickSize":0.1,
      "contractSize":1,
      "tradeable":true,
      "marginLevels":[  
        {  
          "contracts":0,
          "initialMargin":0.02,
          "maintenanceMargin":0.01
        },
        {  
          "contracts":250000,
          "initialMargin":0.04,
          "maintenanceMargin":0.02
        },
        {  
          "contracts":500000,
          "initialMargin":0.06,
          "maintenanceMargin":0.03
        }
      ]
    },

...
    {  
      "symbol":"in_xbtusd",
      "type":"spot index",
      "tradeable":false
    }
  ],
  "serverTime":"2018-07-19T11:32:39.433Z"
}

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
  • For Futures: The underlying of the Futures
  • For indices: Not returned because N/A
lastTradingTime
ISO8601 datetime
  • For Futures: The date and time at which the Futures stops trading
  • For indices: Not returned because N/A
tickSize
positive float
  • For Futures: The tick size increment of the Futures
  • For indices: Not returned because N/A
contractSize
positive integer
  • For Futures: For Futures: The contract size of the Futures
  • For indices: Not returned because N/A
marginLevels
list of structures
  • For Futures: A list containing the margin schedules
  • For indices: Not returned because N/A
contracts
positive integer
  • For Futures: The lower limit of the number of contracts that this margin level applies
  • For indices: Not returned because N/A
initialMargin
positive float
  • For Futures: The initial margin requirement for this level
  • For indices: Not returned because N/A
maintenanceMargin
positive float
  • For Futures: The maintenance margin requirement for this level
  • For indices: Not returned because N/A

 

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:

  • apiLimitExceeded: the API limit for the calling IP address has been exceeded 
  • unavailable: the requested resource is unavailable