private/staking/get-staking-position

POST 
/private/staking/get-staking-position

Get the total staking position for a user/token

Request

Body

required

id int64required

Request id (echoed in response)

method stringrequired

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

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

instrument_name string

Staking instrument name, e.g. SOL.staked

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 positions.
data object[]
List of staking positions.
Array [
instrument_name string
Staking instrument name, e.g. SOL.staked
underlying_inst_name string
Underlying instrument name, e.g. SOL
staked_quantity decimal
Total staked quantity. For yield-bearing instruments, staked_quantity, pending_unstaked_quantity, and reward_eligible_quantity are in terms of yield-bearing tokens held. E.g. for TSTON.staked, the quantity of TSTON held on-chain.
pending_staked_quantity decimal
Total pending staked quantity
pending_unstaked_quantity decimal
Total pending unstaked quantity
reward_eligible_quantity decimal
Total reward eligible quantity; quantity can be unstaked/convert
]
message string

Present when code !== 0.

original string

Present when code !== 0.