Injective Chain - Legacy REST and gRPC Gateway docs
v1.0.0https://inj.nownodes.iohttps://inj-jsonrpc.nownodes.iohttps://inj-indexer.nownodes.ioNowNodes indexerhttps://inj-tendermint.nownodes.ioA REST interface for state queries, legacy transactions
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
API Reference
Feed_config
Retrieves the OCR FeedConfig for a given FeedId
Parameters
feed_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerFeed_config_info
Retrieves the OCR FeedConfigInfo for a given FeedId
Parameters
feed_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerLatest_round
Retrieves latest round ID and data, including median answer for that round
Parameters
feed_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerLatest_transmission_details
LatestTransmissionDetails returns details about the latest trasmission recorded on chain for the given feed ID.
Parameters
feed_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerModule_state
Retrieves the entire OCR module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire peggy module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerOwed_amount
Retrieves transmitter's owed amount
Parameters
transmitterstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries a specific parameter of a module, given its subspace and key.
Parameters
subspacestringquerysubspace defines the module to query the parameter for.
keystringquerykey defines the key of the parameter in the subspace.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSubspaces queries for all registered subspaces and all keys for a subspace.
Since: cosmos-sdk 0.46
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDeployments queries deployments
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAuth
AccountInfo queries account info which is common to all account types.
Since: cosmos-sdk 0.47
Parameters
addressstringrequiredpathaddress is the account address string.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAccounts 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
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAccount returns account details based on address.
Parameters
addressstringrequiredpathaddress defines the address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAccountAddressByID returns account address based on account number.
Since: cosmos-sdk 0.46.2
Parameters
idstring<int64>requiredpathDeprecated, 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.
account_idstring<uint64>queryaccount_id is the account number of the address to be queried.
Since: cosmos-sdk 0.47
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBech32Prefix queries bech32Prefix
Since: cosmos-sdk 0.46
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAddressBytesToString converts Account Address bytes to string
Since: cosmos-sdk 0.46
Parameters
address_bytesstring<byte>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAddressStringToBytes converts Address string to bytes
Since: cosmos-sdk 0.46
Parameters
address_stringstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerModuleAccounts returns all the existing module accounts.
Since: cosmos-sdk 0.46
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerModuleAccountByName returns the module account info by module name
Parameters
namestringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries all parameters.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBank
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.
Parameters
addressstringrequiredpathaddress is the address to query balances for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
resolve_denombooleanqueryresolve_denom is the flag to resolve the denom into a human-readable form from the metadata.
Since: cosmos-sdk 0.50
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBalance queries the balance of a single coin for a single account.
Parameters
addressstringrequiredpathaddress is the address to query balances for.
denomstringquerydenom is the coin denom to query balances for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomOwners 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
Parameters
denomstringrequiredpathdenom defines the coin denomination to query all account holders for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomOwnersByQuery queries for all account addresses that own a particular token denomination.
Since: cosmos-sdk 0.50.3
Parameters
denomstringquerydenom defines the coin denomination to query all account holders for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomsMetadata queries the client metadata for all registered coin denominations.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomMetadata queries the client metadata of a given coin denomination.
Parameters
denomstringrequiredpathdenom is the coin denom to query the metadata for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomMetadataByQueryString queries the client metadata of a given coin denomination.
Parameters
denomstringquerydenom is the coin denom to query the metadata for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries the parameters of x/bank module.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSendEnabled 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
Parameters
denomsArray<string>querydenoms is the specific denoms you want look up. Leave empty to get all entries.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSpendableBalances 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
Parameters
addressstringrequiredpathaddress is the address to query spendable balances for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSpendableBalanceByDenom 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
Parameters
addressstringrequiredpathaddress is the address to query balances for.
denomstringquerydenom is the coin denom to query balances for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTotalSupply 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.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSupplyOf queries the supply of a single coin.
When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
Parameters
denomstringquerydenom is the coin denom to query balances for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBase
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
Parameters
datastring<byte>querypathstringqueryheightstring<int64>queryprovebooleanqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetLatestBlock returns the latest block.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetBlockByHeight queries block for given height.
Parameters
heightstring<int64>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetNodeInfo queries the current node info.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetSyncing queries node syncing.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetLatestValidatorSet queries latest validator-set.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetValidatorSetByHeight queries validator-set at a given height.
Parameters
heightstring<int64>requiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConfig queries for the operator configuration.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerStatus queries for the node status.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDistribution
CommunityPool queries the community pool coins.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegationTotalRewards queries the total rewards accrued by each validator.
Parameters
delegator_addressstringrequiredpathdelegator_address defines the delegator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegationRewards queries the total rewards accrued by a delegation.
Parameters
delegator_addressstringrequiredpathdelegator_address defines the delegator address to query for.
validator_addressstringrequiredpathvalidator_address defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegatorValidators queries the validators of a delegator.
Parameters
delegator_addressstringrequiredpathdelegator_address defines the delegator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegatorWithdrawAddress queries withdraw address of a delegator.
Parameters
delegator_addressstringrequiredpathdelegator_address defines the delegator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries params of the distribution module.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorDistributionInfo queries validator commission and self-delegation rewards for validator
Parameters
validator_addressstringrequiredpathvalidator_address defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorCommission queries accumulated commission for a validator.
Parameters
validator_addressstringrequiredpathvalidator_address defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorOutstandingRewards queries rewards of a validator address.
Parameters
validator_addressstringrequiredpathvalidator_address defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorSlashes queries slash events of a validator.
Parameters
validator_addressstringrequiredpathvalidator_address defines the validator address to query for.
starting_heightstring<uint64>querystarting_height defines the optional starting height to query the slashes.
ending_heightstring<uint64>querystarting_height defines the optional ending height to query the slashes.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerEvidence
AllEvidence queries all evidence.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerEvidence queries evidence based on evidence hash.
Parameters
hashstringrequiredpathhash defines the evidence hash of the requested evidence.
Since: cosmos-sdk 0.47
evidence_hashstring<byte>queryevidence_hash defines the hash of the requested evidence. Deprecated: Use hash, a HEX encoded string, instead.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCosmos
Params queries all parameters of the gov module.
Parameters
params_typestringrequiredpathparams_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetTxsEvent fetches txs by event.
Parameters
eventsArray<string>queryevents is the list of transaction event type. Deprecated post v0.47.x: use query instead, which should contain a valid events query.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
order_bystringORDER_BY_UNSPECIFIEDORDER_BY_ASCORDER_BY_DESCORDER_BY_UNSPECIFIEDquery- ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.
- ORDER_BY_ASC: ORDER_BY_ASC defines ascending order
- ORDER_BY_DESC: ORDER_BY_DESC defines descending order
pagestring<uint64>querypage is the page number to query, starts at 1. If not provided, will default to first page.
limitstring<uint64>querylimit 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.
querystringqueryquery defines the transaction event query that is proxied to Tendermint's TxSearch RPC method. The query must be valid.
Since cosmos-sdk 0.50
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGov
Proposals queries all proposals based on given status.
Parameters
proposal_statusstringPROPOSAL_STATUS_UNSPECIFIEDPROPOSAL_STATUS_DEPOSIT_PERIODPROPOSAL_STATUS_VOTING_PERIODPROPOSAL_STATUS_PASSEDPROPOSAL_STATUS_REJECTEDPROPOSAL_STATUS_FAILEDPROPOSAL_STATUS_UNSPECIFIEDqueryproposal_status defines the status of the proposals.
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
voterstringqueryvoter defines the voter address for the proposals.
depositorstringquerydepositor defines the deposit addresses from the proposals.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerProposal queries proposal details based on ProposalID.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDeposits queries all deposits of a single proposal.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDeposit queries single deposit information based on proposalID, depositor address.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
depositorstringrequiredpathdepositor defines the deposit addresses from the proposals.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTallyResult queries the tally of a proposal vote.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerVotes queries votes of a given proposal.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerVote queries voted information based on proposalID, voterAddr.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
voterstringrequiredpathvoter defines the voter address for the proposals.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConstitution queries the chain's constitution.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries all parameters of the gov module.
Parameters
params_typestringrequiredpathparams_type defines which parameters to query for, can be one of "voting", "tallying" or "deposit".
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerProposals queries all proposals based on given status.
Parameters
proposal_statusstringPROPOSAL_STATUS_UNSPECIFIEDPROPOSAL_STATUS_DEPOSIT_PERIODPROPOSAL_STATUS_VOTING_PERIODPROPOSAL_STATUS_PASSEDPROPOSAL_STATUS_REJECTEDPROPOSAL_STATUS_FAILEDPROPOSAL_STATUS_UNSPECIFIEDqueryproposal_status defines the status of the proposals.
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default proposal status.
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit period.
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting period.
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has passed.
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has been rejected.
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has failed.
voterstringqueryvoter defines the voter address for the proposals.
depositorstringquerydepositor defines the deposit addresses from the proposals.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerProposal queries proposal details based on ProposalID.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDeposits queries all deposits of a single proposal.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDeposit queries single deposit information based on proposalID, depositAddr.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
depositorstringrequiredpathdepositor defines the deposit addresses from the proposals.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTallyResult queries the tally of a proposal vote.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerVotes queries votes of a given proposal.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerVote queries voted information based on proposalID, voterAddr.
Parameters
proposal_idstring<uint64>requiredpathproposal_id defines the unique id of the proposal.
voterstringrequiredpathvoter defines the voter address for the proposals.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerMint
AnnualProvisions current minting annual provisions value.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerInflation returns the current minting inflation value.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams returns the total set of minting parameters.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSlashing
Params queries the parameters of slashing module
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSigningInfos queries signing info of all validators
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSigningInfo queries the signing info of given cons address
Parameters
cons_addressstringrequiredpathcons_address is the address to query signing info of
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerStaking
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.
Parameters
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRedelegations 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.
Parameters
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
src_validator_addrstringquerysrc_validator_addr defines the validator address to redelegate from.
dst_validator_addrstringquerydst_validator_addr defines the validator address to redelegate to.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegatorUnbondingDelegations 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.
Parameters
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegatorValidators 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.
Parameters
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegatorValidator queries validator info for given delegator validator pair.
Parameters
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerHistoricalInfo queries the historical info for given height.
Parameters
heightstring<int64>requiredpathheight defines at which height to query the historical info.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters queries the staking parameters.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPool queries the pool info.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidators 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.
Parameters
statusstringquerystatus enables to query for validators matching a given status.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidator queries validator info for given validator address.
Parameters
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorDelegations 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.
Parameters
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDelegation queries delegate info for given validator delegator pair.
Parameters
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUnbondingDelegation queries unbonding info for given validator delegator pair.
Parameters
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
delegator_addrstringrequiredpathdelegator_addr defines the delegator address to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValidatorUnbondingDelegations 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.
Parameters
validator_addrstringrequiredpathvalidator_addr defines the validator address to query for.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTx
TxDecode decodes the transaction.
Since: cosmos-sdk 0.47
Body
TxDecodeRequest is the request type for the Cosmos.TxDecode RPC method.
Since: cosmos-sdk 0.47
tx_bytesstring<byte>tx_bytes is the raw transaction.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTxDecodeAmino decodes an Amino transaction from encoded bytes to JSON.
Since: cosmos-sdk 0.47
Body
TxDecodeAminoRequest is the request type for the Cosmos.TxDecodeAmino RPC method.
Since: cosmos-sdk 0.47
amino_binarystring<byte>Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTxEncode encodes the transaction.
Since: cosmos-sdk 0.47
Body
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTxEncodeAmino encodes an Amino transaction from JSON to encoded bytes.
Since: cosmos-sdk 0.47
Body
TxEncodeAminoRequest is the request type for the Cosmos.TxEncodeAmino RPC method.
Since: cosmos-sdk 0.47
amino_jsonstringResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSimulate simulates executing a transaction for estimating gas usage.
Body
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBroadcastTx broadcast transaction.
Body
BroadcastTxRequest is the request type for the Cosmos.BroadcastTxRequest RPC method.
tx_bytesstring<byte>tx_bytes is the raw transaction.
modestringBROADCAST_MODE_UNSPECIFIEDBROADCAST_MODE_BLOCKBROADCAST_MODE_SYNCBROADCAST_MODE_ASYNCBROADCAST_MODE_UNSPECIFIEDBroadcastMode specifies the broadcast mode for the TxCosmos.Broadcast RPC method.
- BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
- BROADCAST_MODE_BLOCK: DEPRECATED: use BROADCAST_MODE_SYNC instead, BROADCAST_MODE_BLOCK is not supported by the SDK from v0.47.x onwards.
- BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only.
- BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetBlockWithTxs fetches a block with decoded txs.
Since: cosmos-sdk 0.45.2
Parameters
heightstring<int64>requiredpathheight is the height of the block to query.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGetTx fetches a tx by hash.
Parameters
hashstringrequiredpathhash is the tx hash to query, encoded as a hex string.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUpgrade
AppliedPlan queries a previously applied upgrade plan by its name.
Parameters
namestringrequiredpathname is the name of the applied plan to query for.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCurrentPlan queries the current upgrade plan.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerModuleVersions queries the list of module versions from state.
Since: cosmos-sdk 0.43
Parameters
module_namestringquerymodule_name is a field to query a specific module consensus version from state. Leaving this empty will fetch the full list of module versions from state.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUpgradedConsensusState 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)
Parameters
last_heightstring<int64>requiredpathlast height of the current chain must be sent in request as this is the height under which next consensus state is stored
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAuthz
Returns list of Authorization, granted to the grantee by the granter.
Parameters
granterstringquerygranteestringquerymsg_type_urlstringqueryOptional, msg_type_url, when set, will query only grants matching given msg type.
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGranteeGrants returns a list of GrantAuthorization by grantee.
Since: cosmos-sdk 0.46
Parameters
granteestringrequiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerGranterGrants returns list of GrantAuthorization, granted by granter.
Since: cosmos-sdk 0.46
Parameters
granterstringrequiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerFeegrant
Allowance returns granted allwance to the grantee by the granter.
Parameters
granterstringrequiredpathgranter is the address of the user granting an allowance of their funds.
granteestringrequiredpathgrantee is the address of the user being granted an allowance of another user's funds.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAllowances returns all the grants for the given grantee address.
Parameters
granteestringrequiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAllowancesByGranter returns all the grants given by an address
Since: cosmos-sdk 0.46
Parameters
granterstringrequiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCode
Codes gets the metadata for all stored wasm codes
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCode gets the binary code and metadata for a singe wasm code
Parameters
code_idstring<uint64>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerContractsByCode lists all smart contracts for a code id
Parameters
code_idstring<uint64>requiredpathpagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCodes
Params gets the module params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPinnedCodes gets the pinned code ids
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerContract
ContractInfo gets the contract meta data
Parameters
addressstringrequiredpathaddress is the address of the contract to query
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerContractHistory gets the contract code history
Parameters
addressstringrequiredpathaddress is the address of the contract to query
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRawContractState gets single key from the raw store data of a contract
Parameters
addressstringrequiredpathaddress is the address of the contract
query_datastring<byte>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerSmartContractState get smart query result from the contract
Parameters
addressstringrequiredpathaddress is the address of the contract
query_datastring<byte>requiredpathQueryData contains the query data passed to the contract
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAllContractState gets all raw store data for a single contract
Parameters
addressstringrequiredpathaddress is the address of the contract
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerContractsByCreator gets the contracts by creator
Parameters
creator_addressstringrequiredpathCreatorAddress is the address of contract creator
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerApps
EscrowAddress returns the escrow address for a particular port and channel id.
Parameters
channel_idstringrequiredpathunique channel identifier
port_idstringrequiredpathunique port identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomHash queries a denomination hash information.
Parameters
tracestringrequiredpathThe denomination trace ([port_id]/[channel_id])+/[denom]
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomTraces queries all denomination traces.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerDenomTrace queries a denomination trace information.
Parameters
hashstringrequiredpathhash (in hex format) or denom (full denom with ibc prefix) of the denomination trace information.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTotalEscrowForDenom returns the total amount of tokens in escrow based on the denom.
Parameters
denomstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams queries all parameters of the ibc-transfer module.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCore
Channels queries all the IBC channels of a chain.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerChannel queries an IBC Channel.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerChannelClientState queries for the client state for the channel associated with the provided channel identifiers.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
revision_numberstring<uint64>requiredpathrevision number of the consensus state
revision_heightstring<uint64>requiredpathrevision height of the consensus state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerNextSequenceReceive returns the next receive sequence for a given channel.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerNextSequenceSend returns the next send sequence for a given channel.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPacketAcknowledgements returns all the packet acknowledgements associated with a channel.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
packet_commitment_sequencesArray<string>querylist of packet sequences.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPacketAcknowledgement queries a stored packet acknowledgement hash.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPacketCommitments returns all the packet commitments hashes associated with a channel.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
packet_ack_sequencesArray<string>requiredpathlist of acknowledgement sequences
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
packet_commitment_sequencesArray<string>requiredpathlist of packet sequences
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPacketCommitment queries a stored packet commitment hash.
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPacketReceipt queries if a given packet sequence has been received on the queried chain
Parameters
channel_idstringrequiredpathchannel unique identifier
port_idstringrequiredpathport unique identifier
sequencestring<uint64>requiredpathpacket sequence
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnectionChannels queries all the channels associated with a connection end.
Parameters
connectionstringrequiredpathconnection unique identifier
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerClientStates queries all the IBC light clients of a chain.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerClientState queries an IBC light client.
Parameters
client_idstringrequiredpathclient state unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerStatus queries the status of an IBC client.
Parameters
client_idstringrequiredpathclient unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConsensusStates queries all the consensus state associated with a given client.
Parameters
client_idstringrequiredpathclient identifier
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConsensusStateHeights queries the height of every consensus states associated with a given client.
Parameters
client_idstringrequiredpathclient identifier
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConsensusState queries a consensus state associated with a client state at a given height.
Parameters
client_idstringrequiredpathclient identifier
revision_numberstring<uint64>requiredpathconsensus state revision number
revision_heightstring<uint64>requiredpathconsensus state revision height
latest_heightbooleanquerylatest_height overrrides the height field and queries the latest stored ConsensusState.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerClientParams queries all parameters of the ibc client submodule.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUpgradedClientState queries an Upgraded IBC light client.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerUpgradedConsensusState queries an Upgraded IBC consensus state.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerClientConnections queries the connection paths associated with a client state.
Parameters
client_idstringrequiredpathclient identifier associated with a connection
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnections queries all the IBC connections of a chain.
Parameters
pagination.keystring<byte>querykey 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.offsetstring<uint64>queryoffset 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.limitstring<uint64>querylimit 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_totalbooleanquerycount_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.reversebooleanqueryreverse is set to true if results are to be returned in the descending order.
Since: cosmos-sdk 0.43
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnection queries an IBC connection end.
Parameters
connection_idstringrequiredpathconnection unique identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnectionClientState queries the client state associated with the connection.
Parameters
connection_idstringrequiredpathconnection identifier
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnectionConsensusState queries the consensus state associated with the connection.
Parameters
connection_idstringrequiredpathconnection identifier
revision_numberstring<uint64>requiredpathrevision_heightstring<uint64>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConnectionParams queries all parameters of the ibc connection submodule.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerExchange
Parameters
market_idstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves mismatches between available vs. total balance
Parameters
dust_factorstring<int64>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves available and total balances with balance holds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a spot market's orderbook by marketID
Parameters
statusstringqueryStatus of the market, for convenience it is set to string - not enum.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a derivative market's corresponding address for fees that contribute to the market's insurance fund
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a list of derivative markets.
Parameters
statusstringqueryStatus of the market, for convenience it is set to string - not enum.
market_idsArray<string>queryFilter by market IDs.
with_mid_price_and_tobbooleanqueryFlag to return the markets mid price and top of the book buy and sell orders.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a derivative market by ticker
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a derivative market's mid-price
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a derivative market's orderbook by marketID
Parameters
market_idstringrequiredpathMarket ID for the market
limitstring<uint64>querylimit_cumulative_notionalstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's derivative conditional orders
Parameters
market_idstringrequiredpathsubaccount_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves all account address derivative orders
Parameters
market_idstringrequiredpathMarket ID for the market
account_addressstringrequiredpathAccount address of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's derivative orders
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's derivative orders
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
order_hashesArray<string>querythe order hashes.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's transient derivative orders
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves subaccount's position in market
Parameters
subaccount_idstringrequiredpathmarket_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the aggregate volume for the specified market
Parameters
market_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the aggregate market volumes for specified markets
Parameters
market_idsArray<string>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the aggregate volumes for the specified account or subaccount
Parameters
accountstringrequiredpathcan either be an address or a subaccount
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the aggregate volumes for specified accounts
Parameters
accountsArray<string>querymarket_idsArray<string>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the denom decimals for a denom.
Parameters
denomstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the denom decimals for multiple denoms. Returns all denom decimals if unspecified.
Parameters
denomsArray<string>querydenoms can be empty to query all denom decimals.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves all of the balances of all users on the exchange.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a Subaccount's Deposits
Parameters
subaccount_idstringquerydenomstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a Subaccount's Deposits
Parameters
subaccount_idstringquerysubaccount.traderstringquerysubaccount.subaccount_nonceinteger<int64>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a subaccount's trade nonce
Parameters
subaccount_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves exchange params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves expiry market info
Parameters
market_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the account's fee discount info
Parameters
accountstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the fee discount schedule
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves fee discount tier stats
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves historical trade records for a given market ID
Parameters
market_idstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves if the account is opted out of rewards
Parameters
accountstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerMarketVolatility computes the volatility for spot and derivative markets trading history.
Parameters
market_idstringrequiredpathtrade_history_options.trade_grouping_secstring<uint64>queryTradeGroupingSec of 0 means use the chain's default grouping.
trade_history_options.max_agestring<uint64>queryMaxAge restricts the trade records oldest age in seconds from the current block time to consider. A value of 0 means use all the records present on the chain.
trade_history_options.include_raw_historybooleanqueryIf IncludeRawHistory is true, the raw underlying data used for the computation is included in the response.
trade_history_options.include_metadatabooleanqueryIf IncludeMetadata is true, metadata on the computation is included in the response.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves market making pool info
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire exchange module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves all accounts opted out of rewards
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves subaccount's order metadata
Parameters
subaccount_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves subaccount's orders
Parameters
subaccount_idstringrequiredpathmarket_idstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the pending account and total trade rewards points
Parameters
accountsArray<string>querypending_pool_timestampstring<int64>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves perpetual market funding
Parameters
market_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves perpetual market info
Parameters
market_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire exchange module's positions
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves subaccount's positions
Parameters
subaccount_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves subaccount's position in market
Parameters
subaccount_idstringrequiredpathmarket_idstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a spot market with extra information.
Parameters
market_idstringrequiredpathMarket ID for the market
with_mid_price_and_tobbooleanqueryFlag to return the markets mid price and top of the book buy and sell orders.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a list of spot markets with extra information.
Parameters
statusstringqueryStatus of the market, for convenience it is set to string - not enum.
market_idsArray<string>queryFilter by market IDs.
with_mid_price_and_tobbooleanqueryFlag to return the markets mid price and top of the book buy and sell orders.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a list of spot markets.
Parameters
statusstringqueryStatus of the market, for convenience it is set to string - not enum.
market_idsArray<string>queryFilter by market IDs.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a spot market by ticker
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a spot market's mid-price
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a spot market's orderbook by marketID
Parameters
market_idstringrequiredpathMarket ID for the market
limitstring<uint64>queryorder_sidestringSide_UnspecifiedBuySellSide_Unspecifiedquery- Side_Unspecified: will return both
limit_cumulative_notionalstringquerylimit_cumulative_quantitystringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves all account address spot orders
Parameters
market_idstringrequiredpathMarket ID for the market
account_addressstringrequiredpathAccount address of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's spot orders
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves spot orders corresponding to specified order hashes for a given subaccountID and marketID
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
order_hashesArray<string>querythe order hashes.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves a trader's transient spot orders
Parameters
market_idstringrequiredpathMarket ID for the market
subaccount_idstringrequiredpathSubaccountID of the trader
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the trade reward campaign
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the account and total trade rewards points
Parameters
accountsArray<string>querypending_pool_timestampstring<int64>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerQueryMarketIDFromVault returns the market ID for a given vault subaccount ID
Parameters
vault_addressstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerWasmx
Retrieves the entire wasmx module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves wasmx params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves contract registration info
Parameters
contract_addressstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerAuction
Retrieves current auction basket with current highest bid and bidder
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire auction module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves auction params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerOracle
Retrieves the state for all band ibc price feeds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the state for all band price feeds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the band relayers
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the state for all coinbase price feeds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves historical price records for a given OracleType and Symbol
Parameters
oraclestringUnspecifiedBandPriceFeedCoinbaseChainlinkRazorDiaAPI3UmaPythBandIBCProviderUnspecifiedquerysymbol_idstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire oracle module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves oracle params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
oracle_typestringUnspecifiedBandPriceFeedCoinbaseChainlinkRazorDiaAPI3UmaPythBandIBCProviderUnspecifiedquerybasestringqueryquotestringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the state for all price feeds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the state for all provider price feeds
Parameters
providerstringrequiredpathsymbolstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
providerstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
price_idstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the state for all pyth price feeds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves mixed volatility value for the specified pair of base/quote
Parameters
base_info.symbolstringquerybase_info.oracle_typestringUnspecifiedBandPriceFeedCoinbaseChainlinkRazorDiaAPI3UmaPythBandIBCProviderUnspecifiedquerybase_info.scale_factorinteger<int64>queryquote_info.symbolstringqueryquote_info.oracle_typestringUnspecifiedBandPriceFeedCoinbaseChainlinkRazorDiaAPI3UmaPythBandIBCProviderUnspecifiedqueryquote_info.scale_factorinteger<int64>queryoracle_history_options.max_agestring<uint64>queryMaxAge restricts the oracle price records oldest age in seconds from the current block time to consider. A value of 0 means use all the records present on the chain.
oracle_history_options.include_raw_historybooleanqueryIf IncludeRawHistory is true, the raw underlying data used for the computation is included in the response.
oracle_history_options.include_metadatabooleanqueryIf IncludeMetadata is true, metadata on the computation is included in the response.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerclaim
Parameters
addressstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerInsurance
Retrives the value of insurance fund share token at current price (not pending redemption)
Parameters
marketIdstringqueryaddressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves individual insurance fund information from market id
Parameters
market_idstringrequiredpathMarket ID for the market
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves all insurance funds
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire insurance module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves insurance params
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves pending redemptions' share token at current price
Parameters
marketIdstringqueryaddressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerTokenfactory
DenomsFromCreator defines a gRPC query method for fetching all denominations created by a specific admin/creator.
Parameters
creatorstringrequiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerRetrieves the entire auction module's state
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParams defines a gRPC query method that returns the tokenfactory module's parameters.
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerBatch
Parameters
noncestring<uint64>querycontract_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
noncestring<uint64>querycontract_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerConfirms
Parameters
noncestring<uint64>requiredpathResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerCosmos_originated
Parameters
denomstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
erc20stringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerMissing_nonces
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerPending_send_to_eth
batch
Parameters
sender_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerQuery_delegate_keys_by_eth
Parameters
eth_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerQuery_delegate_keys_by_orchestrator
Parameters
orchestrator_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerQuery_delegate_keys_by_validator
Parameters
validator_addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerValset
Parameters
noncestring<uint64>queryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
noncestring<uint64>queryaddressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headervalset
Response
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerParameters
addressstringqueryResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerResponse
A successful response.
An unexpected error response.
Authorization
api-keyAuthapiKey in headerEVM
eth_accounts
Ethereum method - eth_accounts
Returns an array of addresses controlled by the client.
Body
jsonrpcstringrequiredJSON-RPC version identifier
methodstringrequiredName of the JSON-RPC method
paramsarrayrequiredNo parameters are required for this method. This must be an empty array.
idintegerrequiredUnique identifier for the JSON-RPC request
Response
A list of Ethereum addresses
Authorization
api-keyAuthapiKey in headereth_blockNumber
Ethereum method - eth_blockNumber
Returns the number of the latest block on the chain in hexadecimal format.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version
methodstringrequiredName of the method being called
paramsarrayrequiredThis method does not take parameters; always send an empty array.
idintegerrequiredA unique ID for the request
Response
The latest block number
Authorization
api-keyAuthapiKey in headereth_call
Ethereum method - eth_call
Executes a call to a contract or address and returns the result without broadcasting a transaction.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object | string>requiredThe first object specifies the call transaction object. The second (optional) parameter specifies the block context.
idintegerrequiredResponse
Result of the call
Authorization
api-keyAuthapiKey in headereth_chainId
Ethereum method - eth_chainId
Returns the hexadecimal string of the current chain ID.
Body
jsonrpcstringrequiredJSON-RPC protocol version
methodstringrequiredName of the method to call
paramsarrayrequiredThis method does not require parameters. Use an empty array.
idintegerrequiredUnique identifier for the request
Response
Chain ID response
Authorization
api-keyAuthapiKey in headereth_coinbase
eth_coinbase
Returns the Ethereum coinbase address (i.e., the address that receives mining rewards).
Body
jsonrpcstringrequiredmethodstringeth_coinbaserequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC Response with the coinbase address
Authorization
api-keyAuthapiKey in headereth_estimateGas
Estimate Gas for Transaction
Simulates a transaction and returns an estimate of how much gas would be used.
Body
jsonrpcstringrequiredJSON-RPC protocol version
methodstringrequiredThe method name
paramsArray<object | string>requiredThe transaction call object and an optional block tag.
idintegerrequiredRequest identifier
Response
Estimated gas amount
Authorization
api-keyAuthapiKey in headereth_feeHistory
eth_feeHistory
Returns fee market information for a range of blocks. This is typically used by wallets and other tools to estimate appropriate gas prices.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string | integer | Array<number>>requiredParameters:
blockCount— number of blocks in the requested range.newestBlock— highest block number in the requested range (can be "latest").rewardPercentiles— list of percentile values to sample priority fees from each block (optional).
idintegerrequiredResponse
JSON-RPC Response with fee history data
Authorization
api-keyAuthapiKey in headereth_gasPrice
Get Suggested Gas Price
Returns the current gas price in wei as a hexadecimal string. This value is a node estimate based on recent blocks and mempool activity.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsarrayrequiredThis method takes an empty array.
idintegerrequiredRequest identifier
Response
Suggested gas price in wei
Authorization
api-keyAuthapiKey in headereth_getBalance
Get ETH Balance of an Address
Retrieves the balance (in wei) of a given Ethereum address. You can specify the block parameter to get the balance at a specific block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string | string>requiredArray with 2 parameters:
- Address (20-byte hex string with '0x' prefix)
- Block tag (e.g., 'latest', 'earliest', 'pending', or block number in hex)
idintegerrequiredRequest ID
Response
Balance (in wei) as hex string
Authorization
api-keyAuthapiKey in headereth_getBlockByHash
Get Block by Hash
Returns the block information for the specified block hash. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string | boolean>requiredArray with 2 parameters:
- Block hash (32-byte hex string with '0x' prefix)
- Boolean to specify if full transaction objects are returned (
true) or only transaction hashes (false)
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockByNumber
Get Block by Number
Returns the block information for the specified block number. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string | boolean>requiredArray with 2 parameters:
- Block number (hex string, e.g., "0x1b4") or special tags ("latest", "earliest", "pending")
- Boolean to specify if full transaction objects are returned (
true) or only transaction hashes (false)
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockReceipts
Get All Transaction Receipts for a Block
Returns an array of transaction receipts for every transaction in the block specified by block number or block hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredOne parameter:
- Block identifier, which can be either:
- block number as hex string (e.g. "0x10d4f")
- or block hash as hex string (0x-prefixed)
idintegerrequiredRequest identifier
Response
Array of transaction receipts in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByHash
Get Transaction Count by Block Hash
Returns the number of transactions contained in the block with the given hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block hash as a hex string (32 bytes with 0x prefix)
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByNumber
Get Transaction Count by Block Number
Returns the number of transactions contained in the block with the given block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block number as a hex string (e.g. "0x10d4f" for block 69007) or
- predefined block tags such as "latest", "earliest", or "pending"
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getCode
Get Contract Bytecode at Address
Returns the contract code stored at a given address. If the address is an externally owned account (EOA), it returns "0x".
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with two elements:
- The address to get the code for (hex string, 0x-prefixed).
- The block number or block tag (e.g., "latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Contract bytecode in hex format
Authorization
api-keyAuthapiKey in headereth_getFilterChanges
Get Filter Changes
Returns an array of logs that occurred since the last poll for the specified filter ID. The filter must have been previously created with eth_newFilter or eth_newBlockFilter or eth_newPendingTransactionFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with a single element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects or transaction hashes depending on filter type
Authorization
api-keyAuthapiKey in headereth_getFilterLogs
Get Filter Logs
Returns all logs matching a filter with the specified filter ID. The filter must have been previously created with eth_newFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with one element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getLogs
Get Logs
Returns an array of logs that match the filter criteria specified in the params. The filter object supports filtering by block range, addresses, and topics.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<object>requiredParameters array with one element: the filter object.
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getStorageAt
Get Storage At
Returns the value stored at position in the storage of the contract at address at the given blockNumber.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array:
- address: string - Contract address to query storage from.
- position: string - Storage slot position (hex string).
- block number: string - Block number or keywords ("latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Storage slot value at the specified position
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockHashAndIndex
Get Transaction by Block Hash and Index
Retrieves the transaction from a block using the block's hash and the transaction's index position within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- blockHash (string): The 32-byte hash of the block.
- transactionIndex (string): The transaction index (hex).
idintegerrequiredResponse
A transaction object or null if no transaction was found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockNumberAndIndex
Get Transaction by Block Number and Index
Returns the information about a transaction using the block number and the transaction index within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- Block number in hex format (e.g., "0x5daf3b")
- Transaction index in the block (e.g., "0x0")
idintegerrequiredResponse
A transaction object, or null if not found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByHash
Get transaction by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredArray containing a single transaction hash
idintegerrequiredResponse
Transaction object or null
Authorization
api-keyAuthapiKey in headereth_getTransactionCount
Get transaction count (nonce) for address
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required- address: The address to check for transaction count.
- block: The block parameter (e.g., "latest", "earliest", "pending").
idintegerrequiredResponse
Hex encoded nonce (transaction count)
Authorization
api-keyAuthapiKey in headereth_getTransactionReceipt
Get transaction receipt by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Transaction receipt if mined, otherwise null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockHashAndIndex
Get uncle block by block hash and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockHash: 32-byte block hashindex: the uncle index as hex (e.g., "0x0" for the first uncle)
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockNumberAndIndex
Get uncle block by block number and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockNumber: The block number as hex string (e.g., "0x10fb78"), or "latest", "earliest", "pending".index: The uncle index as hex (e.g., "0x0" for the first uncle).
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockHash
Get the number of uncle blocks by block hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block hash.
idintegerrequiredResponse
Number of uncles in the block
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockNumber
Get the number of uncle blocks by block number
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block number as a hex string.
idintegerrequiredResponse
Number of uncle blocks in the block
Authorization
api-keyAuthapiKey in headereth_hashrate
eth_hashrate
Returns the current mining hashrate reported by the client.
Body
jsonrpcstringrequiredmethodstringeth_hashraterequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current mining hashrate
Authorization
api-keyAuthapiKey in headereth_maxPriorityFeePerGas
Get recommended maxPriorityFeePerGas value
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredNo parameters are required.
idintegerrequiredResponse
Returns the suggested maxPriorityFeePerGas value
Authorization
api-keyAuthapiKey in headereth_mining
eth_mining
Checks whether the Ethereum client is actively mining.
Body
jsonrpcstringrequiredmethodstringeth_miningrequiredparamsarrayrequiredThis method does not accept parameters.
idintegerrequiredResponse
JSON-RPC Response indicating mining status
Authorization
api-keyAuthapiKey in headereth_newBlockFilter
Create a new block filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<any>requiredThis method does not require any parameters.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newFilter
Create a new log filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredArray with one object describing the filter options.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newPendingTransactionFilter
Create a filter for pending transactions
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<any>requiredNo parameters required for this method
idintegerrequiredRequest identifier
Response
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_sendRawTransaction
Send a raw signed transaction
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
paramsArray<string>requiredArray containing a single signed transaction data (hex string)
idintegerrequiredRequest ID
Response
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sendTransaction
Send a transaction using node-managed account
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredTransaction object
idintegerrequiredResponse
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sign
Sign arbitrary data using eth_sign
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required[address, data]
- address: The account that will sign the data
- data: The data to be signed (must be a hex string)
idintegerrequiredResponse
Returns the signature of the message
Authorization
api-keyAuthapiKey in headereth_signTransaction
eth_signTransaction
Signs a transaction locally with the private key of the specified account.
Body
jsonrpcstringrequiredmethodstringeth_signTransactionrequiredparamsArray<object>requiredArray with a single object representing the transaction to sign.
idintegerrequiredResponse
JSON-RPC response with the signed transaction data
Authorization
api-keyAuthapiKey in headereth_syncing
Check if node is syncing
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredMust be an empty array.
idintegerrequiredResponse
Returns sync status object or false
Authorization
api-keyAuthapiKey in headereth_uninstallFilter
Uninstall an existing filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Success or failure of the uninstall operation
Authorization
api-keyAuthapiKey in headernet_listening
net_listening
Checks if the client is listening for network connections.
Body
jsonrpcstringrequiredmethodstringnet_listeningrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with listening status
Authorization
api-keyAuthapiKey in headernet_peerCount
net_peerCount
Returns the number of peers currently connected to the client.
Body
jsonrpcstringrequiredmethodstringnet_peerCountrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the number of connected peers
Authorization
api-keyAuthapiKey in headernet_version
net_version
Returns the current network ID of the Ethereum client.
Body
jsonrpcstringrequiredmethodstringnet_versionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current network ID
Authorization
api-keyAuthapiKey in headerweb3_clientVersion
web3_clientVersion
Returns the current Ethereum client version.
Body
jsonrpcstringrequiredmethodstringweb3_clientVersionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the client version string
Authorization
api-keyAuthapiKey in headerweb3_sha3
web3_sha3
Computes the Keccak-256 (SHA-3) hash of the given hex-encoded data.
Body
jsonrpcstringrequiredmethodstringweb3_sha3requiredparamsArray<string>requiredArray containing a single hex-encoded data string to hash.
idintegerrequiredResponse
JSON-RPC response with the Keccak-256 hash of the input data
Authorization
api-keyAuthapiKey in headerIndexer
Aggregator
Aggregator implements coingecko/cmc integration API spec
derivativeContracts Aggregator
This endpoint provides a summary of all derivative contracts traded on the exchange
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerderivativeOrderbook Aggregator
This endpoint provide order book information with at least depth = 100 (50 each side) returned for a given market pair/ticker
Parameters
ticker_idstringrequiredquerySpecify unique ticker to search.
depthinteger<int64>queryOrders depth quantity: [0, 100, 200, 500...]. 0 returns full depth. Depth = 100 means 50 for each bid/ask side.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotHistoricalTrades Aggregator
This endpoint provide data on historical completed trades for a given market pair.
Parameters
ticker_idstringrequiredquerySpecify unique ticker to search.
typestringrequiredqueryTo indicate nature of trade - buy/sell - for a given market pair.
limitinteger<int64>queryNumber of historical trades to retrieve from time of query. [0, 200, 500...]. 0 returns full history.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotOrderbook Aggregator
This endpoint provide order book information with at least depth = 100 (50 each side) returned for a given market pair/ticker
Parameters
ticker_idstringrequiredquerySpecify unique ticker to search.
depthinteger<int64>queryOrders depth quantity: [0, 100, 200, 500...]. 0 returns full depth. Depth = 100 means 50 for each bid/ask side.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotPairs Aggregator
Provides a summary of cryptoasset trading pairs available on injective exchange.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotTickers Aggregator
This endpoint provides 24-hour pricing and volume information on each market pair available on injective exchange.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerSwagger
The API Swagger specification
Download ./swagger/index.html
Provide Swagger-UI html document
Response
File downloaded
Authorization
api-keyAuthapiKey in headerDownload ./swagger/
Serve static content.
Parameters
pathstringrequiredpathRelative file path
Response
File not found
File not found
Authorization
api-keyAuthapiKey in headerChronosAPI
ChronosAPI implements historical data API for e.g. TradingView.
derivativeMarketConfig ChronosAPI
Data feed configuration data for TradingView.
Response
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerderivativeMarketHistory ChronosAPI
Request for history bars of derivativeMarket for TradingView.
Parameters
symbolstringquerySpecify unique ticker to search.
marketIdstringqueryAs an alternative is possible to provide a marketId
resolutionstringrequiredquerySymbol resolution. Possible resolutions are daily (D or 1D, 2D ... ), weekly (1W, 2W ...), monthly (1M, 2M...) and an intra-day resolution – minutes(1, 2 ...).
frominteger<int64>queryUnix timestamp (UTC) of the leftmost required bar, including from
tointeger<int64>requiredqueryUnix timestamp (UTC) of the rightmost required bar, including to. It can be in the future. In this case, the rightmost required bar is the latest available bar.
countbackinteger<int64>queryNumber of bars (higher priority than from) starting with to. If countback is set, from should be ignored.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerderivativeMarketSummary ChronosAPI
Gets derivative market summary for the latest interval (hour, day, month)
Parameters
marketIdstringrequiredqueryMarket ID of the derivative market
indexPricebooleanqueryRequest the summary of index price feed
resolutionstringhour60mday24hweek7daysmonth30daysrequiredquerySpecify the resolution
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerallDerivativeMarketSummary ChronosAPI
Gets batch summary for all active markets, for the latest interval (hour, day, month)
Parameters
indexPricebooleanqueryRequest the summary of index price feed
resolutionstringhour60mday24hweek7daysmonth30daysrequiredquerySpecify the resolution
Response
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerderivativeMarketSymbolInfo ChronosAPI
Get a list of all derivativeMarket instruments for TradingView.
Parameters
groupstringqueryID of a symbol group. It is only required if you use groups of symbols to restrict access to instrument's data.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerderivativeMarketSymbolSearch ChronosAPI
Get info about specific derivative market symbol by ticker.
Parameters
symbolstringrequiredquerySpecify unique ticker to search.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerexchangeInfo ChronosAPI
returns exchange infos for all markets
Response
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerLeaderboard ChronosAPI
Request sorted account list by balance on current relayer
Parameters
resolutionstring1d7d28dcustom1dqueryLeaderboard time range. Default is 1d
limitinteger[1, 100]100queryNumber of leaderboard entries to retrieve. Default is 100
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerLeaderboardRank ChronosAPI
Request account rank in leaderboard
Parameters
resolutionstring1d7d28dcustom1dqueryLeaderboard time range. Default is 1d
subaccountIDstringrequiredquerySubaccount ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerMarketSnapshot ChronosAPI
Request for cached markets history bars. Max age is 1h.
Parameters
marketIDsArray<string>requiredquerySpecify multiple marketIDs to search.
resolutionstring1515306012024072014401querySymbols resolution(minutes). Default is 1
countbackinteger[1, 1440]1440queryNumber of bars returned, starting from the recent ones.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotMarketConfig ChronosAPI
Data feed configuration data for TradingView.
Response
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotMarketHistory ChronosAPI
Request for history bars of spotMarket for TradingView.
Parameters
symbolstringquerySpecify unique ticker to search
marketIdstringqueryAs an alternative is possible to provide a marketId
resolutionstringrequiredquerySymbol resolution. Possible resolutions are daily (D or 1D, 2D ... ), weekly (1W, 2W ...), monthly (1M, 2M...) and an intra-day resolution – minutes(1, 2 ...).
frominteger<int64>queryUnix timestamp (UTC) of the leftmost required bar, including from
tointeger<int64>requiredqueryUnix timestamp (UTC) of the rightmost required bar, including to. It can be in the future. In this case, the rightmost required bar is the latest available bar.
countbackinteger<int64>queryNumber of bars (higher priority than from) starting with to. If countback is set, from should be ignored.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotMarketSummary ChronosAPI
Gets spot market summary for the latest interval (hour, day, month)
Parameters
marketIdstringrequiredqueryMarket ID of the spot market
resolutionstringhour60mday24hweek7daysmonth30daysrequiredquerySpecify the resolution
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerallSpotMarketSummary ChronosAPI
Gets batch summary for all active markets, for the latest interval (hour, day, month)
Parameters
resolutionstringhour60mday24hweek7daysmonth30daysrequiredquerySpecify the resolution
Response
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotMarketSymbolInfo ChronosAPI
Get a list of all spotMarket instruments for TradingView.
Parameters
groupstringqueryID of a symbol group. It is only required if you use groups of symbols to restrict access to instrument's data.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerspotMarketSymbolSearch ChronosAPI
Get info about specific spot market symbol by ticker.
Parameters
symbolstringrequiredquerySpecify unique ticker to search.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveAuctionRPC
InjectiveAuctionRPC defines gRPC API of the Auction API.
auctions InjectiveAuctionRPC
Provide the historical auctions info
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerauctionEndpoint InjectiveAuctionRPC
Provide historical auction info for a given auction
Parameters
roundinteger<int64>requiredpathThe auction round number. -1 for latest.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerEventProviderAPI
EventProviderAPI provides processed block events for different backends.
GetABCIBlockEvents EventProviderAPI
Get raw block events for selected height
Body
eventTypesArray<string>Array of event types
heightinteger<int64>requiredResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetBlockEvents EventProviderAPI
Get processed block events for selected backend
Parameters
backendstringexchangeexplorerchronoscampaignsexchangerequiredpathSelect backend processor
heightinteger<int64>requiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetCustomEvents EventProviderAPI
Get custom processed block events for selected backend
Parameters
eventsstringrequiredquerySpecify custom events to get
backendstringexchangeexplorerchronosexchangerequiredpathSelect backend processor
heightinteger<int64>requiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetLatestHeight EventProviderAPI
Get latest block from event provider
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveExchangeRPC
InjectiveExchangeRPC defines gRPC API of an Injective Exchange service.
broadcastCosmosTx InjectiveExchangeRPC
BroadcastCosmosTx broadcasts a signed Web3 transaction
Body
pubKeyCosmosPubKeysenderAddressstringsender address
signaturestringHex-encoded ethsecp256k1 sender signature bytes
txstring<binary>proto encoded tx
Response
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerbroadcastTx InjectiveExchangeRPC
BroadcastTx broadcasts a signed Web3 transaction
Body
chainIDintegerSpecify Web3 chainID (from prepateTx) for the target Tx
feePayerstringFee payer address provided by service
feePayerSigstringHex-encoded ethsecp256k1 signature bytes from fee payer
modestringsyncasyncblocksyncBroadcast mode
msgsArray<string>List of Cosmos proto3-encoded Msgs from tx
pubKeyCosmosPubKeysignaturestringHex-encoded ethsecp256k1 signature bytes
txstring<binary>Amino-encoded Tx JSON data (except Msgs)
Response
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headergetFeePayer InjectiveExchangeRPC
Return fee payer information's
Response
OK response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headergetTx InjectiveExchangeRPC
GetTx gets transaction details by hash.
Parameters
hashstringrequiredpathTransaction hash in hex without 0x prefix (Cosmos-like).
Response
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerprepareCosmosTx InjectiveExchangeRPC
PrepareCosmosTx generates a Web3-signable body for a Cosmos transaction
Body
chainIDintegerSpecify chainID for the target tx
feeCosmosTxFeememostringTextual memo information to attach with tx
msgsArray<string>List of Cosmos proto3-encoded Msgs to include in a single tx
senderAddressstringsender address provided
timeoutHeightintegerBlock height until which the transaction is valid.
Response
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerprepareTx InjectiveExchangeRPC
PrepareTx generates a Web3-signable body for a Cosmos transaction
Body
chainIDintegerSpecify chainID for the target tx
feeCosmosTxFeememostringTextual memo information to attach with tx
msgsArray<string>List of Cosmos proto3-encoded Msgs to include in a single tx
sequenceintegerAccount sequence number (nonce) of signer
signerAddressstringSpecify Ethereum address of a signer
timeoutHeightintegerBlock height until which the transaction is valid.
Response
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveAccountsRPC
InjectiveAccountsRPC defines API of Exchange Accounts provider.
orderStates InjectiveAccountsRPC
List order states by order hashes
Parameters
spotOrderHashesArray<string>queryderivativeOrderHashesArray<string>queryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerportfolio InjectiveAccountsRPC
Provide the account's portfolio value in USD.
Parameters
accountAddressstringrequiredpathAccount address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerrewards InjectiveAccountsRPC
Provide historical trading rewards
Parameters
epochinteger<int64>queryThe distribution epoch sequence number. -1 for latest.
accountAddressstringqueryAccount address for the rewards distribution
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headersubaccountBalanceEndpoint InjectiveAccountsRPC
Gets a balance for specific coin denom
Parameters
subaccountIdstringrequiredpathSubaccountId of the trader we want to get the trades from
denomstringrequiredpathSpecify denom to get balance
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headersubaccountBalancesList InjectiveAccountsRPC
List subaccount balances for the provided denoms.
Parameters
denomsArray<string>queryFilter balances by denoms. If not set, the balances of all the denoms for the subaccount are provided.
subaccountIdstringrequiredpathSubaccountId of the trader we want to get the trades from
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headersubaccountHistory InjectiveAccountsRPC
Get subaccount's deposits and withdrawals history
Parameters
denomstringqueryFilter history by denom
transferTypesArray<string>internalexternalwithdrawdepositqueryFilter history by transfer type
skipinteger0querySkip will skip the first n item from the result
limitinteger<= 100100queryLimit is used to specify the maximum number of items to be returned
endTimeinteger<int64>queryUpper bound of account transfer history's executedAt
subaccountIdstringrequiredpathSubaccountId of the trader we want to get the history from
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headersubaccountOrderSummary InjectiveAccountsRPC
Get subaccount's orders summary
Parameters
marketIdstringqueryMarketId is limiting order summary to specific market only
orderDirectionstringbuysellqueryFilter by direction of the orders
subaccountIdstringrequiredpathSubaccountId of the trader we want to get the summary from
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headersubaccountsList InjectiveAccountsRPC
List all subaccounts IDs of an account address
Parameters
accountAddressstringrequiredpathAccount address, the subaccounts owner
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveCampaignRPC
InjectiveCampaignRPC defined a gRPC service for Injective Campaigns.
campaigns InjectiveCampaignRPC
List current round active campaigns
Parameters
accountAddressstringqueryAddress of login account, if not specified it will return no user rewards
roundIdinteger<int64>queryRound ID, if not specified, it will return latest roundId
toRoundIdinteger<int32>queryThis will return campaign x where x.roundId <= toRoundId. Useful for listing multiple rounds
contractAddressstringqueryContract address that manages the round and reward
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerranking InjectiveCampaignRPC
Lists all participants in campaign
Parameters
marketIdstringqueryMarketId of the campaign
accountAddressstringqueryAccount address
limitinteger<int64>queryskipintegerquerycontractAddressstringqueryContract address that manages the round and reward
campaignIdstringrequiredpathCampaign ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerlistGuilds InjectiveCampaignRPC
List guilds by campaign
Parameters
limitinteger[1, 100]100queryLimit number of returned guilds
skipinteger<int64>0querySkip some first guilds in the list for next page
sortBystringvolumetvlquerySort by some metrics
campaignContractstringrequiredpathCampaign contract address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerlistGuildMembers InjectiveCampaignRPC
List guild members of given campaign and guildId
Parameters
limitinteger[1, 100]100queryLimit number of returned guild members
skipinteger<int64>0querySkip some first guild members in the list for next page
includeGuildInfobooleanfalsequerywhether to include guild summary info, it's better to use this in terms of latency, instead of sending 2 requests we just need once
sortBystringvolumetvlquerySort by some metrics
campaignContractstringrequiredpathCampaign contract address
guildIdstringrequiredpathID of guild, inside campaign
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headergetGuildMember InjectiveCampaignRPC
Get single member guild info
Parameters
campaignContractstringrequiredpathCampaign contract address
addressstringrequiredpathUser address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveDerivativeExchangeRPC
InjectiveDerivativeExchangeRPC defines gRPC API of Derivative Markets provider.
binaryOptionsMarkets InjectiveDerivativeExchangeRPC
BinaryOptionsMarkets gets a list of Binary Options Markets
Parameters
marketStatusstringactivepausedsuspendeddemolishedexpiredactivequeryFilter by market status
quoteDenomstringqueryFilter by the Coin denomination of the quote currency
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerbinaryOptionsMarket InjectiveDerivativeExchangeRPC
BinaryOptionMarket gets details of a single binary options market
Parameters
marketIdstringrequiredpathMarketId of the market we want to fetch
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerfundingPayments InjectiveDerivativeExchangeRPC
FundingPayments gets the funding payments for a trader.
Parameters
subaccountIdstringquerySubaccountId of the trader we want to get the positions from
skipintegerquerySkip will skip the first n item from the result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
marketIdstringqueryMarketIds of the funding payment we want to fetch. Using this for only one market id. This field is prioritized
marketIdsArray<string>queryFilter by market ids. Using this field for fetching funding payments from multiple market ids
endTimeinteger<int64>queryUpper bound of funding payment updatedAt
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerfundingRates InjectiveDerivativeExchangeRPC
FundingRates gets the historical funding rates for a market.
Parameters
skipinteger[0, 10000]0querySkip will skip the first n item from the result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
marketIdstringqueryMarketId of the position we want to fetch
endTimeinteger<int64>queryUpper bound of funding timestamp
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerliquidablePositions InjectiveDerivativeExchangeRPC
LiquidablePositions gets all the liquidable positions.
Parameters
marketIdstringqueryMarket ID to filter orders for specific market
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headermarkets InjectiveDerivativeExchangeRPC
Markets gets a list of Derivative Markets
Parameters
marketStatusstringactivepausedsuspendeddemolishedexpiredactivequeryFilter by market status
quoteDenomstringqueryFilter by the Coin denomination of the quote currency
marketStatusesArray<string>activepausedsuspendeddemolishedexpiredqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headermarket InjectiveDerivativeExchangeRPC
Market gets details of a single derivative market
Parameters
marketIdstringrequiredpathMarketId of the market we want to fetch
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorders InjectiveDerivativeExchangeRPC
DerivativeLimitOrders gets the limit orders of a derivative Market.
Parameters
marketIdstringqueryMarketId of market we want to fetch orders from. Using this field for one single marketId
marketIdsArray<string>queryMarketIds of the markets of which we want to get order from, use this field for fetching orders from multiple markets
orderSidestringbuysellqueryLook for specific order side
subaccountIdstringqueryLook for specific subaccountId of an order
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
isConditionalstringtruefalsequeryOnly search for conditional/non-conditional orders
orderTypestringbuysellstop_buystop_selltake_buytake_sellbuy_posell_poquerySearch for specific order type
includeInactivebooleanfalsequeryShould include inactive orders
subaccountTotalOrdersbooleanfalsequeryChoose to return subaccount total orders
tradeIdstringqueryTradeId of the order we want to fetch
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerordersHistory InjectiveDerivativeExchangeRPC
Lists history orders posted from a subaccount
Parameters
subaccountIdstringquerysubaccount ID to filter orders for specific subaccount
marketIdsArray<string>querymarketIdstringqueryMarket ID to filter orders for specific market
activeMarketsOnlybooleanfalsequeryReturn only orders for active markets
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned
orderTypesArray<string>buysellstop_buystop_selltake_buytake_sellbuy_posell_poqueryfilter by order types
directionstringqueryorder side filter
startTimeinteger<int64>querySearch for orders which createdAt >= startTime, time in millisecond
endTimeinteger<int64>querySearch for orders which createdAt <= endTime, time in millisecond
isConditionalstringtruefalsequeryOnly search for conditional/non-conditional orders
orderTypestringbuysellstop_buystop_selltake_buytake_sellbuy_posell_poqueryfilter by order type
statestringbookedpartial_filledfilledcanceledqueryFilter by order state
executionTypesArray<string>marketlimitquerytradeIdstringqueryTradeId of the order we want to fetch
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerpositions InjectiveDerivativeExchangeRPC
Positions gets the positions for a trader.
Parameters
subaccountIdstringquerySubaccountId of the trader we want to get the positions from
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
marketIdstringqueryMarketId of the position we want to fetch. Use this field for fetching from single market
marketIdsArray<string>queryMarketIds of the markets we want to filter. Use this field for fetching from multiple markets
directionstringlongshortqueryfilter by direction of the position
subaccountTotalPositionsbooleanfalsequeryset to True to return subaccount total positions
accountAddressstringqueryfilter by account address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headertrades InjectiveDerivativeExchangeRPC
Trades gets the trades of a Derivative Market.
Parameters
marketIdstringqueryMarketId of the market's orderbook we want to fetch
marketIdsArray<string>queryMarketIds of the markets of which we want to get trades
executionSidestringmakertakerqueryFilter by execution side of the trade
directionstringbuysellqueryFilter by direction the trade
skipintegerquerySkip will skip the first n item from the result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
subaccountIdsArray<string>querySubaccount ids of traders we want to get trades. Use this field for fetching trades from multiple subaccounts
subaccountIdstringquerySubaccountId of the trader we want to get the trades from
executionTypesArray<string>marketlimitFilllimitMatchRestingOrderlimitMatchNewOrderquerytradeIdstringqueryFilter by the tradeId of the trade
accountAddressstringqueryAccount address
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorderbookV2 InjectiveDerivativeExchangeRPC
Orderbook gets the Orderbook of a Derivative Market
Parameters
marketIdstringrequiredpathMarketId of the market's orderbook we want to fetch
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorderbooksV2 InjectiveDerivativeExchangeRPC
Orderbooks gets the Orderbooks of requested derivative markets
Parameters
marketIdsArray<string>requiredqueryMarketIds of the markets
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerpositionsV2 InjectiveDerivativeExchangeRPC
Positions gets the positions for a trader. V2 removed some redundant fields and had performance improvements
Parameters
subaccountIdstringquerySubaccountId of the trader we want to get the positions from
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
marketIdstringqueryMarketId of the position we want to fetch. Use this field for fetching from single market
marketIdsArray<string>queryMarketIds of the markets we want to filter. Use this field for fetching from multiple markets
directionstringlongshortqueryfilter by direction of the position
subaccountTotalPositionsbooleanfalsequeryset to True to return subaccount total positions
accountAddressstringqueryfilter by account address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headertradesV2 InjectiveDerivativeExchangeRPC
Trades gets the trades of a Derivative Market.
Parameters
marketIdstringqueryMarketId of the market's orderbook we want to fetch
marketIdsArray<string>queryMarketIds of the markets of which we want to get trades
executionSidestringmakertakerqueryFilter by execution side of the trade
directionstringbuysellqueryFilter by direction the trade
skipintegerquerySkip will skip the first n item from the result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
subaccountIdsArray<string>querySubaccount ids of traders we want to get trades. Use this field for fetching trades from multiple subaccounts
subaccountIdstringquerySubaccountId of the trader we want to get the trades from
executionTypesArray<string>marketlimitFilllimitMatchRestingOrderlimitMatchNewOrderquerytradeIdstringqueryFilter by the tradeId of the trade
accountAddressstringqueryAccount address
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveExplorerRPC
ExplorerAPI implements explorer data API for e.g. Blockchain Explorer
GetAccountTxs InjectiveExplorerRPC
GetAccountTxs returns tranctions involving in an account based upon params.
Parameters
beforeintegerqueryReturn transactions before this block number
afterintegerqueryReturn transactions after this block number
limitinteger<int64>queryskipintegerquerytypestringqueryfrom_numberinteger<int64>queryto_numberinteger<int64>querymodulestringquerystart_timeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the txs must be equal or older than
end_timeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the txs must be equal or younger than
statusstringfailsuccessqueryThe status of the txs to be returned
addressstringrequiredpathAddress of account
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetBankTransfers InjectiveExplorerRPC
GetBankTransfers returns bank transfers.
Parameters
sendersArray<string>queryTransfer sender address
recipientsArray<string>queryTransfer recipient address
addressArray<string>queryTransfers where either the sender or the recipient is one of the addresses
is_community_pool_relatedbooleanqueryReturns transfers with the community pool address as either sender or recipient
limitinteger<int64>queryskipintegerquerystart_timeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the transfers must be equal or older than
end_timeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the transfers must be equal or younger than
perPageinteger<int64>querytokenstringqueryResponse
OK response.
Bad Request response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetBlocks InjectiveExplorerRPC
GetBlocks returns blocks based upon the request params
Parameters
beforeintegerqueryafterintegerquerylimitinteger<int64>queryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetBlock InjectiveExplorerRPC
GetBlock returns block based upon the height or hash
Parameters
idstringrequiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetContractTxs InjectiveExplorerRPC
GetContractTxs returns contract-related transactions
Parameters
limitinteger[0, 100]100queryskipinteger<= 10000queryfrom_numberinteger<int64>queryto_numberinteger<int64>queryaddressstringrequiredpathAddress of contract
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetIBCTransferTxs InjectiveExplorerRPC
GetIBCTransferTxs returns the ibc transfer transactions based upon the request params
Parameters
senderstringqueryreceiverstringquerysrc_channelstringquerysrc_portstringquerydest_channelstringquerydest_portstringquerylimitinteger<int64>queryskipintegerqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetOrder InjectiveExplorerRPC
GetOrder returns order information based up on order id
Parameters
idstringrequiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetPeggyDepositTxs InjectiveExplorerRPC
GetPeggyDepositTxs returns the peggy deposit transactions based upon the request params
Parameters
senderstringquerySender address of deposit request
receiverstringqueryAddress of receiveer upon deposit
limitinteger<int64>queryskipintegerqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetPeggyWithdrawalTxs InjectiveExplorerRPC
GetPeggyWithdrawalTxs returns the peggy withdrawal transactions based upon the request params
Parameters
senderstringquerySender address of withdrawal request
receiverstringqueryAddress of receiveer upon withdrawal
limitinteger<int64>queryskipintegerqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerRelayers InjectiveExplorerRPC
Request relayers infos by marketIDs. If no ids are provided, all market with associated relayers are returned
Parameters
marketIDsArray<string>querySpecify multiple marketIDs to search.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetStatus InjectiveExplorerRPC
GetStatus returns current status on the active chain
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetTxs InjectiveExplorerRPC
GetTxs returns transactions based upon the request params
Parameters
beforeintegerqueryafterintegerquerylimitinteger<int64>queryskipintegerquerytypestringquerymodulestringqueryfrom_numberinteger<int64>queryto_numberinteger<int64>querystart_timeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the txs must be equal or older than
end_timeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the txs must be equal or younger than
statusstringfailsuccessqueryThe status of the txs to be returned
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetTxByTxHash InjectiveExplorerRPC
GetTxByTxHash returns certain transaction information by its tx hash.
Parameters
hashstringrequiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetValidatorUptime InjectiveExplorerRPC
GetValidatorUptime returns validator uptime information on the active chain
Parameters
addressstringrequiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetValidators InjectiveExplorerRPC
GetValidators returns validators on the active chain
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetValidator InjectiveExplorerRPC
GetValidator returns validator information on the active chain
Parameters
addressstringrequiredpathResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetWasmCodes InjectiveExplorerRPC
GetWasmCodes lists all stored code
Parameters
limitinteger[1, 100]100queryfrom_numberinteger<int64>queryto_numberinteger<int64>queryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetWasmCodeById InjectiveExplorerRPC
GetWasmCodeById list cosmwasm code infor by ID
Parameters
code_idinteger<int64>requiredpathCode ID of the code
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetWasmContracts InjectiveExplorerRPC
GetWasmContracts lists all contracts
Parameters
limitinteger[1, 100]100querycode_idinteger<int64>queryfrom_numberinteger<int64>queryto_numberinteger<int64>queryassets_onlybooleanfalsequeryskipinteger<int64>0querylabelstringqueryLabel of the contract
Response
OK response.
Authorization
api-keyAuthapiKey in headerGetWasmContractByAddress InjectiveExplorerRPC
GetWasmContractByAddress list cosmwasm contract info by its address
Parameters
contract_addressstringrequiredpathContract address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerGetCw20Balance InjectiveExplorerRPC
GetCw20Balance lists all cw20 balances of an injective account
Parameters
limitinteger[1, 100]100queryaddressstringrequiredpathaddress to list balance of
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerhealth
HealthAPI allows to check if backend data is up-to-date and reliable or not.
GetStatus health
Get current backend health status
Response
OK response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveInsuranceRPC
InjectiveInsuranceRPC defines gRPC API of Insurance provider.
funds InjectiveInsuranceRPC
Funds lists all insurance funds.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerredemptions InjectiveInsuranceRPC
PendingRedemptions lists all pending redemptions according to a filter
Parameters
redeemerstringqueryAccount address of the redemption owner
redemptionDenomstringqueryDenom of the insurance pool token.
statusstringqueryStatus of the redemption. Either pending or disbursed.
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveMetaRPC
InjectiveMetaRPC is a special API subset to get info about server.
info InjectiveMetaRPC
Gets connection info
Parameters
timestampinteger<int64>queryProvide current system UNIX timestamp in millis
Response
OK response.
Authorization
api-keyAuthapiKey in headerping InjectiveMetaRPC
Endpoint for checking server health.
Response
OK response.
Authorization
api-keyAuthapiKey in headertokenMetadata InjectiveMetaRPC
Get tokens metadata. Can be filtered by denom
Parameters
denomsArray<string>queryResponse
OK response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerversion InjectiveMetaRPC
Returns injective-exchange version.
Response
OK response.
Authorization
api-keyAuthapiKey in headerInjectiveOracleRPC
InjectiveOracleRPC defines gRPC API of Exchange Oracle provider.
oracleList InjectiveOracleRPC
List all oracles
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerprice InjectiveOracleRPC
Gets the price of the oracle
Parameters
baseSymbolstringrequiredqueryOracle base currency
quoteSymbolstringrequiredqueryOracle quote currency
oracleTypestringrequiredqueryOracle Type
oracleScaleFactorintegerrequiredqueryOracleScaleFactor
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectivePortfolioRPC
InjectivePortfolioRPC defines gRPC API of Exchange Portfolio provider.
accountPortfolio InjectivePortfolioRPC
Provide the account's portfolio
Parameters
accountAddressstringrequiredpathAccount address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headeraccountPortfolioBalances InjectivePortfolioRPC
Provide the account's portfolio balances
Parameters
accountAddressstringrequiredpathAccount address
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveSpotExchangeRPC
InjectiveSpotExchangeRPC defines gRPC API of Spot Exchange provider.
atomicSwapHistory InjectiveSpotExchangeRPC
Get historical atomic swaps
Parameters
addressstringrequiredquerysender of the atomic swap
contract_addressstringqueryatomic swap contract address to filter
limitinteger<int32>100querylimit number of swaps returned by this API
skipinteger<= 100000queryskip some swaps
from_numberinteger<int32>querylowerbound of atomic swap index
to_numberinteger<int32>queryupperbound of atomic swap index
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headermarkets InjectiveSpotExchangeRPC
Get a list of Spot Markets
Parameters
marketStatusstringactivepausedsuspendeddemolishedexpiredactivequeryFilter by market status
quoteDenomstringqueryFilter by the Coin denomination of the quote currency
baseDenomstringqueryFilter by the Coin denomination of the base currency
marketStatusesArray<string>activepausedsuspendeddemolishedexpiredqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headermarket InjectiveSpotExchangeRPC
Get details of a single spot market
Parameters
marketIdstringrequiredpathMarketId of the market we want to fetch
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorders InjectiveSpotExchangeRPC
Orders of a Spot Market
Parameters
marketIdstringqueryMarketId of the market's orderbook we want to fetch
marketIdsArray<string>queryMarketIds of the markets of which we want to get trades
orderSidestringbuysellqueryLook for specific order side
subaccountIdstringqueryLook for specific subaccountId of an order
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned.
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
includeInactivebooleanfalsequeryShould include inactive orders
subaccountTotalOrdersbooleanfalsequeryChoose to return subaccount total orders
tradeIdstringqueryTradeId of the order we want to fetch
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerordersHistory InjectiveSpotExchangeRPC
Lists history orders posted from this subaccount
Parameters
subaccountIdstringquerysubaccount ID to filter orders for specific subaccount
marketIdstringqueryMarket ID to filter orders for specific market
marketIdsArray<string>queryactiveMarketsOnlybooleanfalsequeryReturn only orders for active markets
skipinteger0querySkip will skip the first n item from the result
limitinteger[1, 100]100queryLimit is used to specify the maximum number of items to be returned
orderTypesArray<string>buysellstop_buystop_selltake_buytake_sellbuy_posell_poqueryfilter by order types
directionstringqueryorder side filter
startTimeinteger<int64>querySearch for orders which createdAt >= startTime, time in millisecond
endTimeinteger<int64>querySearch for orders which createdAt <= endTime, time in millisecond
statestringbookedpartial_filledfilledcanceledqueryFilter by order state
executionTypesArray<string>marketlimitquerytradeIdstringqueryTradeId of the order we want to fetch
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headertrades InjectiveSpotExchangeRPC
Trades of a Spot Market
Parameters
marketIdstringqueryMarketId of the market's orderbook we want to fetch
marketIdsArray<string>queryMarketIds of the markets of which we want to get trades
executionSidestringmakertakerqueryFilter by execution side of the trade
directionstringbuysellqueryFilter by direction the trade
skipintegerquerySkip will skip the first n item from the item result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
subaccountIdstringquerySubaccountId of the trader we want to get the trades from
subaccountIdsArray<string>querySubaccount ids of traders we want to get trades
executionTypesArray<string>marketlimitFilllimitMatchRestingOrderlimitMatchNewOrderquerytradeIdstringqueryFilter by the tradeId of the trade
accountAddressstringqueryAccount address
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorderbookV2 InjectiveSpotExchangeRPC
Orderbook of a Spot Market
Parameters
marketIdstringrequiredpathMarketId of the market's orderbook we want to fetch
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerorderbooksV2 InjectiveSpotExchangeRPC
Orderbook of Spot Markets
Parameters
marketIdsArray<string>requiredqueryMarketIds of the markets
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headertradesV2 InjectiveSpotExchangeRPC
Trades of a Spot Market
Parameters
marketIdstringqueryMarketId of the market's orderbook we want to fetch
marketIdsArray<string>queryMarketIds of the markets of which we want to get trades
executionSidestringmakertakerqueryFilter by execution side of the trade
directionstringbuysellqueryFilter by direction the trade
skipintegerquerySkip will skip the first n item from the item result
limitinteger<int64>queryLimit is used to specify the maximum number of items to be returned.
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds that the trades must be equal or older than
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds that the trades must be equal or younger than
subaccountIdstringquerySubaccountId of the trader we want to get the trades from
subaccountIdsArray<string>querySubaccount ids of traders we want to get trades
executionTypesArray<string>marketlimitFilllimitMatchRestingOrderlimitMatchNewOrderquerytradeIdstringqueryFilter by the tradeId of the trade
accountAddressstringqueryAccount address
cidstringqueryClient order ID
Response
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerInjectiveTradingRPC
InjectiveTradingStrategiesRPC defined a gRPC service for Injective Trading Strategies.
listTradingStrategies InjectiveTradingRPC
Lists all trading strategies
Parameters
statestringactiveremovedquerymarketIdstringqueryMarketId of the trading strategy
subaccountIdstringquerysubaccount ID to filter by
accountAddressstringqueryAccount address
startTimeinteger<int64>queryThe starting timestamp in UNIX milliseconds for the creation time of the trading strategy
endTimeinteger<int64>queryThe ending timestamp in UNIX milliseconds for the creation time of the trading strategy
pendingExecutionbooleanqueryIndicates whether the trading strategy is pending execution
limitinteger<int64>queryskipintegerqueryResponse
OK response.
Bad Request response.
Not Found response.
Internal Server Error response.
Authorization
api-keyAuthapiKey in headerTendermint / RPC
health
HealthAPI allows to check if backend data is up-to-date and reliable or not.
Health check
Checks if the node is alive and responding correctly.
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredEmpty object for health method
Response
Node is healthy
Authorization
api-keyAuthapiKey in headerabci_info
Get ABCI info
Retrieve information about the ABCI application including version and last block state
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringabci_inforequiredThe JSON-RPC method name
paramsobjectrequiredParameters for abci_info method (currently empty)
Response
Successful ABCI info response
Authorization
api-keyAuthapiKey in headerblock_by_hash
Get block by hash
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredResponse
Block data by hash or empty block if not found
Authorization
api-keyAuthapiKey in headerblock_results
Get block transaction results and events by height
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredResponse
Block transaction results and event data
Authorization
api-keyAuthapiKey in headerblock
Get block by height
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredResponse
Full block data for the specified height
Authorization
api-keyAuthapiKey in headerblockchain
Query blockchain block metadata in height range
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredResponse
Block metadata within height range
Authorization
api-keyAuthapiKey in headercheck_tx
Check transaction validity
Validate a transaction without adding it to the mempool. Returns transaction check results including gas usage and validation errors.
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringcheck_txrequiredThe JSON-RPC method name for transaction validation
paramsobjectrequiredResponse
Transaction validation result
Authorization
api-keyAuthapiKey in headercommit
Get block commit by height
Body
jsonrpcstringrequiredJSON-RPC version
idintegerrequiredRequest ID
methodstringrequiredRPC method name
paramsobjectrequiredResponse
Block commit data including signed header and signatures
Authorization
api-keyAuthapiKey in headerconsensus_params
Get consensus parameters
Retrieve current consensus parameters at specified block height
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringconsensus_paramsrequiredThe JSON-RPC method name
paramsobjectrequiredParameters for consensus_params method (currently empty)
Response
Successful consensus parameters response
Authorization
api-keyAuthapiKey in headerconsensus_state
Get consensus state
Retrieve current consensus state including round state, voting information, and proposer details
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringconsensus_staterequiredThe JSON-RPC method name
paramsobjectrequiredParameters for consensus_state method (currently empty)
Response
Successful consensus state response
Authorization
api-keyAuthapiKey in headerdump_consensus_state
Dump consensus state
Retrieve detailed consensus state including round state and complete validator set information
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringdump_consensus_staterequiredThe JSON-RPC method name
paramsobjectrequiredParameters for dump_consensus_state method (currently empty)
Response
Successful consensus state dump response
Authorization
api-keyAuthapiKey in headergenesis_chunked
Retrieve genesis chunk
Get a specific chunk of the genesis file for Cosmos Hub (ATOM)
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringgenesis_chunkedrequiredThe JSON-RPC method name
paramsobjectrequiredResponse
Successful genesis chunk response
Authorization
api-keyAuthapiKey in headergenesis
Get genesis data
Retrieves the blockchain genesis file using JSON-RPC.
Body
jsonrpcstringrequiredidintegerrequiredmethodstringgenesisrequiredparamsobjectrequiredNo parameters required for this method.
Response
Genesis data retrieved successfully.
Authorization
api-keyAuthapiKey in headernet_info
Get network info
Provides details about the P2P network, including peers, connection status, and listener info.
Body
jsonrpcstringrequiredidintegerrequiredmethodstringrequiredparamsobjectrequiredResponse
Network information
Authorization
api-keyAuthapiKey in headernum_unconfirmed_txs
Get number of unconfirmed transactions
Retrieve the count and size of transactions currently in the mempool without returning the actual transactions
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringnum_unconfirmed_txsrequiredThe JSON-RPC method name for getting unconfirmed transactions count
paramsobjectrequiredParameters for num_unconfirmed_txs method (currently empty)
Response
Successfully retrieved unconfirmed transactions count
Authorization
api-keyAuthapiKey in headerstatus
Get node status
Sends a JSON-RPC 2.0 POST request to the Tendermint RPC server to get node status.
Body
jsonrpcstringrequiredJSON-RPC protocol version
idintegerrequiredRequest identifier
methodstringrequiredRPC method name
paramsobjectrequiredMethod-specific parameters (empty object for status)
Response
Successful node status response
Authorization
api-keyAuthapiKey in headertx_search
Search transactions
Search for transactions with query filters, pagination, and sorting options
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringtx_searchrequiredThe JSON-RPC method name for transaction search
paramsobjectrequiredResponse
Transactions found successfully
Authorization
api-keyAuthapiKey in headertx
Get transaction by hash
Retrieve a transaction by its hash with optional proof verification
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringtxrequiredThe JSON-RPC method name for transaction query
paramsobjectrequiredResponse
Transaction found successfully
Authorization
api-keyAuthapiKey in headerunconfirmed_txs
Get unconfirmed transactions
Retrieve transactions currently in the mempool (unconfirmed transactions)
Body
jsonrpcstring2.0requiredJSON-RPC version identifier
idinteger | stringrequiredRequest identifier for matching responses
methodstringunconfirmed_txsrequiredThe JSON-RPC method name for getting unconfirmed transactions
paramsobjectrequiredResponse
Successfully retrieved unconfirmed transactions
Authorization
api-keyAuthapiKey in headervalidators
Get Validators by Block Height
Calls the validators JSON-RPC method to retrieve a paginated list of validators at a given block height.
Body
jsonrpcstring2.0requiredJSON-RPC protocol version, must be "2.0".
idintegerrequiredUnique identifier for the request, used to match the response.
methodstringvalidatorsrequiredThe method name to call.
paramsobjectrequiredResponse
Successful response containing validators list and metadata
Authorization
api-keyAuthapiKey in headerTendermint
Tendermint
Returns with the response from CheckTx. Does not wait for DeliverTx result.
This method blocks until CheckTx returns and reports its result, but does not wait for the transaction to be included in a block. To know when the transaction is included in a block, check for the transaction event using JSON-RPC.
Parameters
txstringrequiredqueryThe transaction
Response
Empty
Error
Authorization
api-keyAuthapiKey in headerReturns with the response from CheckTx. Does not wait for DeliverTx result.
This method blocks until CheckTx returns and reports its result, but does not wait for the transaction to be included in a block. To know when the transaction is included in a block, check for the transaction event using JSON-RPC.
Parameters
txstringrequiredqueryThe transaction
Response
Empty
Error
Authorization
api-keyAuthapiKey in headerReturns right away, with no response. Does not wait for CheckTx nor DeliverTx results.
This method submits the transaction and returns immediately without waiting for the transaction to be checked (CheckTx) or committed. Too know when the transaction is included in a block, you can check for the transaction event using JSON-RPC.
Parameters
txstringrequiredqueryThe transaction
Response
empty answer
empty error
Authorization
api-keyAuthapiKey in headerReturns with the responses from CheckTx and DeliverTx.
This method waits for the transaction to be checked (CheckTx) and makes a best effort to wait for it to be committed into a block before returning. It will report an error if the request times out before the transaction commits. If CheckTx or DeliverTx fails, the RPC will succeed and report the failing (non-zero) ABCI result code.
WARNING: Use this only for testing and development. For production use, call broadcast_tx.
To know when a transaction is included in a block, check for the transaction event using JSON-RPC.
Parameters
txstringrequiredqueryThe transaction
Response
empty answer
empty error
Authorization
api-keyAuthapiKey in headerChecks the transaction without executing it.
The transaction won't be added to the mempool.
Please refer to https://docs.tendermint.com/master/tendermint-core/using-tendermint.html#formatting for formatting/encoding rules.
Parameters
txstringrequiredqueryThe transaction
Response
ABCI application's CheckTx response
empty error
Authorization
api-keyAuthapiKey in headerRemoves a transaction from the mempool.
Parameters
txKeystringrequiredqueryThe transaction key
Response
empty response.
empty error.
Authorization
api-keyAuthapiKey in headerFetch events posted by the consensus node.
Fetch a batch of events posted by the consensus node and matching a specified query string.
The query grammar is defined in pubsub/query/syntax. An empty query matches all events; otherwise a query comprises one or more terms comparing event metadata to target values. For example, to select new block events:
tm.event = 'NewBlock'Multiple terms can be combined with AND, for example to match the transaction event with a given hash, use:
tm.event = 'Tx' AND tx.hash = 'EA7B33F'The comparison operators include =, <, <=, >, >=, and
CONTAINS. Operands may be strings (in single quotes), numbers, dates,
or timestamps. In addition, the EXISTS operator allows you to check
for the presence of an attribute regardless of its value.
Tendermint defines a tm.event attribute for all events. Transactions
are also assigned tx.hash and tx.height attributes. Other attributes
are provided by the application as ABCI Event records. The name of the
event in the query is formed by combining the type and attribute key
with a period. For example, given:
[]abci.Event{{
Type: "reward",
Attributes: []abci.EventAttribute{
{Key: "address", Value: "cosmos1xyz012pdq"},
{Key: "amount", Value: "45.62"},
{Key: "balance", Value: "100.390001"},
},
}}the query may refer to the names"reward.address,"reward.amount, and
reward.balance, as in:
reward.address EXISTS AND reward.balance > 45The node maintains a log of all events within an operator-defined time
window. The /events method returns the most recent items from the log
that match the query. Each item returned includes a cursor that marks
its location in the log. Cursors can be passed via the before and
after parameters to fetch events earlier in the log.
Parameters
filterEventFilterquerymaxItemsintegerqueryafterstringquerybeforestringquerywaitTimeintegerqueryResponse
Reports a batch of matching events
Reports an error
Authorization
api-keyAuthapiKey in headerSubscribe for events via WebSocket.
To tell which events you want, you need to provide a query. query is a string, which has a form: "condition AND condition ..." (no OR at the moment). condition has a form: "key operation operand". key is a string with a restricted set of possible symbols ( \t\n\r\()"'=>< are not allowed). operation can be "=", "<", "<=", ">", ">=", "CONTAINS" AND "EXISTS". operand can be a string (escaped with single quotes), number, date or time.
Examples: tm.event = 'NewBlock' # new blocks tm.event = 'CompleteProposal' # node got a complete proposal tm.event = 'Tx' AND tx.hash = 'XYZ' # single transaction tm.event = 'Tx' AND tx.height = 5 # all txs of the fifth block tx.height = 5 # all txs of the fifth block
Tendermint provides a few predefined keys: tm.event, tx.hash and tx.height. Note for transactions, you can define additional keys by providing events with DeliverTx response.
import ( abci "github.com/tendermint/tendermint/abci/types" "github.com/tendermint/tendermint/libs/pubsub/query" )
abci.ResponseDeliverTx{ Events: []abci.Event{ { Type: "rewards.withdraw", Attributes: []abci.EventAttribute{ {Key: "address", Value: "AddrA", Index: true}, {Key: "source", Value: "SrcX", Index: true}, {Key: "amount", Value: "...", Index: true}, {Key: "balance", Value: "...", Index: true}, }, }, { Type: "rewards.withdraw", Attributes: []abci.EventAttribute{ {Key: "address", Value: "AddrB", Index: true}, {Key: "source", Value: "SrcY", Index: true}, {Key: "amount", Value: "...", Index: true}, {Key: "balance", Value: "...", Index: true}, }, }, { Type: "transfer", Attributes: []abci.EventAttribute{ {Key: "sender", Value: "AddrC", Index: true}, {Key: "recipient", Value: "AddrD", Index: true}, {Key: "amount", Value: "...", Index: true}, }, }, }, }
All events are indexed by a composite key of the form {eventType}.{evenAttrKey}. In the above examples, the following keys would be indexed:
- rewards.withdraw.address
- rewards.withdraw.source
- rewards.withdraw.amount
- rewards.withdraw.balance
- transfer.sender
- transfer.recipient
- transfer.amount
Multiple event types with duplicate keys are allowed and are meant to
categorize unique and distinct events. In the above example, all events
indexed under the key rewards.withdraw.address will have the following
values stored and queryable:
- AddrA
- AddrB
To create a query for txs where address AddrA withdrew rewards: query.MustParse("tm.event = 'Tx' AND rewards.withdraw.address = 'AddrA'")
To create a query for txs where address AddrA withdrew rewards from source Y: query.MustParse("tm.event = 'Tx' AND rewards.withdraw.address = 'AddrA' AND rewards.withdraw.source = 'Y'")
To create a query for txs where AddrA transferred funds: query.MustParse("tm.event = 'Tx' AND transfer.sender = 'AddrA'")
The following queries would return no results: query.MustParse("tm.event = 'Tx' AND transfer.sender = 'AddrZ'") query.MustParse("tm.event = 'Tx' AND rewards.withdraw.address = 'AddrZ'") query.MustParse("tm.event = 'Tx' AND rewards.withdraw.source = 'W'")
import rpchttp "github.com/tendermint/rpc/client/http"
import "github.com/tendermint/tendermint/types"
client, err := rpchttp.New("tcp://0.0.0.0:26657", "/websocket")
if err != nil {
// handle error
}
err = client.Start()
if err != nil {
// handle error
}
defer client.Stop()
ctx, cancel := context.WithTimeout(context.Background(), 1 * time.Second)
defer cancel()
query := "tm.event = 'Tx' AND tx.height = 3"
txs, err := client.Subscribe(ctx, "test-client", query)
if err != nil {
// handle error
}
go func() {
for e := range txs {
fmt.Println("got ", e.Data.(types.EventDataTx))
}
}()NOTE: if you're not reading events fast enough, Tendermint might terminate the subscription.
Parameters
querystringrequiredqueryquery is a string, which has a form: "condition AND condition ..." (no OR at the moment). condition has a form: "key operation operand". key is a string with a restricted set of possible symbols ( \t\n\r\()"'=>< are not allowed). operation can be "=", "<", "<=", ">", ">=", "CONTAINS". operand can be a string (escaped with single quotes), number, date or time.
Response
empty answer
empty error
Authorization
api-keyAuthapiKey in headerUnsubscribe from event on Websocket
client, err := rpchttp.New("tcp://0.0.0.0:26657", "/websocket")
if err != nil {
// handle error
}
err := client.Start()
if err != nil {
// handle error
}
defer client.Stop()
query := "tm.event = 'Tx' AND tx.height = 3"
err = client.Unsubscribe(context.Background(), "test-client", query)
if err != nil {
// handle error
}Parameters
querystringrequiredqueryquery is a string, which has a form: "condition AND condition ..." (no OR at the moment). condition has a form: "key operation operand". key is a string with a restricted set of possible symbols ( \t\n\r\()"'=>< are not allowed). operation can be "=", "<", "<=", ">", ">=", "CONTAINS". operand can be a string (escaped with single quotes), number, date or time.
Response
Answer
Error
Authorization
api-keyAuthapiKey in headerUnsubscribe from all events via WebSocket
Unsubscribe from all events via WebSocket
Response
empty answer
empty error
Authorization
api-keyAuthapiKey in headerNode heartbeat
Get node health. Returns empty result (200 OK) on success, no response - in case of an error.
Response
Gets Node Health
empty error
Authorization
api-keyAuthapiKey in headerNode Status
Get Tendermint status including node info, pubkey, latest block hash, app hash, block height, current max peer height, and time.
Response
Status of the node
empty error
Authorization
api-keyAuthapiKey in headerNetwork information
Get network info.
Response
empty answer
empty error
Authorization
api-keyAuthapiKey in headerGet block headers (max: 20) for minHeight <= height <= maxHeight.
Get block headers for minHeight <= height maxHeight.
If maxHeight does not yet exist, blocks up to the current height will be returned. If minHeight does not exist (due to pruning), earliest existing height will be used.
At most 20 items will be returned. Block headers are returned in descending order (highest first).
Parameters
minHeightintegerqueryMinimum block height to return
maxHeightintegerqueryMaximum block height to return
Response
Block headers, returned in descending order (highest first).
Error
Authorization
api-keyAuthapiKey in headerGet the header at a specified height
Retrieve the block header corresponding to a specified height.
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch the latest height.
Response
Header information.
Error
Authorization
api-keyAuthapiKey in headerGet header by hash
Retrieve the block header corresponding to a block hash.
Parameters
hashstringrequiredqueryheader hash
Response
Header information.
Error
Authorization
api-keyAuthapiKey in headerGet block at a specified height
Get Block.
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch the latest block.
Response
Block information.
Error
Authorization
api-keyAuthapiKey in headerGet block by hash
Get Block By Hash.
Parameters
hashstringrequiredqueryblock hash
Response
Block information.
Error
Authorization
api-keyAuthapiKey in headerGet block results at a specified height
Get block_results.
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch information regarding the latest block.
Response
Block results.
Error
Authorization
api-keyAuthapiKey in headerGet commit results at a specified height
Get Commit.
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch commit information regarding the latest block.
Response
Commit results.
canonical switches from false to true for block H once block H+1 has been committed. Until then it's subjective and only reflects what this node has seen so far.
Error
Authorization
api-keyAuthapiKey in headerGet validator set at a specified height
Get Validators. Validators are sorted first by voting power (descending), then by address (ascending).
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch validator set which corresponds to the latest block.
pageinteger1queryPage number (1-based)
per_pageinteger30queryNumber of entries per page (max: 100)
Response
Commit results.
Error
Authorization
api-keyAuthapiKey in headerGet Genesis
Get the genesis document.
Response
Genesis results.
Error
Authorization
api-keyAuthapiKey in headerGet Genesis in paginated chunks
Get genesis document in a paginated/chunked format to make it easier to iterate through larger genesis structures.
Parameters
chunkIDinteger0querySequence number of the chunk to download.
Response
Genesis results.
Error
Authorization
api-keyAuthapiKey in headerGet consensus state
Get consensus state.
Not safe to call from inside the ABCI application during a block execution.
Response
Complete consensus state.
Error
Authorization
api-keyAuthapiKey in headerGet consensus state
Get consensus state.
Not safe to call from inside the ABCI application during a block execution.
Response
consensus state results.
Error
Authorization
api-keyAuthapiKey in headerGet consensus parameters
Get consensus parameters.
Parameters
heightinteger0queryheight to return. If no height is provided, it will fetch commit information regarding the latest block.
Response
consensus parameters results.
Error
Authorization
api-keyAuthapiKey in headerGet the list of unconfirmed transactions
Get list of unconfirmed transactions
Parameters
pageinteger1queryPage number (1-based)
per_pageinteger30queryNumber of entries per page (max: 100)
Response
List of unconfirmed transactions
Error
Authorization
api-keyAuthapiKey in headerGet data about unconfirmed transactions
Get data about unconfirmed transactions
Response
status about unconfirmed transactions
Error
Authorization
api-keyAuthapiKey in headerSearch for transactions
Search for transactions w/ their results.
See /subscribe for the query syntax.
Parameters
querystringrequiredqueryQuery
provebooleanfalsequeryInclude proofs of the transactions inclusion in the block
pageinteger1queryPage number (1-based)
per_pageinteger30queryNumber of entries per page (max: 100)
order_bystringdescqueryOrder in which transactions are sorted ("asc" or "desc"), by height & index. If empty, default sorting will be still applied.
Response
List of transactions
Error
Authorization
api-keyAuthapiKey in headerSearch for blocks by BeginBlock and EndBlock events
Search for blocks by BeginBlock and EndBlock events.
See /subscribe for the query syntax.
Parameters
querystringrequiredqueryQuery
pageinteger1queryPage number (1-based)
per_pageinteger30queryNumber of entries per page (max: 100)
order_bystringdescqueryOrder in which blocks are sorted ("asc" or "desc"), by height. If empty, default sorting will be still applied.
Response
List of paginated blocks matching the search criteria.
Error
Authorization
api-keyAuthapiKey in headerGet transactions by hash
Get a transaction
Parameters
hashstringrequiredquerytransaction Hash to retrive
provebooleanfalsequeryInclude proofs of the transactions inclusion in the block
Response
Get a transaction
Error
Authorization
api-keyAuthapiKey in headerGet some info about the application.
Get some info about the application.
Response
Get some info about the application.
Error
Authorization
api-keyAuthapiKey in headerQuery the application for some information.
Query the application for some information.
Parameters
pathstringrequiredqueryPath to the data ("/a/b/c")
datastringrequiredqueryData
heightinteger0queryHeight (0 means latest)
provebooleanfalsequeryInclude proofs of the transactions inclusion in the block
Response
Response of the submitted query
Error
Authorization
api-keyAuthapiKey in headerBroadcast evidence of the misbehavior.
Broadcast evidence of the misbehavior.
Parameters
evidencestringrequiredqueryJSON evidence
Response
Broadcast evidence of the misbehavior.
Error
Authorization
api-keyAuthapiKey in header