Skip to main content

private/staking/get-staking-instruments

POST 

/private/staking/get-staking-instruments

Get staking instruments information

Request

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/staking/get-staking-instruments"

    api_key stringrequired

    Your API key (only required for private REST)

    sig stringrequired

    HMAC-SHA256 signature in hex (only required for private REST)

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    No parameters; use empty object
Success.
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object
    Present when code === 0. data array of staking instruments.
    data object[]
    List of staking instruments.
  • Array [
  • instrument_name string

    Staking instrument name, e.g. SOL.staked

    underlying_inst_name string

    Underlying instrument name, e.g. SOL

    reward_inst_name string

    Reward instrument name, e.g. SOL.staked

    out_of_stock boolean

    Disabled stake - true or false

    block_unstake boolean

    Disabled unstake - true or false

    est_rewards decimal

    Estimated rewards

    apr_y AprUnit (string)

    Possible values: [APR, APY]

    APR or APY

    min_stake_amt decimal

    Minimum stake amount

    reward_frequency int32

    Estimated reward frequency (day)

    lock_up_period int32

    Estimated lock up period (day)

    is_compound_reward boolean

    Is reward compounded - true or false

    pre_stake_charge_enable boolean

    Is pre stake charge applied - true or false

    pre_stake_charge_rate_in_bps int32

    Pre stake charge rate in basis point

    is_restaked boolean

    Is restaked instrument - true or false

    additional_rewards object[]
    Additional reward entries; each has reward_inst_name.
  • Array [
  • reward_inst_name string

    Additional reward instrument name

  • ]
  • ]
  • message string

    Present when code !== 0.

    original string

    Present when code !== 0.