var img = document.createElement('img'); img.src = "https://terradocs.matomo.cloud//piwik.php?idsite=1&rec=1&url=https://docs.terra.money" + location.pathname; img.style = "border:0"; img.alt = "tracker"; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(img,s);
Skip to main content

Swagger REST API

ℹ️info

Terra's complete Swagger API documentation can be found at https://phoenix-lcd.terra.dev/swagger/.

To learn about Terra's Light Client Daemon (LCD), visit Start the light client daemon (LCD).

Documentation Powered by Redocly

(2.7)

Download OpenAPI specification:Download

Source code for Terra Core v2.7
UI to interact with the blockchain Station
Create a DAO on Terra using Enterprise
Run on-chain automted jobs Wrap
Explore the network using TerraScope
Anything you need to know about shared security on Alliance Docs
More info about the protocol on Terra Docs

Query

Query paginated alliances

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

Query all paginated alliance delegations

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

Query all paginated alliance delegations for a delegator addr

path Parameters
delegator_addr
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

Query all paginated alliance delegations for a delegator addr and validator_addr

path Parameters
delegator_addr
required
string
validator_addr
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

Query a delegation to an alliance by delegator addr, validator_addr and denom @deprecated: this endpoint will be replaced for by the encoded version of the denom e.g.: GET:/terra/alliances/terradr1231/terravaloper41234/ibc%2Falliance

path Parameters
delegator_addr
required
string
validator_addr
required
string
hash
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

Query a delegation to an alliance by delegator addr, validator_addr and denom

path Parameters
delegator_addr
required
string
validator_addr
required
string
denom
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

Query a specific alliance by ibc hash @deprecated: this endpoint will be replaced for by the encoded version of the denom e.g.: GET:/terra/alliances/ibc%2Falliance

path Parameters
hash
required
string

Responses

AllianceParams

Responses

Query redelegations by denom and delegator address

path Parameters
denom
required
string
delegator_addr
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

Query for rewards by delegator addr, validator_addr and denom @deprecated: this endpoint will be replaced for by the encoded version of the denom e.g.: GET:/terra/alliances/terradr1231/terravaloper41234/ibc%2Falliance

path Parameters
delegator_addr
required
string
validator_addr
required
string
hash
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

Query for rewards by delegator addr, validator_addr and denom

path Parameters
delegator_addr
required
string
validator_addr
required
string
denom
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

Query for rewards by delegator addr, validator_addr and denom

path Parameters
denom
required
string
delegator_addr
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

Query for rewards by delegator addr, validator_addr and denom

path Parameters
denom
required
string
delegator_addr
required
string
validator_addr
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

Query all paginated alliance 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

Query alliance validator

path Parameters
validator_addr
required
string

Responses

Query a specific alliance by denom

path Parameters
denom
required
string

Responses

DenomAuthorityMetadata defines a gRPC query method for fetching DenomAuthorityMetadata for a particular denom.

path Parameters
denom
required
string

Responses

BeforeSendHookAddress defines a gRPC query method for getting the address registered for the before send hook.

path Parameters
denom
required
string

Responses

DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator.

path Parameters
creator
required
string

Responses

Params defines a gRPC query method that returns the tokenfactory module's parameters.

Responses

InterchainAccount returns the interchain account address for a given owner address on a given connection

path Parameters
owner
required
string
connection_id
required
string

Responses

Params queries all parameters of the ICA controller submodule.

Responses

Params queries all parameters of the ICA host submodule.

Responses

AccountInfo queries account info which is common to all account types.

Since: cosmos-sdk 0.47

path Parameters
address
required
string

address is the account address string.

Responses

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

Account returns account details based on address.

path Parameters
address
required
string

address defines the address to query for.

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

Bech32Prefix queries bech32Prefix

Since: cosmos-sdk 0.46

Responses

AddressBytesToString converts Account Address bytes to string

Since: cosmos-sdk 0.46

path Parameters
address_bytes
required
string <byte>

Responses

AddressStringToBytes converts Address string to bytes

Since: cosmos-sdk 0.46

path Parameters
address_string
required
string

Responses

ModuleAccounts returns all the existing module accounts.

Since: cosmos-sdk 0.46

Responses

ModuleAccountByName returns the module account info by module name

path Parameters
name
required
string

Responses

Params queries all parameters.

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

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

Responses

Balance queries the balance of a single coin for a single account.

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

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

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

DenomsMetadata queries the client metadata of a given coin denomination.

path Parameters
denom
required
string

denom is the coin denom to query the metadata for.

Responses

Params queries the parameters of x/bank module.

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

