List Earn Strategies

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

{
  "error": [],
  "result": {
    "next_cursor": "2",
    "items": [
      {
        "id": "ESRFUO3-Q62XD-WIOIL7",
        "asset": "DOT",
        "lock_type": {
          "type": "instant",
          "payout_frequency": 604800
        },
        "apr_estimate": {
          "low": "8.0000",
          "high": "12.0000"
        },
        "user_min_allocation": "0.01",
        "allocation_fee": "0.0000",
        "deallocation_fee": "0.0000",
        "auto_compound": {
          "type": "enabled"
        },
        "yield_source": {
          "type": "staking"
        },
        "can_allocate": true,
        "can_deallocate": true,
        "allocation_restriction_info": []
      }
    ]
  }
}

Earn

List Earn Strategies

List earn strategies along with their parameters.

Requires a valid API key but not specific permission is required.

Returns only strategies that are available to the user based on geographic region.

When the user does not meet the tier restriction, can_allocate will be false and allocation_restriction_info indicates Tier as the restriction reason. Earn products generally require Intermediate tier. Get your account verified to access earn.

A note about lock_type:

instant: can be deallocated without an unbonding period. This is called flexible in the UI.
bonded: has an unbonding period. Deallocation will not happen until this period has passed.
flex: “Kraken rewards”. This is earning on your spot balances where eligible. It’s turned on account wide from the UI and you cannot manually allocate to these strategies.

Paging isn’t yet implemented, so the endpoint always returns all data in the first page.

POST

/

private

/

Earn

/

Strategies

List Earn Strategies

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

{
  "error": [],
  "result": {
    "next_cursor": "2",
    "items": [
      {
        "id": "ESRFUO3-Q62XD-WIOIL7",
        "asset": "DOT",
        "lock_type": {
          "type": "instant",
          "payout_frequency": 604800
        },
        "apr_estimate": {
          "low": "8.0000",
          "high": "12.0000"
        },
        "user_min_allocation": "0.01",
        "allocation_fee": "0.0000",
        "deallocation_fee": "0.0000",
        "auto_compound": {
          "type": "enabled"
        },
        "yield_source": {
          "type": "staking"
        },
        "can_allocate": true,
        "can_deallocate": true,
        "allocation_restriction_info": []
      }
    ]
  }
}

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

List strategies parameters

nonce

integer<int64>

required

Nonce used in construction of API-Sign header

ascending

boolean | null

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

asset

string | null

Filter strategies by asset name

cursor

string | null

None to start at beginning/end, otherwise next page ID

limit

integer<uint16> | null

How many items to return per page. Note that the limit may be cap'd to lower value in the application code.

lock_type

enum<string>[] | null

Filter strategies by lock type

Type of a strategy

Available options:

flex,

bonded,

timed,

instant

Response

200 - application/json

Response

error

string[]

Kraken API error

result

object

Show child attributes

⌘I