Order Book

This endpoint returns the entire non-cumulative order book of currently listed Futures contracts.

Authentication is not required.

Endpoint

Request Type Permissible API Keys
/api/v3/orderbook
GET N/A
Argument Type Required Description
symbol
string Yes The symbol of the Futures, see Section 3.4.4
Sample Call
 
https://futures.kraken.com/derivatives/api/v3/orderbook?symbol=fi_xbtusd_180615
Sample Return if Successful
{  
   "result":"success",
   "serverTime":"2016-02-25T09:45:53.818Z",
   "orderBook":{  
      "bids":[  
         [  
            4213,
            2000,
         ],
         [  
            4210,
            4000,
         ],
         ...,
      ],
      "asks":[  
         [  
            4218,
            4000,
         ],
         [  
            4220,
            5000,
         ],
         ...,
      ],
   },
}

Field

Type Description
result
String Always success
serverTime
ISO8601 datetime The server date and time
orderBook
structure of lists A structure containing lists with bid and ask prices and sizes, see below
bids
list of lists The first value of the inner list is the bid price, the second is the bid size. The outer list is sorted descending by bid price
asks
list of lists The first value of the inner list is the ask price, the second is the ask size. The outer list is sorted ascending by ask price

 

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 
  • marketUnavailable: the requested market is unavailable
  • requiredArgumentMissing: a required argument was missing 
  • invalidArgument: <argument>:argument "<argument>" is invalid