Cosmos SDK - gRPC Gateway docs (1.0.0)
Download OpenAPI specification:Download
A REST interface for state queries.
Accounts returns all the existing accounts.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.43
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AccountAddressByID returns account address based on account number.
Since: cosmos-sdk 0.46.2
path Parameters
| id required | string <int64> Deprecated, use account_id instead id is the account number of the address to be queried. This field should have been an uint64 (like all account numbers), and will be updated to uint64 in a future version of the auth query. |
query Parameters
| account_id | string <uint64> account_id is the account number of the address to be queried. Since: cosmos-sdk 0.47 |
Responses
AllBalances queries the balance of all coins for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| address required | string address is the address to query balances for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
| resolve_denom | boolean resolve_denom is the flag to resolve the denom into a human-readable form from the metadata. Since: cosmos-sdk 0.50 |
Responses
DenomOwners queries for all account addresses that own a particular token denomination.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.46
path Parameters
| denom required | string denom defines the coin denomination to query all account holders for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DenomOwners queries for all account addresses that own a particular token denomination.
query Parameters
| denom | string denom defines the coin denomination to query all account holders for. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DenomsMetadata queries the client metadata for all registered coin denominations.
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SendEnabled queries for SendEnabled entries.
This query only returns denominations that have specific SendEnabled settings. Any denomination that does not have a specific setting will use the default params.default_send_enabled, and will not be returned by this query.
Since: cosmos-sdk 0.47
query Parameters
| denoms | Array of strings denoms is the specific denoms you want look up. Leave empty to get all entries. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SpendableBalances queries the spendable balance of all coins for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.46
path Parameters
| address required | string address is the address to query spendable balances for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SpendableBalanceByDenom queries the spendable balance of a single denom for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.47
path Parameters
| address required | string address is the address to query balances for. |
query Parameters
| denom | string denom is the coin denom to query balances for. |
Responses
TotalSupply queries the total supply of all coins.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorSlashes queries slash events of a validator.
path Parameters
| validator_address required | string validator_address defines the validator address to query for. |
query Parameters
| starting_height | string <uint64> starting_height defines the optional starting height to query the slashes. |
| ending_height | string <uint64> starting_height defines the optional ending height to query the slashes. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AllEvidence queries all evidence.
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Evidence queries evidence based on evidence hash.
path Parameters
| hash required | string hash defines the evidence hash of the requested evidence. Since: cosmos-sdk 0.47 |
query Parameters
| evidence_hash | string <byte> evidence_hash defines the hash of the requested evidence. Deprecated: Use hash, a HEX encoded string, instead. |
Responses
Proposals queries all proposals based on given status.
query Parameters
| proposal_status | string Default: "PROPOSAL_STATUS_UNSPECIFIED" Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED" proposal_status defines the status of the proposals.
|
| voter | string voter defines the voter address for the proposals. |
| depositor | string depositor defines the deposit addresses from the proposals. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Deposits queries all deposits of a single proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Votes queries votes of a given proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Vote queries voted information based on proposalID, voterAddr. Due to how we handle state, this query would error for proposals that has already been finished.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
| voter required | string voter defines the voter address for the proposals. |
Responses
Proposals queries all proposals based on given status.
query Parameters
| proposal_status | string Default: "PROPOSAL_STATUS_UNSPECIFIED" Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED" proposal_status defines the status of the proposals.
|
| voter | string voter defines the voter address for the proposals. |
| depositor | string depositor defines the deposit addresses from the proposals. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Deposits queries all deposits of a single proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Votes queries votes of a given proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SigningInfos queries signing info of all validators
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
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.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
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.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| src_validator_addr | string src_validator_addr defines the validator address to redelegate from. |
| dst_validator_addr | string dst_validator_addr defines the validator address to redelegate to. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
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.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
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.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Validators queries all validators that match the given status.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
query Parameters
| status | string status enables to query for validators matching a given status. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorDelegations queries delegate info for given validator.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| validator_addr required | string validator_addr defines the validator address to query for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorUnbondingDelegations queries unbonding delegations of a validator.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| validator_addr required | string validator_addr defines the validator address to query for. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
path Parameters
| last_height required | string <int64> last height of the current chain must be sent in request as this is the height under which next consensus state is stored |
Responses
Returns list of `Authorization`, granted to the grantee by the granter.
query Parameters
| granter | string |
| grantee | string |
| msg_type_url | string Optional, msg_type_url, when set, will query only grants matching given msg type. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GranteeGrants returns a list of `GrantAuthorization` by grantee.
Since: cosmos-sdk 0.46
path Parameters
| grantee required | string |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GranterGrants returns list of `GrantAuthorization`, granted by granter.
Since: cosmos-sdk 0.46
path Parameters
| granter required | string |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Allowances returns all the grants for the given grantee address.
path Parameters
| grantee required | string |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AllowancesByGranter returns all the grants given by an address
Since: cosmos-sdk 0.46
path Parameters
| granter required | string |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Classes queries all NFT classes
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
NFTs queries all NFTs of a given class or owner,choose at least one of the two, similar to tokenByIndex in ERC721Enumerable
query Parameters
| class_id | string class_id associated with the nft. |
| owner | string owner is the owner address of the nft. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupMembers queries members of a group by group id.
path Parameters
| group_id required | string <uint64> group_id is the unique ID of the group. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupPoliciesByAdmin queries group policies by admin address.
path Parameters
| admin required | string admin is the admin address of the group policy. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupPoliciesByGroup queries group policies by group id.
path Parameters
| group_id required | string <uint64> group_id is the unique ID of the group policy's group. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Groups queries all groups in state.
Since: cosmos-sdk 0.47.1
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupsByAdmin queries groups by admin address.
path Parameters
| admin required | string admin is the account address of a group's admin. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupsByMember queries groups by member address.
path Parameters
| address required | string address is the group member address. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
TallyResult returns the tally result of a proposal. If the proposal is still in voting period, then this query computes the current tally state, which might not be final. On the other hand, if the proposal is final, then it simply returns the `final_tally_result` state stored in the proposal itself.
path Parameters
| proposal_id required | string <uint64> proposal_id is the unique id of a proposal. |
Responses
ProposalsByGroupPolicy queries proposals based on account address of group policy.
path Parameters
| address required | string address is the account address of the group policy related to proposals. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
VotesByProposal queries a vote by proposal id.
path Parameters
| proposal_id required | string <uint64> proposal_id is the unique ID of a proposal. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
VotesByVoter queries a vote by voter.
path Parameters
| voter required | string voter is a proposal voter account address. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Account returns account permissions.
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ABCIQuery defines a query handler that supports ABCI queries directly to the application, bypassing Tendermint completely. The ABCI query must contain a valid and supported path, including app, custom, p2p, and store.
Since: cosmos-sdk 0.46
query Parameters
| data | string <byte> |
| path | string |
| height | string <int64> |
| prove | boolean |
Responses
GetLatestValidatorSet queries latest validator-set.
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GetValidatorSetByHeight queries validator-set at a given height.
path Parameters
| height required | string <int64> |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
TxEncode encodes the transaction.
Since: cosmos-sdk 0.47
Request Body schema: application/json
object (cosmos.tx.v1beta1.Tx) Tx is the standard type used for broadcasting transactions. | |||||||
| |||||||
Responses
Request samples
- Payload
{- "tx": {
- "body": {
- "messages": [
- {
- "type_url": "string",
- "value": "string"
}
], - "memo": "string",
- "timeout_height": "string",
- "unordered": true,
- "extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
], - "non_critical_extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
]
}, - "auth_info": {
- "signer_infos": [
- {
- "public_key": {
- "type_url": "string",
- "value": "string"
}, - "mode_info": {
- "single": {
- "mode": "SIGN_MODE_UNSPECIFIED"
}, - "multi": {
- "bitarray": {
- "extra_bits_stored": 0,
- "elems": "string"
}, - "mode_infos": [
- { }
]
}
}, - "sequence": "string"
}
], - "fee": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "gas_limit": "string",
- "payer": "string",
- "granter": "string"
}, - "tip": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "tipper": "string"
}
}, - "signatures": [
- "string"
]
}
}Simulate simulates executing a transaction for estimating gas usage.
Request Body schema: application/json
object (cosmos.tx.v1beta1.Tx) Tx is the standard type used for broadcasting transactions. | |
| tx_bytes | string <byte> tx_bytes is the raw transaction. Since: cosmos-sdk 0.43 |
Responses
Request samples
- Payload
{- "tx": {
- "body": {
- "messages": [
- {
- "type_url": "string",
- "value": "string"
}
], - "memo": "string",
- "timeout_height": "string",
- "unordered": true,
- "extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
], - "non_critical_extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
]
}, - "auth_info": {
- "signer_infos": [
- {
- "public_key": {
- "type_url": "string",
- "value": "string"
}, - "mode_info": {
- "single": {
- "mode": "SIGN_MODE_UNSPECIFIED"
}, - "multi": {
- "bitarray": {
- "extra_bits_stored": 0,
- "elems": "string"
}, - "mode_infos": [
- { }
]
}
}, - "sequence": "string"
}
], - "fee": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "gas_limit": "string",
- "payer": "string",
- "granter": "string"
}, - "tip": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "tipper": "string"
}
}, - "signatures": [
- "string"
]
}, - "tx_bytes": "string"
}GetTxsEvent fetches txs by event.
query Parameters
| events | Array of strings events is the list of transaction event type. Deprecated: post v0.47.x use query instead, which should contain a valid events query. |
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
| order_by | string Default: "ORDER_BY_UNSPECIFIED" Enum: "ORDER_BY_UNSPECIFIED" "ORDER_BY_ASC" "ORDER_BY_DESC"
|
| page | string <uint64> page is the page number to query, starts at 1. If not provided, will default to first page. |
| limit | string <uint64> 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. |
| query | string query defines the transaction event query that is proxied to Tendermint's TxSearch RPC method. The query must be valid. Since cosmos-sdk 0.50 |
Responses
BroadcastTx broadcast transaction.
Request Body schema: application/json
| tx_bytes | string <byte> tx_bytes is the raw transaction. |
| mode | string Default: "BROADCAST_MODE_UNSPECIFIED" Enum: "BROADCAST_MODE_UNSPECIFIED" "BROADCAST_MODE_BLOCK" "BROADCAST_MODE_SYNC" "BROADCAST_MODE_ASYNC" BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.
|
Responses
Request samples
- Payload
{- "tx_bytes": "string",
- "mode": "BROADCAST_MODE_UNSPECIFIED"
}GetBlockWithTxs fetches a block with decoded txs.
Since: cosmos-sdk 0.45.2
path Parameters
| height required | string <int64> height is the height of the block to query. |
query Parameters
| pagination.key | string <byte> 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 | string <uint64> 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 | string <uint64> 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_total | boolean 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 is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |