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:
path Parameters
| delegator_address required | string (delegator_address) delegator_address defines the delegator address to query for. |
Responses
Response samples
- 200
{- "validators": [
- "string"
]
}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:
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
- 200
{- "delegationResponses": [
- {
- "delegation": {
- "delegatorAddress": "string",
- "validatorAddress": "string",
- "shares": "string"
}, - "balance": {
- "denom": "string",
- "amount": "string"
}
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}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:
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
- 200
{- "redelegationResponses": [
- {
- "redelegation": {
- "delegatorAddress": "string",
- "validatorSrcAddress": "string",
- "validatorDstAddress": "string",
- "entries": [
- {
- "creationHeight": 0,
- "completionTime": "2023-01-15T01:30:15.01Z",
- "initialBalance": "string",
- "sharesDst": "string",
- "unbondingId": 0,
- "unbondingOnHoldRefCount": 0
}
]
}, - "entries": [
- {
- "redelegationEntry": {
- "creationHeight": 0,
- "completionTime": "2023-01-15T01:30:15.01Z",
- "initialBalance": "string",
- "sharesDst": "string",
- "unbondingId": 0,
- "unbondingOnHoldRefCount": 0
}, - "balance": "string"
}
]
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}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:
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
- 200
{- "unbondingResponses": [
- {
- "delegatorAddress": "string",
- "validatorAddress": "string",
- "entries": [
- {
- "creationHeight": 0,
- "completionTime": "2023-01-15T01:30:15.01Z",
- "initialBalance": "string",
- "balance": "string",
- "unbondingId": 0,
- "unbondingOnHoldRefCount": 0
}
]
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}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:
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
- 200
{- "validators": [
- {
- "operatorAddress": "string",
- "consensusPubkey": {
- "type": "string",
- "value": "string"
}, - "jailed": true,
- "status": "BOND_STATUS_UNSPECIFIED",
- "tokens": "string",
- "delegatorShares": "string",
- "description": {
- "moniker": "string",
- "identity": "string",
- "website": "string",
- "securityContact": "string",
- "details": "string"
}, - "unbondingHeight": 0,
- "unbondingTime": "2023-01-15T01:30:15.01Z",
- "commission": {
- "commissionRates": {
- "rate": "string",
- "maxRate": "string",
- "maxChangeRate": "string"
}, - "updateTime": "2023-01-15T01:30:15.01Z"
}, - "minSelfDelegation": "string",
- "unbondingOnHoldRefCount": 0,
- "unbondingIds": [
- 0
]
}
], - "pagination": {
- "nextKey": "string",
- "total": 0
}
}DelegatorValidator
DelegatorValidator queries validator info for given delegator validator pair.
Authorizations:
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
- 200
{- "validator": {
- "operatorAddress": "string",
- "consensusPubkey": {
- "type": "string",
- "value": "string"
}, - "jailed": true,
- "status": "BOND_STATUS_UNSPECIFIED",
- "tokens": "string",
- "delegatorShares": "string",
- "description": {
- "moniker": "string",
- "identity": "string",
- "website": "string",
- "securityContact": "string",
- "details": "string"
}, - "unbondingHeight": 0,
- "unbondingTime": "2023-01-15T01:30:15.01Z",
- "commission": {
- "commissionRates": {
- "rate": "string",
- "maxRate": "string",
- "maxChangeRate": "string"
}, - "updateTime": "2023-01-15T01:30:15.01Z"
}, - "minSelfDelegation": "string",
- "unbondingOnHoldRefCount": 0,
- "unbondingIds": [
- 0
]
}
}Delegation
Delegation queries delegate info for given validator delegator pair.
Authorizations:
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
- 200
{- "delegationResponse": {
- "delegation": {
- "delegatorAddress": "string",
- "validatorAddress": "string",
- "shares": "string"
}, - "balance": {
- "denom": "string",
- "amount": "string"
}
}
}UnbondingDelegation
UnbondingDelegation queries unbonding info for given validator delegator pair.
Authorizations:
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
- 200
{- "unbond": {
- "delegatorAddress": "string",
- "validatorAddress": "string",
- "entries": [
- {
- "creationHeight": 0,
- "completionTime": "2023-01-15T01:30:15.01Z",
- "initialBalance": "string",
- "balance": "string",
- "unbondingId": 0,
- "unbondingOnHoldRefCount": 0
}
]
}
}