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

Request

  • Base URL: https://api.kraken.com/0
  • URL: https://api.kraken.com/0/private/Earn/Strategies
  • Auth: API key in header API-Key and API key in header API-Sign

Request body

nonceinteger required

Nonce used in construction of API-Sign header

ascendingboolean nullable

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

assetstring nullable

Filter strategies by asset name

cursorstring nullable

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

limitinteger nullable

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

lock_typestring[] nullable

Filter strategies by lock type

Example request

{
  "nonce": 30295839,
  "asset": "DOT"
}

Response

Response

errorstring[]

Example response

{
  "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": []
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.