Skip to main content

Staking

Blockchain Integration Data Query Apis Protocol Rest Queries Staking (v1.0.0)

Download OpenAPI specification:Download

API Documentation for Blockchain Integration Data Query Apis Protocol Rest Queries Staking

DelegatorValidators

DelegatorValidators queries the validators of a delegator.

Authorizations:
bearerAuth
path Parameters
delegator_address
required
string (delegator_address)

delegator_address defines the delegator address to query for.

Responses

Response samples

Content type
application/json
{
  • "validators": [
    ]
}

DelegatorDelegations

DelegatorDelegations queries all delegations of a given delegator address.

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

Authorizations:
bearerAuth
path Parameters
delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte> (key)

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.offset
integer or string <int64> (offset)

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.limit
integer or string <int64> (limit)

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.countTotal
boolean (count_total)

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.reverse
boolean (reverse)

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

Since: cosmos-sdk 0.43

Responses

Response samples

Content type
application/json
{
  • "delegationResponses": [
    ],
  • "pagination": {
    }
}

Redelegations

Redelegations queries redelegations of given address.

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

Authorizations:
bearerAuth
path Parameters
delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

query Parameters
srcValidatorAddr
string (src_validator_addr)

src_validator_addr defines the validator address to redelegate from.

dstValidatorAddr
string (dst_validator_addr)

dst_validator_addr defines the validator address to redelegate to.

pagination.key
string <byte> (key)

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.offset
integer or string <int64> (offset)

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.limit
integer or string <int64> (limit)

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.countTotal
boolean (count_total)

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.reverse
boolean (reverse)

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

Since: cosmos-sdk 0.43

Responses

Response samples

Content type
application/json
{
  • "redelegationResponses": [
    ],
  • "pagination": {
    }
}

DelegatorUnbondingDelegations

DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.

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

Authorizations:
bearerAuth
path Parameters
delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte> (key)

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.offset
integer or string <int64> (offset)

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.limit
integer or string <int64> (limit)

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.countTotal
boolean (count_total)

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.reverse
boolean (reverse)

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

Since: cosmos-sdk 0.43

Responses

Response samples

Content type
application/json
{
  • "unbondingResponses": [
    ],
  • "pagination": {
    }
}

DelegatorValidators

DelegatorValidators queries all validators info for given delegator address.

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

Authorizations:
bearerAuth
path Parameters
delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

query Parameters
pagination.key
string <byte> (key)

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.offset
integer or string <int64> (offset)

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.limit
integer or string <int64> (limit)

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.countTotal
boolean (count_total)

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.reverse
boolean (reverse)

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

Since: cosmos-sdk 0.43

Responses

Response samples

Content type
application/json
{
  • "validators": [
    ],
  • "pagination": {
    }
}

DelegatorValidator

DelegatorValidator queries validator info for given delegator validator pair.

Authorizations:
bearerAuth
path Parameters
delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

validator_addr
required
string (validator_addr)

validator_addr defines the validator address to query for.

Responses

Response samples

Content type
application/json
{
  • "validator": {
    }
}

Pool

Pool queries the pool info.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "pool": {
    }
}

Delegation

Delegation queries delegate info for given validator delegator pair.

Authorizations:
bearerAuth
path Parameters
validator_addr
required
string (validator_addr)

validator_addr defines the validator address to query for.

delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

Responses

Response samples

Content type
application/json
{
  • "delegationResponse": {
    }
}

UnbondingDelegation

UnbondingDelegation queries unbonding info for given validator delegator pair.

Authorizations:
bearerAuth
path Parameters
validator_addr
required
string (validator_addr)

validator_addr defines the validator address to query for.

delegator_addr
required
string (delegator_addr)

delegator_addr defines the delegator address to query for.

Responses

Response samples

Content type
application/json
{
  • "unbond": {
    }
}