Skip to main content

/pallets/nomination-pools/{poolId} REST API Endpoint

Get information and metadata associated with a nomination pool.

Updated on
Sep 02, 2024

Path Parameters

poolId
string
REQUIRED

The unsigned integer Id of a nomination pool

Query Parameters

at
string

The block at which to retrieve the nomination pool

Returns

at
object

The at object which contains the following fields:

hash
string

The unique identifier (hash) of the block

height
string

The block number or height at which the data was accessed

bondedPool
object

The bondedPool object which contains the following fields:

commission
object

The commission object which contains the following fields:

current
array

The current commission rate and the account receiving it.

max
string

The maximum allowable commission rate

changeRate
string

The allowable rate of change for the commission

throttleFrom
string

The block number from which commission changes are throttled

claimPermission
string

The permission required to claim the commission

memberCounter
string

The total number of members in the bonded pool

points
string

The total points or stake in the bonded pool

roles
object

The roles object which contains the following fields:

depositor
string

The account that deposited the stake

root
string

The root account with control over the pool

nominator
string

The account responsible for nominating validators

bouncer
string

The account responsible for managing the pool's security or rules

state
string

The current state of the bonded pool

rewardPool
object

The rewardPool object which contains the following fields:

lastRecordedRewardCounter
string

The last recorded value of the reward counter

lastRecordedTotalPayouts
string

The last recorded total amount of rewards paid out

totalRewardsClaimed
string

The total amount of rewards that have been claimed by participants

totalCommissionPending
string

The total amount of commission that is pending to be claimed

totalCommissionClaimed
string

The total amount of commission that has been claimed

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free