Staking

Parameters queries the staking parameters.

get
Responses
chevron-right
200

A successful response.

application/json

QueryParamsResponse is response type for the Query/Params RPC method.

get
/cosmos/staking/v1beta1/params

DelegatorDelegations queries all delegations of a given delegator address.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Query parameters
pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json

QueryDelegatorDelegationsResponse is response type for the Query/DelegatorDelegations RPC method.

get
/cosmos/staking/v1beta1/delegations/{delegator_addr}

Redelegations queries redelegations of given address.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Query parameters
src_validator_addranyOptional

src_validator_addr defines the validator address to redelegate from.

dst_validator_addranyOptional

dst_validator_addr defines the validator address to redelegate to.

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json

QueryRedelegationsResponse is response type for the Query/Redelegations RPC method.

get
/cosmos/staking/v1beta1/delegators/{delegator_addr}/redelegations

DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Query parameters
pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json

QueryUnbondingDelegatorDelegationsResponse is response type for the Query/UnbondingDelegatorDelegations RPC method.

get
/cosmos/staking/v1beta1/delegators/{delegator_addr}/unbonding_delegations

DelegatorValidators queries all validators info for given delegator address.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Query parameters
pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json

QueryDelegatorValidatorsResponse is response type for the Query/DelegatorValidators RPC method.

get
/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators

DelegatorValidator queries validator info for given delegator validator pair.

get
Path parameters
delegator_addranyRequired

delegator_addr defines the delegator address to query for.

validator_addranyRequired

validator_addr defines the validator address to query for.

Responses
chevron-right
200

A successful response.

application/json

QueryDelegatorValidatorResponse response type for the Query/DelegatorValidator RPC method.

get
/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators/{validator_addr}

HistoricalInfo queries the historical info for given height.

get
Path parameters
heightanyRequired

height defines at which height to query the historical info.

Responses
chevron-right
200

A successful response.

application/json

QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo RPC method.

get
/cosmos/staking/v1beta1/historical_info/{height}

Pool queries the pool info.

get
Responses
chevron-right
200

A successful response.

application/json

QueryPoolResponse is response type for the Query/Pool RPC method.

get
/cosmos/staking/v1beta1/pool

Validators queries all validators that match the given status.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Query parameters
statusanyOptional

status enables to query for validators matching a given status.

pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json
get
/cosmos/staking/v1beta1/validators

Validator queries validator info for given validator address.

get
Path parameters
validator_addranyRequired

validator_addr defines the validator address to query for.

Responses
chevron-right
200

A successful response.

application/json
get
/cosmos/staking/v1beta1/validators/{validator_addr}

ValidatorDelegations queries delegate info for given validator.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
validator_addranyRequired

validator_addr defines the validator address to query for.

Query parameters
pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json
get
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations

Delegation queries delegate info for given validator delegator pair.

get
Path parameters
validator_addranyRequired

validator_addr defines the validator address to query for.

delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Responses
chevron-right
200

A successful response.

application/json

QueryDelegationResponse is response type for the Query/Delegation RPC method.

get
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}

UnbondingDelegation queries unbonding info for given validator delegator pair.

get
Path parameters
validator_addranyRequired

validator_addr defines the validator address to query for.

delegator_addranyRequired

delegator_addr defines the delegator address to query for.

Responses
chevron-right
200

A successful response.

application/json

QueryDelegationResponse is response type for the Query/UnbondingDelegation RPC method.

get
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}/unbonding_delegation

ValidatorUnbondingDelegations queries unbonding delegations of a validator.

get

When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.

Path parameters
validator_addranyRequired

validator_addr defines the validator address to query for.

Query parameters
pagination.keyanyOptional

key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set.

pagination.offsetanyOptional

offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set.

pagination.limitanyOptional

limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app.

pagination.count_totalanyOptional

count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set.

pagination.reverseanyOptional

reverse is set to true if results are to be returned in the descending order.

Since: cosmos-sdk 0.43

Responses
chevron-right
200

A successful response.

application/json

QueryValidatorUnbondingDelegationsResponse is response type for the Query/ValidatorUnbondingDelegations RPC method.

get
/cosmos/staking/v1beta1/validators/{validator_addr}/unbonding_delegations

Last updated