This endpoint returns the size and average entry price of all open positions in Futures contracts. This includes Futures contracts that have matured but have not yet been settled.
Authentication is required.
|
Endpoint |
Request Type | Permissible API Keys |
|
/api/v3/openpositions
|
GET | Read-only, Read-write, Master |
| Arguments | |||
| none |
| Sample Call |
| https://futures.kraken.com/derivatives/api/v3/openpositions |
| Sample Return if Successful |
| { "result":"success", "openPositions":[ { "side":"short", "symbol":"pi_xbtusd", "price":9392.749993345933, "fillTime":"2020-07-22T14:39:12.376Z", "size":10000, "unrealizedFunding":1.045432180096817E-5 }, { "side":"long", "symbol":"fi_xbtusd_201225", "price":9399.749966754434, "fillTime":"2020-07-22T14:39:12.376Z", "size":20000 } { "side":"long", "symbol":"pf_defiusd", "price":570.0, "fillTime":"2022-04-20T19:15:25.438Z", "size":1, "unrealizedFunding":-0.0073428045972263895, "pnlCurrency":"BTC", "maxFixedLeverage":5.0 } ], "serverTime":"2020-07-22T14:39:12.376Z" } |
|
Field |
Type | Description |
|
result
|
string | Always success |
|
openPositions
|
list of structures | A list containing structures with information on open positions, see below. The list is sorted descending by fillTime |
| side | string | The direction of the position, either long for a long position or short for a short position |
| symbol | string | The symbol of the Futures, see Ticker Symbols |
| price | positive float | The average price at which the position was entered into |
| fillTime [Deprecated] | ISO8601 datetime | The date and time the position was entered into (Deprecated field, fills endpoint for fill time is recommended) |
| size | positive integer | The size of the position |
| unrealizedFunding (perpetuals only) | float | Unrealised funding on the position |
| pnlCurrency (multi-collateral contracts only) | string |
Selected pnl currency for the position. See Futures Collateral Currencies |
| fixedMaxLeverage (isolated multi-collateral positions only) | positive float | Max leverage selected for isolated position |
| serverTime | ISO8601 datetime | The server date and time |
| 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:
|