SupplyOf queries the supply of a single coin.

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

query Parameters
denom
string

denom is the coin denom to query balances for.

Responses

CommunityPool queries the community pool coins.

Responses

DelegationTotalRewards queries the total rewards accrued by a each validator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegationRewards queries the total rewards accrued by a delegation.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

validator_address
required
string

validator_address defines the validator address to query for.

Responses

DelegatorValidators queries the validators of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

DelegatorWithdrawAddress queries withdraw address of a delegator.

path Parameters
delegator_address
required
string

delegator_address defines the delegator address to query for.

Responses

Params queries params of the distribution module.

Responses

ValidatorDistributionInfo queries validator commission and self-delegation rewards for validator

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorCommission queries accumulated commission for a validator.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

Responses

ValidatorOutstandingRewards queries rewards of a validator address.

path Parameters
validator_address
required
string

validator_address defines the validator address to query for.

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

Allowance returns fee granted to the grantee by the granter.

path Parameters
granter
required
string

granter is the address of the user granting an allowance of their funds.

grantee
required
string

grantee is the address of the user being granted an allowance of another user's funds.

Responses

Allowances returns all the grants for 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

Params queries all parameters of the gov module.

path Parameters
params_type
required
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

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.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
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

Proposal queries proposal details based on ProposalID.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

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

Deposit queries single deposit information based proposalID, depositAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

depositor
required
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult queries the tally of a proposal vote.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

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.

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

Params queries all parameters of the gov module.

path Parameters
params_type
required
string

params_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".

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.

  • PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
  • PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
  • PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
  • PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
  • PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
  • PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
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

Proposal queries proposal details based on ProposalID.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

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

Deposit queries single deposit information based proposalID, depositAddr.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

depositor
required
string

depositor defines the deposit addresses from the proposals.

Responses

TallyResult queries the tally of a proposal vote.

path Parameters
proposal_id
required
string <uint64>

proposal_id defines the unique id of the proposal.

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.

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

Params queries the parameters of x/consensus_param module.

Responses

GroupInfo queries group info based on group id.

path Parameters
group_id
required
string <uint64>

group_id is the unique ID of the group.

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

GroupPolicyInfo queries group policy info based on account address of group policy.

path Parameters
address
required
string

address is the account address of the group policy.

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

Proposal queries a proposal based on proposal id.

path Parameters
proposal_id
required
string <uint64>

proposal_id is the unique ID of a proposal.

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

VoteByProposalVoter queries a vote by proposal id and voter.

path Parameters
proposal_id
required
string <uint64>

proposal_id is the unique ID of a proposal.

voter
required
string

voter is a proposal voter account address.

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

AnnualProvisions current minting annual provisions value.

Responses

Inflation returns the current minting inflation value.

Responses

Params returns the total set of minting parameters.

Responses

Params queries a specific parameter of a module, given its subspace and key.

query Parameters
subspace
string

subspace defines the module to query the parameter for.

key
string

key defines the key of the parameter in the subspace.

Responses

Subspaces queries for all registered subspaces and all keys for a subspace.

Since: cosmos-sdk 0.46

Responses

Params queries the parameters of slashing module

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

SigningInfo queries the signing info of given cons address

path Parameters
cons_address
required
string

cons_address is the address to query signing info of

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

DelegatorValidator queries validator info for given delegator validator pair.

path Parameters
delegator_addr
required
string

delegator_addr defines the delegator address to query for.

validator_addr
required
string

validator_addr defines the validator address to query for.

Responses

HistoricalInfo queries the historical info for given height.

path Parameters
height
required
string <int64>

height defines at which height to query the historical info.

Responses

Parameters queries the staking parameters.

Responses

Pool queries the pool info.

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

Validator queries validator info for given validator address.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

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

Delegation queries delegate info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

Responses

UnbondingDelegation queries unbonding info for given validator delegator pair.

path Parameters
validator_addr
required
string

validator_addr defines the validator address to query for.

delegator_addr
required
string

delegator_addr defines the delegator address to query for.

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

AppliedPlan queries a previously applied upgrade plan by its name.

path Parameters
name
required
string

name is the name of the applied plan to query for.

Responses

Returns the account with authority to conduct upgrades

Since: cosmos-sdk 0.46

Responses

CurrentPlan queries the current upgrade plan.

Responses

ModuleVersions queries the list of module versions from state.

Since: cosmos-sdk 0.43

query Parameters
module_name
string

module_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state.

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

Codes gets the metadata for all stored wasm codes

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

Code gets the binary code and metadata for a singe wasm code

path Parameters
code_id
required
string <uint64>

Responses

