List Earn Allocations

List all allocations for the user.

Requires the Query Funds API key permission.

By default all allocations are returned, even for strategies that have been used in the past and have zero balance now. That is so that the user can see how much was earned with given strategy in the past. hide_zero_allocations parameter can be used to remove zero balance entries from the output. Paging hasn’t been implemented for this method as we don’t expect the result for a particular user to be overwhelmingly large.

All amounts in the output can be denominated in a currency of user’s choice (the converted_asset parameter).

Information about when the next reward will be paid to the client is also provided in the output.

Allocated funds can be in up to 4 states:

• bonding
• allocated
• exit_queue (ETH only)
• unbonding

Any funds in total not in bonding/unbonding are simply allocated and earning rewards. Depending on the strategy funds in the other 3 states can also be earning rewards. Consult the output of /Earn/Strategies to know whether bonding/unbonding earn rewards. ETH in exit_queue still earns rewards.

Note that for ETH, when the funds are in the exit_queue state, the expires time given is the time when the funds will have finished unbonding, not when they go from exit queue to unbonding.

(Un)bonding time estimate can be inaccurate right after having (de)allocated the funds. Wait 1-2 minutes after (de)allocating to get an accurate result.

POST /private/Earn/Allocations

List Earn Allocations

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/Earn/Allocations \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 30295839,
  "converted_asset": "EUR",
  "hide_zero_allocations": true
}
'

200

{
  "error": [],
  "result": {
    "converted_asset": "USD",
    "total_allocated": "49.2398",
    "total_rewarded": "0.0675",
    "next_cursor": "2",
    "items": [
      {
        "strategy_id": "ESDQCOL-WTZEU-NU55QF",
        "native_asset": "ETH",
        "amount_allocated": {
          "bonding": {
            "native": "0.0210000000",
            "converted": "39.0645",
            "allocation_count": 2,
            "allocations": [
              {
                "created_at": "2023-07-06T10:52:05Z",
                "expires": "2023-08-19T02:34:05.807Z",
                "native": "0.0010000000",
                "converted": "1.8602"
              },
              {
                "created_at": "2023-08-01T11:25:52Z",
                "expires": "2023-09-06T07:55:52.648Z",
                "native": "0.0200000000",
                "converted": "37.2043"
              }
            ]
          },
          "total": {
            "native": "0.0210000000",
            "converted": "39.0645"
          }
        },
        "total_rewarded": {
          "native": "0",
          "converted": "0.0000"
        }
      }
    ]
  }
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

Page request

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

ascending · boolean | null

true to sort ascending, false (the default) for descending.

converted_asset · string | null

A secondary currency to express the value of your allocations (the default is USD).

hide_zero_allocations · boolean | null

Omit entries for strategies that were used in the past but now they don't hold any allocation (the default is false)

Response

200 - application/json

Response

error · string[]

Kraken API error

result · object

Page response

Show child attributes