Ethereum JSON-RPC
v1.0.0https://qie-evm.nownodes.iohttps://qie-tendermint.nownodes.iohttps://qie.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
EVM
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>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>requiredArray of parameters:
- Block hash (string)
- Boolean flag — if true, return full transactions; if false, only hashes.
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>requiredArray of parameters:
- Block number (hex string, e.g., "0x1b4") or special tags ("latest", "earliest", "pending")
- Boolean flag — if true, return full transactions; if false, only hashes.
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 headerTendermint RPC
abci_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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 headerParams
Params 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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Response
A successful response.
An unexpected error 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 headerhealth
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 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
REST-API
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.
REST-API 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
REST-API 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, REST-API 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 REST-API 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