ContractsByCode lists all smart contracts for a code id

path Parameters
code_id
required
string <uint64>
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

Params gets the module params

Responses

PinnedCodes gets the pinned code ids

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

ContractInfo gets the contract meta data

path Parameters
address
required
string

address is the address of the contract to query

Responses

ContractHistory gets the contract code history

path Parameters
address
required
string

address is the address of the contract 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

Responses

RawContractState gets single key from the raw store data of a contract

path Parameters
address
required
string

address is the address of the contract

query_data
required
string <byte>

Responses

SmartContractState get smart query result from the contract

path Parameters
address
required
string

address is the address of the contract

query_data
required
string <byte>

QueryData contains the query data passed to the contract

Responses

AllContractState gets all raw store data for a single contract

path Parameters
address
required
string

address is the address of the contract

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

ContractsByCreator gets the contracts by creator

path Parameters
creator_address
required
string

CreatorAddress is the address of contract creator

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

Channels queries all the IBC channels of a chain.

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

Channel queries an IBC Channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelClientState queries for the client state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

ChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

revision_number
required
string <uint64>

revision number of the consensus state

revision_height
required
string <uint64>

revision height of the consensus state

Responses

NextSequenceReceive returns the next receive sequence for a given channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

Responses

PacketAcknowledgements returns all the packet acknowledgements associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

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

packet_commitment_sequences
Array of strings <uint64>

list of packet sequences.

Responses

PacketAcknowledgement queries a stored packet acknowledgement hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketCommitments returns all the packet commitments hashes associated with a channel.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

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

UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_ack_sequences
required
Array of strings <uint64> non-empty

list of acknowledgement sequences

Responses

UnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

packet_commitment_sequences
required
Array of strings <uint64> non-empty

list of packet sequences

Responses

PacketCommitment queries a stored packet commitment hash.

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

PacketReceipt queries if a given packet sequence has been received on the queried chain

path Parameters
channel_id
required
string

channel unique identifier

port_id
required
string

port unique identifier

sequence
required
string <uint64>

packet sequence

Responses

ConnectionChannels queries all the channels associated with a connection end.

path Parameters
connection
required
string

connection unique identifier

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

ClientStates queries all the IBC light clients of a chain.

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

ClientState queries an IBC light client.

path Parameters
client_id
required
string

client state unique identifier

Responses

Status queries the status of an IBC client.

path Parameters
client_id
required
string

client unique identifier

Responses

ConsensusStates queries all the consensus state associated with a given client.

path Parameters
client_id
required
string

client identifier

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

ConsensusStateHeights queries the height of every consensus states associated with a given client.

path Parameters
client_id
required
string

client identifier

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

ConsensusState queries a consensus state associated with a client state at a given height.

path Parameters
client_id
required
string

client identifier

revision_number
required
string <uint64>

consensus state revision number

revision_height
required
string <uint64>

consensus state revision height

query Parameters
latest_height
boolean

latest_height overrrides the height field and queries the latest stored ConsensusState.

Responses

ClientParams queries all parameters of the ibc client submodule.

Responses

UpgradedClientState queries an Upgraded IBC light client.

Responses

UpgradedConsensusState queries an Upgraded IBC consensus state.

Responses

ClientConnections queries the connection paths associated with a client state.

path Parameters
client_id
required
string

client identifier associated with a connection

Responses

Connections queries all the IBC connections of a chain.

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

Connection queries an IBC connection end.

path Parameters
connection_id
required
string

connection unique identifier

Responses

ConnectionClientState queries the client state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

Responses

ConnectionConsensusState queries the consensus state associated with the connection.

path Parameters
connection_id
required
string

connection identifier

revision_number
required
string <uint64>
revision_height
required
string <uint64>

Responses

ConnectionParams queries all parameters of the ibc connection submodule.

Responses

EscrowAddress returns the escrow address for a particular port and channel id.

path Parameters
channel_id
required
string

unique channel identifier

port_id
required
string

unique port identifier

Responses

DenomHash queries a denomination hash information.

path Parameters
trace
required
string

The denomination trace ([port_id]/[channel_id])+/[denom]

Responses

DenomTraces queries all denomination traces.

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

DenomTrace queries a denomination trace information.

path Parameters
hash
required
string

hash (in hex format) or denom (full denom with ibc prefix) of the denomination trace information.

Responses

TotalEscrowForDenom returns the total amount of tokens in escrow based on the denom.

path Parameters
denom
required
string

Responses

Params queries all parameters of the ibc-transfer module.

Responses

FeeEnabledChannel returns true if the provided port and channel identifiers belong to a fee enabled channel

