Staked position
get_stakingRead a Nimiq address's staking position, including active, cooling-down and withdrawable amounts, pool fee, net yield, payout type, unstake timing and first-year rewards estimate. Read-only.
Instructions
A Nimiq address's staking position: active staked, inactive (cooling down after an unstake), retired (ready to withdraw) and total, plus the pool it is staked to with its fee, net yield and payout type, an unstake clock (a retire only becomes valid one full epoch after deactivation), and a first-year rewards estimate at the pool's current net yield. Read-only: reads the public chain and the public validators list, never signs and never sends. Never staked reads as staked: false, never as a failed lookup; a failed lookup is an error that says so.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | No | Nimiq address (NQ form, spaced or flat, or 40 hex characters). Optional; defaults to the server’s configured address. |