This endpoint returns key information relating to all your Kraken Futures accounts which may either be cash accounts or margin accounts. This includes digital asset balances, instrument balances, margin requirements, margin trigger estimates and auxiliary information such as available funds, PnL of open positions and portfolio value.
Authentication is required.
|
Endpoint |
Request Type | Permissible API Keys |
|
/api/v3/accounts
|
GET | Read-only, Read-write, Master |
|
Arguments
|
|
None
|
| Sample Call |
|
https://futures.kraken.com/derivatives/api/v3/accounts
|
| Sample Return if Successful |
|
{ }, |
|
Field |
Type | Description |
|
result
|
String | Always success |
|
serverTime
|
ISO8601 datetime | The server date and time |
|
accounts
|
structure of structures | A structure containing structures with account-related information for all margin and cash accounts, see below |
| <accountSymbol> | structure of structures | A structure containing structures with account-related information for a specific cash or margin account, see below. Named after the symbol of the account, see Ticker Symbols |
| type | string | The type of the account, either cashAccount, marginAccount, or multiCollateralMarginAccount |
| currency | string | The currency of the account. All figures shown in auxiliary and marginRequirements are in this currency. Returned only for margin accounts |
| balances | structure | A structure containing account balances, see below |
| <symbol> | string | The number of Futures or currency with symbol in the account, see Ticker Symbols |
| auxiliary | structure | A structure containing auxiliary account information, see below. Returned only for margin accounts |
| af | float | The available funds of the account, in currency |
| pnl | float | The PnL of current open positions of the account, in currency |
| pv | positive float | The portfolio value of the account, in currency |
| marginRequirements | structure | A structure containing the account’s margin requirements, see below. Returned only for margin accounts |
| im | positive float | The initial margin requirement of the account |
| mm | positive float | The maintenance margin requirement of the account |
| lt | positive float | The liquidation threshold of the account |
| tt | positive float | The termination threshold of the account |
| triggerEstimates | structure | A structure containing the account’s margin trigger estimates, see below. Returned only for margin accounts |
| im | positive float | The approximate spot price of the underlying at which the account will reach its initial margin requirement |
| mm | positive float | The approximate spot price of the underlying at which the account will reach its maintenance margin requirement |
| lt | positive float | The approximate spot price of the underlying at which the account will reach its liquidation threshold |
| tt | positive float | The approximate spot price of the underlying at which the account will reach its termination threshold |
| flex | Structure |
Structure showing multi-collateral wallet details
|
| currencies | Structure |
Structure with collateral currency details
|
| quantity | Float |
Quantity of asset
|
| value | Float |
USD value of asset
|
| collateralValue | Float |
USD value of the asset usable for margin (Asset Value * Haircut)
|
| available | Float |
Margin (in base currency) available for trading
|
| balanceValue | Float |
USD value of all collateral in multi-collateral wallet
|
| portfolioValue | Float |
Balance value plus unrealised PnL in USD
|
| collateralValue | Float |
USD value of balances in account usable for margin (Balance Value * Haircut)
|
| pnl | Float |
Unrealised PnL in USD
|
| initialMargin | Float |
Total initial margin held for open positions (USD)
|
| initialMarginWithOrders | Float |
Total initial margin held for open positions and open orders (USD)
|
| maintenanceMargin | Float |
Total maintenance margin held for open positions (USD)
|
| unrealizedFunding | Float |
Unrealised funding from funding rate (USD)
|
| totalUnrealized | Float |
Total USD value of unrealised funding and unrealised PnL
|
| totalUnrealizedAsMargin | Float |
Unrealised pnl and unrealised funding that is usable as margin [(Unrealised Profit/Loss + Unrealised Funding Rate) * Haircut - Conversion Fee]
|
| marginEquity | Float |
[Balance Value in USD * (1-Haircut)] + (Total Unrealised Profit/Loss as Margin in USD)
|
| availableMargin | Float |
Margin Equity - Total Initial Margin
|
| 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:
|