Provenance Blockchain (1.13.0)
Download OpenAPI specification:Download
Provenance Blockchain Node Application
Accounts returns all the existing accounts.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.43
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AccountAddressByID returns account address based on account number.
Since: cosmos-sdk 0.46.2
path Parameters
| id required | string <int64> Deprecated, use account_id instead id is the account number of the address to be queried. This field should have been an uint64 (like all account numbers), and will be updated to uint64 in a future version of the auth query. |
query Parameters
| account_id | string <uint64> account_id is the account number of the address to be queried. Since: cosmos-sdk 0.47 |
Responses
AllBalances queries the balance of all coins for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| address required | string address is the address to query balances for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
| resolve_denom | boolean resolve_denom is the flag to resolve the denom into a human-readable form from the metadata. Since: cosmos-sdk 0.50 |
Responses
DenomOwners queries for all account addresses that own a particular token denomination.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.46
path Parameters
| denom required | string denom defines the coin denomination to query all account holders for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DenomOwnersByQuery queries for all account addresses that own a particular token denomination.
Since: cosmos-sdk 0.50.3
query Parameters
| denom | string denom defines the coin denomination to query all account holders for. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DenomsMetadata queries the client metadata for all registered coin denominations.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SendEnabled queries for SendEnabled entries.
This query only returns denominations that have specific SendEnabled settings. Any denomination that does not have a specific setting will use the default params.default_send_enabled, and will not be returned by this query.
Since: cosmos-sdk 0.47
query Parameters
| denoms | Array of strings denoms is the specific denoms you want look up. Leave empty to get all entries. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SpendableBalances queries the spendable balance of all coins for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.46
path Parameters
| address required | string address is the address to query spendable balances for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SpendableBalanceByDenom queries the spendable balance of a single denom for a single account.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Since: cosmos-sdk 0.47
path Parameters
| address required | string address is the address to query balances for. |
query Parameters
| denom | string denom is the coin denom to query balances for. |
Responses
TotalSupply queries the total supply of all coins.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorSlashes queries slash events of a validator.
path Parameters
| validator_address required | string validator_address defines the validator address to query for. |
query Parameters
| starting_height | string <uint64> starting_height defines the optional starting height to query the slashes. |
| ending_height | string <uint64> starting_height defines the optional ending height to query the slashes. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AllEvidence queries all evidence.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Evidence queries evidence based on evidence hash.
path Parameters
| hash required | string hash defines the evidence hash of the requested evidence. Since: cosmos-sdk 0.47 |
query Parameters
| evidence_hash | string <byte> evidence_hash defines the hash of the requested evidence. Deprecated: Use hash, a HEX encoded string, instead. |
Responses
Proposals queries all proposals based on given status.
query Parameters
| proposal_status | string Default: "PROPOSAL_STATUS_UNSPECIFIED" Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED" proposal_status defines the status of the proposals.
|
| voter | string voter defines the voter address for the proposals. |
| depositor | string depositor defines the deposit addresses from the proposals. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Deposits queries all deposits of a single proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Votes queries votes of a given proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Proposals queries all proposals based on given status.
query Parameters
| proposal_status | string Default: "PROPOSAL_STATUS_UNSPECIFIED" Enum: "PROPOSAL_STATUS_UNSPECIFIED" "PROPOSAL_STATUS_DEPOSIT_PERIOD" "PROPOSAL_STATUS_VOTING_PERIOD" "PROPOSAL_STATUS_PASSED" "PROPOSAL_STATUS_REJECTED" "PROPOSAL_STATUS_FAILED" proposal_status defines the status of the proposals.
|
| voter | string voter defines the voter address for the proposals. |
| depositor | string depositor defines the deposit addresses from the proposals. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Deposits queries all deposits of a single proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Votes queries votes of a given proposal.
path Parameters
| proposal_id required | string <uint64> proposal_id defines the unique id of the proposal. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
SigningInfos queries signing info of all validators
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DelegatorDelegations queries all delegations of a given delegator address.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Redelegations queries redelegations of given address.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| src_validator_addr | string src_validator_addr defines the validator address to redelegate from. |
| dst_validator_addr | string dst_validator_addr defines the validator address to redelegate to. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
DelegatorValidators queries all validators info for given delegator address.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| delegator_addr required | string delegator_addr defines the delegator address to query for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Validators queries all validators that match the given status.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
query Parameters
| status | string status enables to query for validators matching a given status. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorDelegations queries delegate info for given validator.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| validator_addr required | string validator_addr defines the validator address to query for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ValidatorUnbondingDelegations queries unbonding delegations of a validator.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
path Parameters
| validator_addr required | string validator_addr defines the validator address to query for. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
UpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain. UpgradedConsensusState RPC not supported with legacy querier This rpc is deprecated now that IBC has its own replacement (https://github.com/cosmos/ibc-go/blob/2c880a22e9f9cc75f62b527ca94aa75ce1106001/proto/ibc/core/client/v1/query.proto#L54)
path Parameters
| last_height required | string <int64> last height of the current chain must be sent in request as this is the height under which next consensus state is stored |
Responses
Returns list of `Authorization`, granted to the grantee by the granter.
query Parameters
| granter | string |
| grantee | string |
| msg_type_url | string Optional, msg_type_url, when set, will query only grants matching given msg type. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GranteeGrants returns a list of `GrantAuthorization` by grantee.
Since: cosmos-sdk 0.46
path Parameters
| grantee required | string |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GranterGrants returns list of `GrantAuthorization`, granted by granter.
Since: cosmos-sdk 0.46
path Parameters
| granter required | string |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Allowances returns all the grants for the given grantee address.
path Parameters
| grantee required | string |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AllowancesByGranter returns all the grants given by an address
Since: cosmos-sdk 0.46
path Parameters
| granter required | string |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupMembers queries members of a group by group id.
path Parameters
| group_id required | string <uint64> group_id is the unique ID of the group. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupPoliciesByAdmin queries group policies by admin address.
path Parameters
| admin required | string admin is the admin address of the group policy. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupPoliciesByGroup queries group policies by group id.
path Parameters
| group_id required | string <uint64> group_id is the unique ID of the group policy's group. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Groups queries all groups in state.
Since: cosmos-sdk 0.47.1
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupsByAdmin queries groups by admin address.
path Parameters
| admin required | string admin is the account address of a group's admin. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GroupsByMember queries groups by member address.
path Parameters
| address required | string address is the group member address. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
TallyResult returns the tally result of a proposal. If the proposal is still in voting period, then this query computes the current tally state, which might not be final. On the other hand, if the proposal is final, then it simply returns the `final_tally_result` state stored in the proposal itself.
path Parameters
| proposal_id required | string <uint64> proposal_id is the unique id of a proposal. |
Responses
ProposalsByGroupPolicy queries proposals based on account address of group policy.
path Parameters
| address required | string address is the account address of the group policy related to proposals. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
VotesByProposal queries a vote by proposal id.
path Parameters
| proposal_id required | string <uint64> proposal_id is the unique ID of a proposal. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
VotesByVoter queries a vote by voter.
path Parameters
| voter required | string voter is a proposal voter account address. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
Account returns account permissions.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
AttributeAccounts queries accounts on a given attribute name
path Parameters
| attribute_name required | string name is the attribute name 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
Scan queries attributes on a given account (address) for any that match the provided suffix
path Parameters
| account required | string account defines the address to query for. |
| suffix required | string name defines the partial attribute name to search for base on names being in RDNS 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
Attribute queries attributes on a given account (address) for one (or more) with the given name
path Parameters
| account required | string account defines the address to query for. |
| name required | string name is the attribute name 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
Attributes queries attributes on a given account (address) for any defined attributes
path Parameters
| account required | string account defines the 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
GetAllCommitments gets all fund committed to any market from any account.
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
GetMarketCommitments gets all the funds committed to a market from any account.
path Parameters
| market_id required | integer <int64> market_id is the numeric identifier of the market with the commitment. |
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
CommitmentSettlementFeeCalc calculates the fees a market will pay for a commitment settlement using current NAVs.
query Parameters
| settlement.admin | string admin is the account with "settle" permission requesting this settlement. |
| settlement.market_id | integer <int64> market_id is the numerical identifier of the market requesting this settlement. |
| settlement.event_tag | string event_tag is a string that is included in the funds-committed/released events. Max length is 100 characters. |
| include_breakdown_fields | boolean include_breakdown_fields controls the fields that are populated in the response. If false, only the exchange_fees field is populated. If true, all of the fields are populated as possible. If the settlement does not have any inputs, this field defaults to true. |
Responses
OrderFeeCalc calculates the fees that will be associated with the provided order.
query Parameters
| ask_order.market_id | integer <int64> market_id identifies the market that this order belongs to. |
| ask_order.seller | string seller is the address of the account that owns this order and has the assets to sell. |
| ask_order.assets.denom | string |
| ask_order.assets.amount | string |
| ask_order.price.denom | string |
| ask_order.price.amount | string |
| ask_order.seller_settlement_flat_fee.denom | string |
| ask_order.seller_settlement_flat_fee.amount | string |
| ask_order.allow_partial | boolean allow_partial should be true if partial fulfillment of this order should be allowed, and should be false if the order must be either filled in full or not filled at all. |
| ask_order.external_id | string external_id is an optional string used to externally identify this order. Max length is 100 characters. If an order in this market with this external id already exists, this order will be rejected. |
| bid_order.market_id | integer <int64> market_id identifies the market that this order belongs to. |
| bid_order.buyer | string buyer is the address of the account that owns this order and has the price to spend. |
| bid_order.assets.denom | string |
| bid_order.assets.amount | string |
| bid_order.price.denom | string |
| bid_order.price.amount | string |
| bid_order.allow_partial | boolean allow_partial should be true if partial fulfillment of this order should be allowed, and should be false if the order must be either filled in full or not filled at all. |
| bid_order.external_id | string external_id is an optional string used to externally identify this order. Max length is 100 characters. If an order in this market with this external id already exists, this order will be rejected. |
Responses
PaymentFeeCalc calculates the fees that must be paid for creating or accepting a specific payment.
query Parameters
| payment.source | string source is the account that created this Payment. It is considered the owner of the payment. |
| payment.target | string target is the account that can accept this Payment. The target is the only thing allowed to change in a payment. I.e. it can be empty initially and updated later as needed. |
| payment.external_id | string external_id is used along with the source to uniquely identify this Payment. A source can only have one Payment with any given external id. A source can have two payments with two different external ids. Two different sources can each have a payment with the same external id. But a source cannot have two different payments each with the same external id. An external id can be reused by a source once the payment is accepted, rejected, or cancelled. The external id is limited to 100 bytes. An empty string is a valid external id. |
Responses
GetMarketCommitments gets all the funds committed to a market from any account.
path Parameters
| market_id required | integer <int64> market_id is the numeric identifier of the market with the commitment. |
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
GetMarketOrders looks up the orders in a market.
path Parameters
| market_id required | integer <int64> market_id is the id of the market to get all the orders for. |
query Parameters
| order_type | string order_type is optional and can limit orders to only "ask" or "bid" orders. |
| after_order_id | string <uint64> after_order_id is a minimum (exclusive) order id. All results will be strictly greater than this. |
| 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
GetAllMarkets returns brief information about each market.
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
GetAllOrders gets all orders in the exchange module.
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
GetAssetOrders looks up the orders for a specific asset denom.
path Parameters
| asset required | string asset is the denom of assets to get orders for. |
query Parameters
| order_type | string order_type is optional and can limit orders to only "ask" or "bid" orders. |
| after_order_id | string <uint64> after_order_id is a minimum (exclusive) order id. All results will be strictly greater than this. |
| 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
GetMarketOrders looks up the orders in a market.
path Parameters
| market_id required | integer <int64> market_id is the id of the market to get all the orders for. |
query Parameters
| order_type | string order_type is optional and can limit orders to only "ask" or "bid" orders. |
| after_order_id | string <uint64> after_order_id is a minimum (exclusive) order id. All results will be strictly greater than this. |
| 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
GetOwnerOrders looks up the orders from the provided owner address.
path Parameters
| owner required | string owner is the bech32 address string of the owner to get the orders for. |
query Parameters
| order_type | string order_type is optional and can limit orders to only "ask" or "bid" orders. |
| after_order_id | string <uint64> after_order_id is a minimum (exclusive) order id. All results will be strictly greater than this. |
| 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
GetAllPayments gets all payments.
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
GetPaymentsWithSource gets all payments with a specific source account.
path Parameters
| source required | string source is the source account of the payments to get. |
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
GetPaymentsWithTarget gets all payments with a specific target account.
path Parameters
| target required | string target is the target account of the payments to get. |
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
ValidateCreateMarket checks the provided MsgGovCreateMarketResponse and returns any errors it might have.
query Parameters
| create_market_request.authority | string authority should be the governance module account address. |
| create_market_request.market.market_id | integer <int64> market_id is the numerical identifier for this market. |
| create_market_request.market.market_details.name | string name is a moniker that people can use to refer to this market. |
| create_market_request.market.market_details.description | string description extra information about this market. The field is meant to be human-readable. |
| create_market_request.market.market_details.website_url | string website_url is a url people can use to get to this market, or at least get more information about this market. |
| create_market_request.market.market_details.icon_uri | string icon_uri is a uri for an icon to associate with this market. |
| create_market_request.market.accepting_orders | boolean accepting_orders is whether this market is allowing orders to be created for it. |
| create_market_request.market.allow_user_settlement | boolean allow_user_settlement is whether this market allows users to initiate their own settlements. For example, the FillBids and FillAsks endpoints are available if and only if this is true. The MarketSettle endpoint is only available to market actors regardless of the value of this field. |
| create_market_request.market.req_attr_create_ask | Array of strings req_attr_create_ask is a list of attributes required on an account for it to be allowed to create an ask order. An account must have all of these attributes in order to create an ask order in this market. If the list is empty, any account can create ask orders in this market. An entry that starts with "." will match any attributes that end with the rest of it. E.g. ".b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "b.x.a", or "c.b.a.x". |
| create_market_request.market.req_attr_create_bid | Array of strings req_attr_create_ask is a list of attributes required on an account for it to be allowed to create a bid order. An account must have all of these attributes in order to create a bid order in this market. If the list is empty, any account can create bid orders in this market. An entry that starts with "." will match any attributes that end with the rest of it. E.g. ".b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "c.b.x.a", or "c.b.a.x". |
| create_market_request.market.accepting_commitments | boolean accepting_commitments is whether the market is allowing users to commit funds to it. |
| create_market_request.market.commitment_settlement_bips | integer <int64> commitment_settlement_bips is the fraction of a commitment settlement that will be paid to the exchange. It is represented in basis points (1/100th of 1%, e.g. 0.0001) and is limited to 0 to 10,000 inclusive. During a commitment settlement, the inputs are summed and NAVs are used to convert that total to the intermediary denom, then to the fee denom. That is then multiplied by this value to get the fee amount that will be transferred out of the market's account into the exchange for that settlement. Summing the inputs effectively doubles the value of the settlement from what what is usually thought of as the value of a trade. That should be taken into account when setting this value. E.g. if two accounts are trading 10apples for 100grapes, the inputs total will be 10apples,100grapes (which might then be converted to USD then nhash before applying this ratio); Usually, though, the value of that trade would be viewed as either just 10apples or just 100grapes. |
| create_market_request.market.intermediary_denom | string intermediary_denom is the denom that funds get converted to (before being converted to the chain's fee denom) when calculating the fees that are paid to the exchange. NAVs are used for this conversion and actions will fail if a NAV is needed but not available. |
| create_market_request.market.req_attr_create_commitment | Array of strings req_attr_create_commitment is a list of attributes required on an account for it to be allowed to create a commitment. An account must have all of these attributes in order to create a commitment in this market. If the list is empty, any account can create commitments in this market. An entry that starts with "." will match any attributes that end with the rest of it. E.g. ".b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "c.b.x.a", or "c.b.a.x". |
Responses
ValidateManageFees checks the provided MsgGovManageFeesRequest and returns any errors that it might have.
query Parameters
| manage_fees_request.authority | string authority should be the governance module account address. |
| manage_fees_request.market_id | integer <int64> market_id is the market id that will get these fee updates. |
| manage_fees_request.set_fee_commitment_settlement_bips | integer <int64> set_fee_commitment_settlement_bips is the new fee_commitment_settlement_bips for the market. It is ignored if it is zero. To set it to zero set unset_fee_commitment_settlement_bips to true. |
| manage_fees_request.unset_fee_commitment_settlement_bips | boolean unset_fee_commitment_settlement_bips, if true, sets the fee_commitment_settlement_bips to zero. If false, it is ignored. |
Responses
GetAllHolds returns all addresses with funds on hold, and the amount held.
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
Returns a list of all markers on the blockchain
query Parameters
| status | string Default: "MARKER_STATUS_UNSPECIFIED" Enum: "MARKER_STATUS_UNSPECIFIED" "MARKER_STATUS_PROPOSED" "MARKER_STATUS_FINALIZED" "MARKER_STATUS_ACTIVE" "MARKER_STATUS_CANCELLED" "MARKER_STATUS_DESTROYED" Optional status to filter request.
|
| 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 all accounts holding the given marker coins
path Parameters
| id required | string the address or denom of the marker |
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
ContractSpecification returns a contract specification for the given specification id.
The specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84, a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn, or a bech32 record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. If it is a record specification address, then the contract specification that contains that record specification is looked up.
By default, the record specifications for this contract specification are not included. Set include_record_specs to true to include them in the result.
path Parameters
| specification_id required | string specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84 or a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn. It can also be a record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. |
query Parameters
| include_record_specs | boolean include_record_specs is a flag for whether to include the the record specifications of this contract specification in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
RecordSpecification returns a record specification for the given input.
path Parameters
| specification_id required | string specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84 or a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn. It can also be a record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. |
| name required | string name is the name of the record to look up. It is required if the specification_id is a uuid or contract specification address. It is ignored if the specification_id is a record specification address. |
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
RecordSpecificationsForContractSpecification returns the record specifications for the given input.
The specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84, a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn, or a bech32 record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. If it is a record specification address, then the contract specification that contains that record specification is used.
path Parameters
| specification_id required | string specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84 or a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn. It can also be a record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. |
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
ContractSpecificationsAll retrieves all contract specifications.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
OSLocatorsByURI returns all ObjectStoreLocator entries for a locator uri.
path Parameters
| uri required | string |
query Parameters
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
OSAllLocators returns all ObjectStoreLocator entries.
query Parameters
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
Ownership returns the scope identifiers that list the given address as either a data or value owner.
path Parameters
| address required | string |
query Parameters
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| record_addr required | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
query Parameters
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| name | string name is the name of the record to look for. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Scope searches for a scope.
The scope id, if provided, must either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. The session addr, if provided, must be a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, that scope is returned.
- If only a session_addr is provided, the scope containing that session is returned.
- If only a record_addr is provided, the scope containing that record is returned.
- If more than one of scope_id, session_addr, and record_addr are provided, and they don't refer to the same scope, a bad request is returned.
Providing a session addr or record addr does not limit the sessions and records returned (if requested). Those parameters are only used to find the scope.
By default, sessions and records are not included. Set include_sessions and/or include_records to true to include sessions and/or records.
path Parameters
| record_addr required | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
query Parameters
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_addr | string session_addr is a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions of the scope in the response. |
| include_records | boolean include_records is a flag for whether to include the records of the scope in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Sessions searches for sessions.
The scope_id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, all sessions in that scope are returned.
- If only a session_id is provided, it must be an address, and that single session is returned.
- If the session_id is a uuid, then either a scope_id or record_addr must also be provided, and that single session is returned.
- If only a record_addr is provided, the session containing that record will be returned.
- If a record_name is provided then either a scope_id, session_id as an address, or record_addr must also be provided, and the session containing that record will be returned.
A bad request is returned if:
- The session_id is a uuid and is provided without a scope_id or record_addr.
- A record_name is provided without any way to identify the scope (e.g. a scope_id, a session_id as an address, or a record_addr).
- Two or more of scope_id, session_id as an address, and record_addr are provided and don't all refer to the same scope.
- A record_addr (or scope_id and record_name) is provided with a session_id and that session does not contain such a record.
- A record_addr and record_name are both provided, but reference different records.
By default, the scope and records are not included. Set include_scope and/or include_records to true to include the scope and/or records.
path Parameters
| record_addr required | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
query Parameters
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| record_name | string record_name is the name of the record to find the session for in the provided scope. |
| include_scope | boolean include_scope is a flag for whether to include the scope containing these sessions in the response. |
| include_records | boolean include_records is a flag for whether to include the records of these sessions in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
RecordsAll retrieves all records.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
RecordSpecification returns a record specification for the given input.
path Parameters
| specification_id required | string specification_id can either be a uuid, e.g. def6bc0a-c9dd-4874-948f-5206e6060a84 or a bech32 contract specification address, e.g. contractspec1q000d0q2e8w5say53afqdesxp2zqzkr4fn. It can also be a record specification address, e.g. recspec1qh00d0q2e8w5say53afqdesxp2zw42dq2jdvmdazuwzcaddhh8gmuqhez44. |
query Parameters
| name | string name is the name of the record to look up. It is required if the specification_id is a uuid or contract specification address. It is ignored if the specification_id is a record specification address. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
RecordSpecificationsAll retrieves all record specifications.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
Scope searches for a scope.
The scope id, if provided, must either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. The session addr, if provided, must be a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, that scope is returned.
- If only a session_addr is provided, the scope containing that session is returned.
- If only a record_addr is provided, the scope containing that record is returned.
- If more than one of scope_id, session_addr, and record_addr are provided, and they don't refer to the same scope, a bad request is returned.
Providing a session addr or record addr does not limit the sessions and records returned (if requested). Those parameters are only used to find the scope.
By default, sessions and records are not included. Set include_sessions and/or include_records to true to include sessions and/or records.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
query Parameters
| session_addr | string session_addr is a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. |
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions of the scope in the response. |
| include_records | boolean include_records is a flag for whether to include the records of the scope in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| name required | string name is the name of the record to look for |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Sessions searches for sessions.
The scope_id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, all sessions in that scope are returned.
- If only a session_id is provided, it must be an address, and that single session is returned.
- If the session_id is a uuid, then either a scope_id or record_addr must also be provided, and that single session is returned.
- If only a record_addr is provided, the session containing that record will be returned.
- If a record_name is provided then either a scope_id, session_id as an address, or record_addr must also be provided, and the session containing that record will be returned.
A bad request is returned if:
- The session_id is a uuid and is provided without a scope_id or record_addr.
- A record_name is provided without any way to identify the scope (e.g. a scope_id, a session_id as an address, or a record_addr).
- Two or more of scope_id, session_id as an address, and record_addr are provided and don't all refer to the same scope.
- A record_addr (or scope_id and record_name) is provided with a session_id and that session does not contain such a record.
- A record_addr and record_name are both provided, but reference different records.
By default, the scope and records are not included. Set include_scope and/or include_records to true to include the scope and/or records.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| record_name required | string record_name is the name of the record to find the session for in the provided scope. |
query Parameters
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| include_scope | boolean include_scope is a flag for whether to include the scope containing these sessions in the response. |
| include_records | boolean include_records is a flag for whether to include the records of these sessions in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| name | string name is the name of the record to look for. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Sessions searches for sessions.
The scope_id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, all sessions in that scope are returned.
- If only a session_id is provided, it must be an address, and that single session is returned.
- If the session_id is a uuid, then either a scope_id or record_addr must also be provided, and that single session is returned.
- If only a record_addr is provided, the session containing that record will be returned.
- If a record_name is provided then either a scope_id, session_id as an address, or record_addr must also be provided, and the session containing that record will be returned.
A bad request is returned if:
- The session_id is a uuid and is provided without a scope_id or record_addr.
- A record_name is provided without any way to identify the scope (e.g. a scope_id, a session_id as an address, or a record_addr).
- Two or more of scope_id, session_id as an address, and record_addr are provided and don't all refer to the same scope.
- A record_addr (or scope_id and record_name) is provided with a session_id and that session does not contain such a record.
- A record_addr and record_name are both provided, but reference different records.
By default, the scope and records are not included. Set include_scope and/or include_records to true to include the scope and/or records.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| record_name | string record_name is the name of the record to find the session for in the provided scope. |
| include_scope | boolean include_scope is a flag for whether to include the scope containing these sessions in the response. |
| include_records | boolean include_records is a flag for whether to include the records of these sessions in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| name required | string name is the name of the record to look for |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| name | string name is the name of the record to look for. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Sessions searches for sessions.
The scope_id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, all sessions in that scope are returned.
- If only a session_id is provided, it must be an address, and that single session is returned.
- If the session_id is a uuid, then either a scope_id or record_addr must also be provided, and that single session is returned.
- If only a record_addr is provided, the session containing that record will be returned.
- If a record_name is provided then either a scope_id, session_id as an address, or record_addr must also be provided, and the session containing that record will be returned.
A bad request is returned if:
- The session_id is a uuid and is provided without a scope_id or record_addr.
- A record_name is provided without any way to identify the scope (e.g. a scope_id, a session_id as an address, or a record_addr).
- Two or more of scope_id, session_id as an address, and record_addr are provided and don't all refer to the same scope.
- A record_addr (or scope_id and record_name) is provided with a session_id and that session does not contain such a record.
- A record_addr and record_name are both provided, but reference different records.
By default, the scope and records are not included. Set include_scope and/or include_records to true to include the scope and/or records.
path Parameters
| scope_id required | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
query Parameters
| session_id | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| record_name | string record_name is the name of the record to find the session for in the provided scope. |
| include_scope | boolean include_scope is a flag for whether to include the scope containing these sessions in the response. |
| include_records | boolean include_records is a flag for whether to include the records of these sessions in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
ScopesAll retrieves all scopes.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
ScopeSpecification returns a scope specification for the given specification id.
The specification_id can either be a uuid, e.g. dc83ea70-eacd-40fe-9adf-1cf6148bf8a2 or a bech32 scope specification address, e.g. scopespec1qnwg86nsatx5pl56muw0v9ytlz3qu3jx6m.
By default, the contract and record specifications are not included. Set include_contract_specs and/or include_record_specs to true to include contract and/or record specifications.
path Parameters
| specification_id required | string specification_id can either be a uuid, e.g. dc83ea70-eacd-40fe-9adf-1cf6148bf8a2 or a bech32 scope specification address, e.g. scopespec1qnwg86nsatx5pl56muw0v9ytlz3qu3jx6m. |
query Parameters
| include_contract_specs | boolean include_contract_specs is a flag for whether to include the contract specifications of the scope specification in the response. |
| include_record_specs | boolean include_record_specs is a flag for whether to include the record specifications of the scope specification in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
ScopeSpecificationsAll retrieves all scope specifications.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
Scope searches for a scope.
The scope id, if provided, must either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. The session addr, if provided, must be a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, that scope is returned.
- If only a session_addr is provided, the scope containing that session is returned.
- If only a record_addr is provided, the scope containing that record is returned.
- If more than one of scope_id, session_addr, and record_addr are provided, and they don't refer to the same scope, a bad request is returned.
Providing a session addr or record addr does not limit the sessions and records returned (if requested). Those parameters are only used to find the scope.
By default, sessions and records are not included. Set include_sessions and/or include_records to true to include sessions and/or records.
path Parameters
| session_addr required | string session_addr is a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. |
query Parameters
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions of the scope in the response. |
| include_records | boolean include_records is a flag for whether to include the records of the scope in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Sessions searches for sessions.
The scope_id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3.
- If only a scope_id is provided, all sessions in that scope are returned.
- If only a session_id is provided, it must be an address, and that single session is returned.
- If the session_id is a uuid, then either a scope_id or record_addr must also be provided, and that single session is returned.
- If only a record_addr is provided, the session containing that record will be returned.
- If a record_name is provided then either a scope_id, session_id as an address, or record_addr must also be provided, and the session containing that record will be returned.
A bad request is returned if:
- The session_id is a uuid and is provided without a scope_id or record_addr.
- A record_name is provided without any way to identify the scope (e.g. a scope_id, a session_id as an address, or a record_addr).
- Two or more of scope_id, session_id as an address, and record_addr are provided and don't all refer to the same scope.
- A record_addr (or scope_id and record_name) is provided with a session_id and that session does not contain such a record.
- A record_addr and record_name are both provided, but reference different records.
By default, the scope and records are not included. Set include_scope and/or include_records to true to include the scope and/or records.
path Parameters
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
query Parameters
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| record_name | string record_name is the name of the record to find the session for in the provided scope. |
| include_scope | boolean include_scope is a flag for whether to include the scope containing these sessions in the response. |
| include_records | boolean include_records is a flag for whether to include the records of these sessions in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
| name required | string name is the name of the record to look for |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
Records searches for records.
The record_addr, if provided, must be a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. The scope-id can either be scope uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. Similarly, the session_id can either be a uuid or session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. The name is the name of the record you're interested in.
- If only a record_addr is provided, that single record will be returned.
- If only a scope_id is provided, all records in that scope will be returned.
- If only a session_id (or scope_id/session_id), all records in that session will be returned.
- If a name is provided with a scope_id and/or session_id, that single record will be returned.
A bad request is returned if:
- The session_id is a uuid and no scope_id is provided.
- There are two or more of record_addr, session_id, and scope_id, and they don't all refer to the same scope.
- A name is provided, but not a scope_id and/or a session_id.
- A name and record_addr are provided and the name doesn't match the record_addr.
By default, the scope and sessions are not included. Set include_scope and/or include_sessions to true to include the scope and/or sessions.
path Parameters
| session_id required | string session_id can either be a uuid, e.g. 5803f8bc-6067-4eb5-951f-2121671c2ec0 or a bech32 session address, e.g. session1qxge0zaztu65tx5x5llv5xc9zts9sqlch3sxwn44j50jzgt8rshvqyfrjcr. This can only be a uuid if a scope_id is also provided. |
query Parameters
| record_addr | string record_addr is a bech32 record address, e.g. record1q2ge0zaztu65tx5x5llv5xc9ztsw42dq2jdvmdazuwzcaddhh8gmu3mcze3. |
| scope_id | string scope_id can either be a uuid, e.g. 91978ba2-5f35-459a-86a7-feca1b0512e0 or a bech32 scope address, e.g. scope1qzge0zaztu65tx5x5llv5xc9ztsqxlkwel. |
| name | string name is the name of the record to look for. |
| include_scope | boolean include_scope is a flag for whether to include the the scope containing these records in the response. |
| include_sessions | boolean include_sessions is a flag for whether to include the sessions containing these records in the response. |
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
Responses
SessionsAll retrieves all sessions.
query Parameters
| exclude_id_info | boolean exclude_id_info is a flag for whether to exclude the id info from the response. |
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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
ValueOwnership returns the scope identifiers that list the given address as the value owner.
path Parameters
| address required | string |
query Parameters
| include_request | boolean include_request is a flag for whether to include this request in your result. |
| 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 Msgs which have fees associated with them.
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
CalculateTxFees simulates executing a transaction for estimating gas usage and additional fees.
Request Body schema: application/jsonrequired
| tx_bytes | string <byte> tx_bytes is the transaction to simulate. |
| default_base_denom | string default_base_denom is used to set the denom used for gas fees if not set it will default to nhash. |
| gas_adjustment | number <float> (gas_adjustment is the adjustment factor to be multiplied against the estimate returned by the tx simulation) |
Responses
Request samples
- Payload
{- "tx_bytes": "string",
- "default_base_denom": "string",
- "gas_adjustment": 0
}ReverseLookup queries for all names bound against a given address
path Parameters
| address required | string address to find name records 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
SanctionedAddresses returns a list of sanctioned addresses.
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
TemporaryEntries returns temporary sanction/unsanction info.
query Parameters
| address | string address is an optional address to restrict results 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
AutoResponses gets the auto-response settings for a quarantined account.
The to_address is required. If a from_address is provided only the auto response for that from_address will be returned. If no from_address is provided, all auto-response settings for the given to_address will be returned.
path Parameters
| to_address required | string to_address is the quarantined account to get info on. |
query Parameters
| from_address | string from_address is an optional sender address to limit results. |
| 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
AutoResponses gets the auto-response settings for a quarantined account.
The to_address is required. If a from_address is provided only the auto response for that from_address will be returned. If no from_address is provided, all auto-response settings for the given to_address will be returned.
path Parameters
| to_address required | string to_address is the quarantined account to get info on. |
| from_address required | string from_address is an optional sender address to limit results. |
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
QuarantinedFunds gets information about funds that have been quarantined.
If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.
query Parameters
| to_address | string to_address is the intended recipient of the coins that have been quarantined. |
| from_address | string from_address is the sender of the coins. If provided, a to_address must also be provided. |
| 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
QuarantinedFunds gets information about funds that have been quarantined.
If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.
path Parameters
| to_address required | string to_address is the intended recipient of the coins that have been quarantined. |
query Parameters
| from_address | string from_address is the sender of the coins. If provided, a to_address must also be provided. |
| 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
QuarantinedFunds gets information about funds that have been quarantined.
If both a to_address and from_address are provided, any such quarantined funds will be returned regardless of whether they've been declined. If only a to_address is provided, the unaccepted and undeclined funds waiting on a response from to_address will be returned. If neither a to_address nor from_address is provided, all non-declined quarantined funds for any address will be returned. The request is invalid if only a from_address is provided.
path Parameters
| to_address required | string to_address is the intended recipient of the coins that have been quarantined. |
| from_address required | string from_address is the sender of the coins. If provided, a to_address must also be provided. |
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
Triggers returns the list of triggers.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
ABCIQuery defines a query handler that supports ABCI queries directly to the application, bypassing Tendermint completely. The ABCI query must contain a valid and supported path, including app, custom, p2p, and store.
Since: cosmos-sdk 0.46
query Parameters
| data | string <byte> |
| path | string |
| height | string <int64> |
| prove | boolean |
Responses
GetLatestValidatorSet queries latest validator-set.
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
GetValidatorSetByHeight queries validator-set at a given height.
path Parameters
| height required | string <int64> |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
Responses
TxEncode encodes the transaction.
Since: cosmos-sdk 0.47
Request Body schema: application/jsonrequired
object (cosmos.tx.v1beta1.Tx) Tx is the standard type used for broadcasting transactions. | |||||||
| |||||||
Responses
Request samples
- Payload
{- "tx": {
- "body": {
- "messages": [
- {
- "type_url": "string",
- "value": "string"
}
], - "memo": "string",
- "timeout_height": "string",
- "extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
], - "non_critical_extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
]
}, - "auth_info": {
- "signer_infos": [
- {
- "public_key": {
- "type_url": "string",
- "value": "string"
}, - "mode_info": {
- "single": {
- "mode": "SIGN_MODE_UNSPECIFIED"
}, - "multi": {
- "bitarray": {
- "extra_bits_stored": 0,
- "elems": "string"
}, - "mode_infos": [
- { }
]
}
}, - "sequence": "string"
}
], - "fee": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "gas_limit": "string",
- "payer": "string",
- "granter": "string"
}, - "tip": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "tipper": "string"
}
}, - "signatures": [
- "string"
]
}
}Simulate simulates executing a transaction for estimating gas usage.
Request Body schema: application/jsonrequired
object (cosmos.tx.v1beta1.Tx) Tx is the standard type used for broadcasting transactions. | |
| tx_bytes | string <byte> tx_bytes is the raw transaction. Since: cosmos-sdk 0.43 |
Responses
Request samples
- Payload
{- "tx": {
- "body": {
- "messages": [
- {
- "type_url": "string",
- "value": "string"
}
], - "memo": "string",
- "timeout_height": "string",
- "extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
], - "non_critical_extension_options": [
- {
- "type_url": "string",
- "value": "string"
}
]
}, - "auth_info": {
- "signer_infos": [
- {
- "public_key": {
- "type_url": "string",
- "value": "string"
}, - "mode_info": {
- "single": {
- "mode": "SIGN_MODE_UNSPECIFIED"
}, - "multi": {
- "bitarray": {
- "extra_bits_stored": 0,
- "elems": "string"
}, - "mode_infos": [
- { }
]
}
}, - "sequence": "string"
}
], - "fee": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "gas_limit": "string",
- "payer": "string",
- "granter": "string"
}, - "tip": {
- "amount": [
- {
- "denom": "string",
- "amount": "string"
}
], - "tipper": "string"
}
}, - "signatures": [
- "string"
]
}, - "tx_bytes": "string"
}GetTxsEvent fetches txs by event.
query Parameters
| events | Array of strings events is the list of transaction event type. Deprecated post v0.47.x: use query instead, which should contain a valid events query. |
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |
| order_by | string Default: "ORDER_BY_UNSPECIFIED" Enum: "ORDER_BY_UNSPECIFIED" "ORDER_BY_ASC" "ORDER_BY_DESC"
|
| page | string <uint64> page is the page number to query, starts at 1. If not provided, will default to first page. |
| limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| query | string query defines the transaction event query that is proxied to Tendermint's TxSearch RPC method. The query must be valid. Since cosmos-sdk 0.50 |
Responses
BroadcastTx broadcast transaction.
Request Body schema: application/jsonrequired
| tx_bytes | string <byte> tx_bytes is the raw transaction. |
| mode | string Default: "BROADCAST_MODE_UNSPECIFIED" Enum: "BROADCAST_MODE_UNSPECIFIED" "BROADCAST_MODE_BLOCK" "BROADCAST_MODE_SYNC" "BROADCAST_MODE_ASYNC" BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC method.
|
Responses
Request samples
- Payload
{- "tx_bytes": "string",
- "mode": "BROADCAST_MODE_UNSPECIFIED"
}GetBlockWithTxs fetches a block with decoded txs.
Since: cosmos-sdk 0.45.2
path Parameters
| height required | string <int64> height is the height of the block to query. |
query Parameters
| pagination.key | string <byte> key is a value returned in PageResponse.next_key to begin querying the next page most efficiently. Only one of offset or key should be set. |
| pagination.offset | string <uint64> offset is a numeric offset that can be used when key is unavailable. It is less efficient than using key. Only one of offset or key should be set. |
| pagination.limit | string <uint64> limit is the total number of results to be returned in the result page. If left empty it will default to a value to be set by each app. |
| pagination.count_total | boolean count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. count_total is only respected when offset is used. It is ignored when key is set. |
| pagination.reverse | boolean reverse is set to true if results are to be returned in the descending order. Since: cosmos-sdk 0.43 |