List Earn Strategies

POST 
/private/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 it the endpoint always returns all data in the first page.

Request

application/json

Body

required

nonce int64required

Nonce used in construction of API-Sign header

ascending booleannullable

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

asset stringnullable

Filter strategies by asset name

cursor stringnullable

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

limit uint16nullable

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

lock_type string[]nullable

Possible values: [flex, bonded, timed, instant]

Filter strategies by lock type

Responses

200

Response

application/json

Schema

Schema

error string[]
result objectnullable

items object[]

Array [

allocation_fee object

Fee applied when allocating to this strategy

oneOf

string

string

integer

integer

number

number

allocation_restriction_info string[]

Possible values: [tier]

Reason list why user is not eligible for allocating to the strategy

apr_estimate objectnullable

The estimate is based on previous revenues from the strategy. Optional hint, not always present.

high string

Maximal yield percentage for one year

low string

Minimal yield percentage for one year

asset string

The asset to invest for this earn strategy

auto_compound object

Auto compound choices for the earn strategy

oneOf

MOD1

type string

Possible values: [disabled]

MOD2

type string

Possible values: [enabled]

MOD3

default boolean

type string

Possible values: [optional]

can_allocate boolean

Is allocation available for this strategy

can_deallocate boolean

Is deallocation available for this strategy

deallocation_fee object

Fee applied when deallocating from this strategy

oneOf

MOD1

string

MOD2

integer

MOD3

number

id string

The unique identifier for this strategy

lock_type object

Type of the strategy

oneOf

MOD1

type string

Possible values: [flex]

MOD2

bonding_period integer

Duration of the bonding period, in seconds

bonding_period_variable boolean

Is the bonding period length variable (true) or static (false)

bonding_rewards boolean

Whether rewards are earned during the bonding period (payouts occur after bonding is complete)

exit_queue_period integer

In order to remove funds, if this value is greater than 0, funds will first have to enter an exit queue and will have to wait for the exit queue period to end. Once ended, her funds will then follow and respect the unbonding_period.

If the value of the exit queue period is 0, then no waiting will have to occur and the exit queue will be skipped

Rewards are always paid out for the exit queue

payout_frequency integer

At what intervals are rewards distributed and credited to the user’s ledger, in seconds

type string

Possible values: [bonded]

unbonding_period integer

Duration of the unbonding period in seconds. In order to remove funds, you must wait for the unbonding period to pass after requesting removal before funds become available in her spot wallet

unbonding_period_variable boolean

Is the unbonding period length variable (true) or static (false)

unbonding_rewards boolean

Whether rewards are earned and payouts are done during the unbonding period

MOD3

payout_frequency integer

At what intervals are rewards distributed and credited to the user’s ledger, in seconds

type string

Possible values: [instant]

user_cap stringnullable

The maximum amount of funds that any given user may allocate to an account. Absence of value means there is no limit. Zero means that all new allocations will return an error (though auto-compound is unaffected).

user_min_allocation stringnullable

Minimum amount (in USD) for an allocation or deallocation. Absence means no minimum.

yield_source object

Yield generation mechanism of this strategy

oneOf

MOD1

type string

Possible values: [staking]

MOD2

type string

Possible values: [off_chain]

]

next_cursor stringnullable

index to send into PageRequest for next page, None means you've reached the end.

Example (from schema)

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

Loading...