Skip to main content
POST
/
private
/
Earn
/
Allocations
List Earn Allocations
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
}
'
import requests

url = "https://api.kraken.com/0/private/Earn/Allocations"

payload = {
"nonce": 30295839,
"converted_asset": "EUR",
"hide_zero_allocations": True
}
headers = {
"API-Key": "<api-key>",
"API-Sign": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'API-Key': '<api-key>',
'API-Sign': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({nonce: 30295839, converted_asset: 'EUR', hide_zero_allocations: true})
};

fetch('https://api.kraken.com/0/private/Earn/Allocations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.kraken.com/0/private/Earn/Allocations"

payload := strings.NewReader("{\n \"nonce\": 30295839,\n \"converted_asset\": \"EUR\",\n \"hide_zero_allocations\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("API-Key", "<api-key>")
req.Header.Add("API-Sign", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "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 | null

Page response