Historic Orders

This endpoint allows to receive historic orders in a CSV file format.

 

Endpoint

Request Type Permissible API Keys
/api/v3/historicorders
GET Read, Read-write, Master
Argument Type Required Description
after
Unit timestamp No Include events after this point in time
before
Unit timestamp No Include events before this point in time
symbol
string No The symbol of the futures contract
Sample Calls

https://futures.kraken.com/derivatives/api/v3/historicorders?after=1550250845144&before=1550250845144&symbol=pi_xbtusd

https://futures.kraken.com/derivatives/api/v3/historicorders?after=1550250845144&before=1550250845144&symbol=pi_xbtusd&orderType=limit

Sample Return if Successful

A file containing the historic orders in CSV format. Click here to download an example file.

Field

Type Description
timestamp
Unix timestamp The timestamp of the order event
uid
UUID A structure containing information on the send order request, see below
event_type
string

One of:

  • ORDER_PLACED
  • ORDER_CANCELLED
  • ORDER_REJECTED
  • EXECUTION
order_uid UUID The unique identifier of the order
order_tradeable string The tradeable (symbol) of the futures contract
order_direction string BUY for buy order and SELL for a sell
order_quantity positive float The order quantity (size)
order_filled
positive float The order filled amount
order_timestamp
Unix timestamp The order timestamp
order_type
string

One of:

  • LIMIT
  • IMMEDIATE_OR_CANCEL
  • POST_ONLY
  • LIQUIDATION
  • ASSIGNMENT
  • STOP
order_client_id
 string The provided client order id
order_stop_price  positive float The stop price of the order.
info  string

One of:

  • MAKER_ORDER 
  • TAKER_ORDER
algo_id  string The id of the algorithm that placed the order
execution_timestamp  Unix timestamp The execution timestamp
execution_quantity  positive integer The executed quantity
execution_price positive float The price that the orders got executed
execution_mark_price  positive float The market price at the time of the execution
execution_limit_filled  boolean true if the maker order of the execution was filled in its entirety otherwise false

 

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
  • authenticationError: the request could not be authenticated
  • accountInactive: the Crypto Facilities account the request refers to is inactive
  • requiredArgumentMissing: a required argument was missing
  • invalidArgument: <argument>:argument "<argument>" is invalid
  • nonceBelowThreshold: <threshold> the provided nonce is below the <threshold>
  • nonceDuplicate: <duplicate> the provided nonce is a duplicate as it has been used in a previous request