path Parameters
channel_id
required
string

unique channel identifier

port_id
required
string

unique port identifier

Responses

Gets all incentivized packets for a specific channel

path Parameters
channel_id
required
string
port_id
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

query_height
string <uint64>

Height to query at.

Responses

CounterpartyPayee returns the registered counterparty payee for forward relaying

path Parameters
channel_id
required
string

unique channel identifier

relayer
required
string

the relayer address to which the counterparty is registered

Responses

Payee returns the registered payee address for a specific channel given the relayer address

path Parameters
channel_id
required
string

unique channel identifier

relayer
required
string

the relayer address to which the distribution address is registered

Responses

IncentivizedPacket returns all packet fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

query Parameters
query_height
string <uint64>

block height at which to query.

Responses

TotalAckFees returns the total acknowledgement fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

TotalRecvFees returns the total receive fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

TotalTimeoutFees returns the total timeout fees for a packet given its identifier

path Parameters
packet_id.channel_id
required
string

channel unique identifier

packet_id.port_id
required
string

channel port identifier

packet_id.sequence
required
string <uint64>

packet sequence

Responses

FeeEnabledChannels returns a list of all fee enabled channels

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

query_height
string <uint64>

block height at which to query.

Responses

IncentivizedPackets returns all incentivized packets and their associated fees

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

query_height
string <uint64>

block height at which to query.

Responses

Params queries all parameters of the router module.

Responses

Params queries the parameters of the x/builder module.

Responses

FeeShares retrieves all registered FeeShares

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

FeeShare retrieves a registered FeeShare for a given contract address

path Parameters
contract_address
required
string

contract_address of a registered contract in bech32 format

Responses

DeployerFeeShares retrieves all FeeShares that a given deployer has registered

path Parameters
deployer_address
required
string

deployer_address in bech32 format

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

WithdrawerFeeShares retrieves all FeeShares with a given withdrawer address

path Parameters
withdrawer_address
required
string

withdrawer_address in bech32 format

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

Params retrieves the FeeShare module params

Responses

Params queries all parameters of the ICQ module.

Responses

Service

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

GetLatestBlock returns the latest block.

Responses

GetBlockByHeight queries block for given height.

path Parameters
height
required
string <int64>

Responses

GetNodeInfo queries the current node info.

Responses

GetSyncing queries node syncing.

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

Config queries for the operator configuration.

Responses

TxDecode decodes the transaction.

Since: cosmos-sdk 0.47

Request Body schema: application/json
tx_bytes
string <byte>

tx_bytes is the raw transaction.

Responses

Request samples

Content type
application/json
{
  • "tx_bytes": "string"
}

TxDecodeAmino decodes an Amino transaction from encoded bytes to JSON.

Since: cosmos-sdk 0.47

Request Body schema: application/json
amino_binary
string <byte>

Responses

Request samples

Content type
application/json
{
  • "amino_binary": "string"
}

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.

object (body is the processable content of the transaction)

TxBody is the body of a transaction that all signers sign over.

object (cosmos.tx.v1beta1.AuthInfo)

AuthInfo describes the fee and signer modes that are used to sign a transaction.

signatures
Array of strings <byte>

signatures is a list of signatures that matches the length and order of AuthInfo's signer_infos to allow connecting signature meta information like public key and signing mode by position.

Responses

Request samples

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

TxEncodeAmino encodes an Amino transaction from JSON to encoded bytes.

Since: cosmos-sdk 0.47

Request Body schema: application/json
amino_json
string

Responses

Request samples

Content type
application/json
{
  • "amino_json": "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

Content type
application/json
{
  • "tx": {
    },
  • "tx_bytes": "string"
}

GetTxsEvent fetches txs by event.

query Parameters
events
Array of strings

events is the list of transaction event 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

order_by
string
Default: "ORDER_BY_UNSPECIFIED"
Enum: "ORDER_BY_UNSPECIFIED" "ORDER_BY_ASC" "ORDER_BY_DESC"
  • ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.
  • ORDER_BY_ASC: ORDER_BY_ASC defines ascending order
  • ORDER_BY_DESC: ORDER_BY_DESC defines descending order
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.

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.

  • BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
  • BROADCAST_MODE_BLOCK: DEPRECATED: use BROADCAST_MODE_SYNC instead, BROADCAST_MODE_BLOCK is not supported by the SDK from v0.47.x onwards.
  • BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.
  • BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.

Responses

Request samples

Content type
application/json
{
  • "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

Responses

GetTx fetches a tx by hash.

path Parameters
hash
required
string

hash is the tx hash to query, encoded as a hex string.

Responses