API Reference
v1.0.0https://zil.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
MAINNET / API-Reference
CreateTransaction
Create and send a new transaction
Creates a new transaction and broadcasts it to the Zilliqa network. The transaction can be a transfer of ZIL or an interaction with a smart contract.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<object>requiredTransaction parameters object
Response
Transaction created and broadcasted successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerDSBlockListing
List DS blocks with pagination
Returns a paginated list of DS blocks from the blockchain, where each page contains a defined number of blocks. The most recent blocks are listed first by default.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer>requiredArray with pagination parameters:
max: Maximum number of blocks to return (default 10)offset: Offset from the latest block (default 0)
Response
Paginated DS block listing retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerdefault
Get latest DS block number
Returns the latest DS (Directory Service) block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Latest DS block number retrieved successfully
Authorization
api-keyAuthapiKey in headerGet DS block creation rate
Returns the rate of DS block creation in blocks per second.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
DS block creation rate retrieved successfully
Authorization
api-keyAuthapiKey in headerGet latest transaction block number
Returns the latest transaction (Tx) block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Latest Tx block number retrieved successfully
Authorization
api-keyAuthapiKey in headerGet network ID
Returns the network ID of the connected Zilliqa network.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Network ID retrieved successfully
Authorization
api-keyAuthapiKey in headerGet miner information
Returns information about the miner of the node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Miner information retrieved successfully
Authorization
api-keyAuthapiKey in headerGet node type
Returns the type of the current node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Node type retrieved successfully
Authorization
api-keyAuthapiKey in headerGet number of DS blocks
Returns the total number of DS blocks created so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Number of DS blocks retrieved successfully
Authorization
api-keyAuthapiKey in headerGet number of peers
Returns the number of peers connected to this node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Number of peers retrieved successfully
Authorization
api-keyAuthapiKey in headerGet number of transactions
Returns the total number of transactions processed so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Number of transactions retrieved successfully
Authorization
api-keyAuthapiKey in headerGet number of transaction blocks
Returns the total number of transaction blocks created so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Number of transaction blocks retrieved successfully
Authorization
api-keyAuthapiKey in headerGet previous mining difficulty
Returns the mining difficulty of the previous transaction block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Previous transaction block difficulty retrieved successfully
Authorization
api-keyAuthapiKey in headerGet previous DS block difficulty
Returns the mining difficulty of the previous DS block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Previous DS block difficulty retrieved successfully
Authorization
api-keyAuthapiKey in headerGet current sharding structure
Returns the current sharding structure of the Zilliqa network including shards and DS committee members.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Sharding structure retrieved successfully
Authorization
api-keyAuthapiKey in headerGet node software version
Returns the current node software version.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Node version retrieved successfully
Authorization
api-keyAuthapiKey in headerGet total coin supply
Returns the total circulating supply of ZIL coins.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Total coin supply retrieved successfully
Authorization
api-keyAuthapiKey in headerGet transaction block details by block number
Returns detailed information about a specific transaction block by its number.
Body
jsonrpcstringJSON-RPC version
methodstringMethod name
idintegerRequest ID
paramsArray<integer>Array with block number (height) as parameter
Response
Transaction block details retrieved successfully
Authorization
api-keyAuthapiKey in headerGet transaction block creation rate
Returns the average rate at which transaction blocks are created.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Transaction block creation rate retrieved successfully
Authorization
api-keyAuthapiKey in headerGetBalance
Get balance of a Zilliqa address
Retrieves the current balance of a specified Zilliqa address in Qa (1 ZIL = 10^12 Qa).
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray containing the Zilliqa address to query
Response
Balance retrieval successful
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetBlockchainInfo
Get blockchain metadata
Returns high-level information about the blockchain's current state, such as DS and transaction block numbers, difficulties, and gas prices.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest identifier
paramsarrayrequiredMust be an empty array
Response
Blockchain metadata successfully returned
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetContractAddressFromTransactionID
Get smart contract address from transaction ID
Retrieves the smart contract address that is associated with a given transaction ID (hash). Useful to identify which contract was interacted with in the specified transaction.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray with one parameter — transaction ID (hash)
Response
Smart contract address retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetCurrentDSComm
Get current DS committee
Returns the current Directory Service (DS) committee that is responsible for consensus. Each DS committee member is represented by its public key.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsarrayrequiredShould be an empty array
Response
Current DS committee retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetCurrentDSEpoch
Get current DS epoch
Returns the current DS epoch number. A DS epoch represents a period of consensus rounds managed by a particular DS committee.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsarrayrequiredShould be an empty array
Response
Successfully retrieved current DS epoch number
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetCurrentMiniEpoch
Get current Tx (Mini) epoch
Returns the current Mini Epoch number. A Mini Epoch (a.k.a. Tx Epoch) is a unit of time in which transaction blocks are produced.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsarrayrequiredShould be an empty array
Response
Current mini epoch number successfully retrieved
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetDsBlock
Get a specific DS block
Returns details about a Directory Service (DS) block identified by its block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer>requiredArray containing a single DS block number
Response
DS block data returned successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetDSBlockRate
Get DS block creation rate
Returns the rate of DS block creation in blocks per second.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successful response with DS block production rate
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetLatestDsBlock
Get latest DS block number
Returns the latest DS (Directory Service) block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successful response with the latest DS block
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetLatestTxBlock
Get latest transaction block number
Returns the latest transaction (Tx) block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Latest Tx block details retrieved successfully
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetMinerInfo
Get miner information
Returns information about the miner of the node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved miner information
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetMinimumGasPrice
Get current minimum gas price
Retrieves the current minimum gas price (in Qa) required for a transaction to be accepted by the Zilliqa network.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
Response
Current minimum gas price retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetNetworkId
Get network ID
Returns the network ID of the connected Zilliqa network.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved the network ID
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNodeType
Get node type
Returns the type of the current node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved node type
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNumDSBlocks
Get number of DS blocks
Returns the total number of DS blocks created so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved number of DS blocks
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNumPeers
Get number of peers
Returns the number of peers connected to this node.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved number of peers
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNumTransactions
Get number of transactions
Returns the total number of transactions processed so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved transaction count
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNumTxBlocks
Get number of transaction blocks
Returns the total number of transaction blocks created so far.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved number of Tx blocks
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetNumTxnsDSEpoch
Get number of transactions in current DS epoch
Retrieves the total number of transactions processed during the current Directory Service (DS) epoch.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
Response
Number of transactions in the DS epoch retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetNumTxnsTxEpoch
Get number of transactions in current Tx epoch
Retrieves the total number of transactions processed during the current transaction (Tx) epoch on the Zilliqa blockchain.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
Response
Number of transactions in the Tx epoch retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetPrevDifficulty
Get previous mining difficulty
Returns the mining difficulty of the previous transaction block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved previous block difficulty
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetPrevDSDifficulty
Get previous DS block difficulty
Returns the mining difficulty of the previous DS block.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved previous DS block difficulty
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetRecentTransactions
Retrieve recent transactions
Returns a list of recent transactions on the Zilliqa blockchain. Optionally supports parameters such as limit (number of transactions).
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer | string>Optional parameters array.
Response
Recent transactions retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetShardingStructure
Get current sharding structure
Returns the current sharding structure of the Zilliqa network including shards and DS committee members.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved sharding structure
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetSmartContractCode
Get smart contract source code by address
Retrieves the source code and metadata of a smart contract deployed on the Zilliqa blockchain. Requires the smart contract address as a parameter.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray containing one parameter — smart contract address
Response
Smart contract source code retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetSmartContractInit
Get smart contract initial state and parameters
Retrieves the initial state (init) of a deployed smart contract by its address. This includes the contract’s parameters set during deployment.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray with one parameter — smart contract address
Response
Smart contract initial state retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetSmartContracts
Get list of deployed smart contracts
Retrieves a paginated list of smart contracts deployed on the Zilliqa blockchain. Supports optional parameters for pagination such as page number and limit.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<object>requiredParameters for pagination (optional)
Response
List of smart contracts retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetSmartContractState
Get current state of a smart contract
Retrieves the current state (fields and their values) of a smart contract deployed on the Zilliqa blockchain by its address.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray containing the smart contract address as a string
Response
Current smart contract state retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetSmartContractSubState
Get specific sub-state of a smart contract
Retrieves the value(s) of a specific field or subset of the state of a deployed smart contract by its address. The field name and optional keys for nested state access can be specified.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | Array<string>>requiredParameters array: - smart contract address (string) - field name (string) - optional keys array (array of strings)
Response
Smart contract sub-state retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetSoftConfirmedTransaction
Get details of a soft-confirmed transaction
Retrieves details of a transaction that has been soft-confirmed on the Zilliqa network, identified by its transaction ID.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray containing the transaction ID to query
Response
Soft-confirmed transaction details retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetStateProof
Get cryptographic state proof
Retrieves a cryptographic proof (Merkle proof) for a specific part of the blockchain state, such as a smart contract state or account state. Useful for verifying data integrity.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | Array<string>>requiredParameters to specify the target for the state proof (e.g., contract address and keys)
Response
State proof retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetTotalCoinSupply
Get total coin supply
Returns the total circulating supply of ZIL coins.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved total coin supply
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetTransactionsForTxBlock
Retrieve transactions for a transaction block
Returns a list of transactions included in a transaction block specified by the block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredThe method name
idintegerrequiredRequest identifier
paramsArray<integer>requiredArray containing the transaction block number
Response
Successful response with list of transactions
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetTransactionsForTxBlockEx
Get extended transactions for a transaction block
Retrieves detailed and extended information about transactions included in a specific transaction block, identified by the block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer>requiredArray containing the transaction block number
Response
Extended transactions for the specified transaction block retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetTransactionStatus
Get status of a transaction
Retrieves the current status of a transaction identified by its transaction ID.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string>requiredArray containing the transaction ID to query
Response
Transaction status retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetTxBlock
Get transaction block details by block number
Returns detailed information about a specific transaction block by its number.
Body
jsonrpcstringJSON-RPC version
methodstringMethod name
idintegerRequest ID
paramsArray<integer>Array with block number (height) as parameter
Parameters
blockNumintegerrequiredqueryBlock number (height) of the Tx block to retrieve
Response
Successfully retrieved transaction block details
Invalid request or missing blockNum parameter
Transaction block not found
Internal server error
Authorization
api-keyAuthapiKey in headerGetTxBlockRate
Get transaction block creation rate
Returns the average rate at which transaction (Tx) blocks are created in the Zilliqa blockchain, typically measured in blocks per second or blocks per minute.
Body
jsonrpcstringJSON-RPC version
methodstringMethod name
idintegerRequest ID
paramsarrayParameters array (empty for this method)
Response
Successfully retrieved transaction block rate
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerGetTxnBodiesForTxBlock
Get transaction bodies for a transaction block
Retrieves detailed transaction bodies included in a specific transaction block, identified by the block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer>requiredArray containing the transaction block number
Response
Transaction bodies for the specified transaction block retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetTxnBodiesForTxBlockEx
Get extended transaction bodies for a transaction block
Retrieves detailed and extended information of transaction bodies included in a specific transaction block, identified by the block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<integer>requiredArray containing the transaction block number
Response
Extended transaction bodies for the specified transaction block retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerGetVersion
Get node software version
Returns the current node software version.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<string | integer | object | boolean>requiredParameters for the method (empty if none)
Response
Successfully retrieved node version
Invalid request
Internal server error
Authorization
api-keyAuthapiKey in headerTxBlockListing
Get a list of transaction blocks
Returns a paginated list of transaction blocks. Supports parameters for pagination such as page number and limit.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
idintegerrequiredRequest ID
paramsArray<object>requiredParameters for pagination (optional)
Response
Transaction blocks listing retrieved successfully
Invalid request
Server error
Authorization
api-keyAuthapiKey in headerMAINNET / 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 | string>requiredArray with 2 parameters:
- Address (20-byte hex string with '0x' prefix)
- Block tag (e.g., 'latest', 'earliest', 'pending', or block number in hex)
idintegerrequiredRequest ID
Response
Balance (in wei) as hex string
Authorization
api-keyAuthapiKey in headereth_getBlockByHash
Get Block by Hash
Returns the block information for the specified block hash. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string | boolean>requiredArray with 2 parameters:
- Block hash (32-byte hex string with '0x' prefix)
- Boolean to specify if full transaction objects are returned (
true) or only transaction hashes (false)
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockByNumber
Get Block by Number
Returns the block information for the specified block number. The second parameter indicates whether to return full transaction objects or just transaction hashes.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string | boolean>requiredArray with 2 parameters:
- Block number (hex string, e.g., "0x1b4") or special tags ("latest", "earliest", "pending")
- Boolean to specify if full transaction objects are returned (
true) or only transaction hashes (false)
idintegerrequiredRequest ID
Response
Block information
Authorization
api-keyAuthapiKey in headereth_getBlockReceipts
Get All Transaction Receipts for a Block
Returns an array of transaction receipts for every transaction in the block specified by block number or block hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredOne parameter:
- Block identifier, which can be either:
- block number as hex string (e.g. "0x10d4f")
- or block hash as hex string (0x-prefixed)
idintegerrequiredRequest identifier
Response
Array of transaction receipts in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByHash
Get Transaction Count by Block Hash
Returns the number of transactions contained in the block with the given hash.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block hash as a hex string (32 bytes with 0x prefix)
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getBlockTransactionCountByNumber
Get Transaction Count by Block Number
Returns the number of transactions contained in the block with the given block number.
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<string>requiredArray containing a single parameter:
- Block number as a hex string (e.g. "0x10d4f" for block 69007) or
- predefined block tags such as "latest", "earliest", or "pending"
idintegerrequiredRequest ID
Response
Number of transactions in the block
Authorization
api-keyAuthapiKey in headereth_getCode
Get Contract Bytecode at Address
Returns the contract code stored at a given address. If the address is an externally owned account (EOA), it returns "0x".
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with two elements:
- The address to get the code for (hex string, 0x-prefixed).
- The block number or block tag (e.g., "latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Contract bytecode in hex format
Authorization
api-keyAuthapiKey in headereth_getFilterChanges
Get Filter Changes
Returns an array of logs that occurred since the last poll for the specified filter ID. The filter must have been previously created with eth_newFilter or eth_newBlockFilter or eth_newPendingTransactionFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with a single element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects or transaction hashes depending on filter type
Authorization
api-keyAuthapiKey in headereth_getFilterLogs
Get Filter Logs
Returns all logs matching a filter with the specified filter ID. The filter must have been previously created with eth_newFilter.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array with one element:
- The filter ID (hex string).
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getLogs
Get Logs
Returns an array of logs that match the filter criteria specified in the params. The filter object supports filtering by block range, addresses, and topics.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<object>requiredParameters array with one element: the filter object.
idintegerrequiredRequest identifier.
Response
Array of log objects matching the filter
Authorization
api-keyAuthapiKey in headereth_getStorageAt
Get Storage At
Returns the value stored at position in the storage of the contract at address at the given blockNumber.
Body
jsonrpcstringrequiredJSON-RPC version.
methodstringrequiredJSON-RPC method name.
paramsArray<string>requiredParameters array:
- address: string - Contract address to query storage from.
- position: string - Storage slot position (hex string).
- block number: string - Block number or keywords ("latest", "earliest", "pending").
idintegerrequiredRequest identifier.
Response
Storage slot value at the specified position
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockHashAndIndex
Get Transaction by Block Hash and Index
Retrieves the transaction from a block using the block's hash and the transaction's index position within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- blockHash (string): The 32-byte hash of the block.
- transactionIndex (string): The transaction index (hex).
idintegerrequiredResponse
A transaction object or null if no transaction was found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByBlockNumberAndIndex
Get Transaction by Block Number and Index
Returns the information about a transaction using the block number and the transaction index within the block.
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredParameters:
- Block number in hex format (e.g., "0x5daf3b")
- Transaction index in the block (e.g., "0x0")
idintegerrequiredResponse
A transaction object, or null if not found.
Authorization
api-keyAuthapiKey in headereth_getTransactionByHash
Get transaction by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredArray containing a single transaction hash
idintegerrequiredResponse
Transaction object or null
Authorization
api-keyAuthapiKey in headereth_getTransactionCount
Get transaction count (nonce) for address
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required- address: The address to check for transaction count.
- block: The block parameter (e.g., "latest", "earliest", "pending").
idintegerrequiredResponse
Hex encoded nonce (transaction count)
Authorization
api-keyAuthapiKey in headereth_getTransactionReceipt
Get transaction receipt by hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Transaction receipt if mined, otherwise null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockHashAndIndex
Get uncle block by block hash and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockHash: 32-byte block hashindex: the uncle index as hex (e.g., "0x0" for the first uncle)
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleByBlockNumberAndIndex
Get uncle block by block number and index
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredblockNumber: The block number as hex string (e.g., "0x10fb78"), or "latest", "earliest", "pending".index: The uncle index as hex (e.g., "0x0" for the first uncle).
idintegerrequiredResponse
Uncle block object or null
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockHash
Get the number of uncle blocks by block hash
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block hash.
idintegerrequiredResponse
Number of uncles in the block
Authorization
api-keyAuthapiKey in headereth_getUncleCountByBlockNumber
Get the number of uncle blocks by block number
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredAn array containing the block number as a hex string.
idintegerrequiredResponse
Number of uncle blocks in the block
Authorization
api-keyAuthapiKey in headereth_hashrate
eth_hashrate
Returns the current mining hashrate reported by the client.
Body
jsonrpcstringrequiredmethodstringeth_hashraterequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current mining hashrate
Authorization
api-keyAuthapiKey in headereth_maxPriorityFeePerGas
Get recommended maxPriorityFeePerGas value
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredNo parameters are required.
idintegerrequiredResponse
Returns the suggested maxPriorityFeePerGas value
Authorization
api-keyAuthapiKey in headereth_mining
eth_mining
Checks whether the Ethereum client is actively mining.
Body
jsonrpcstringrequiredmethodstringeth_miningrequiredparamsarrayrequiredThis method does not accept parameters.
idintegerrequiredResponse
JSON-RPC Response indicating mining status
Authorization
api-keyAuthapiKey in headereth_newBlockFilter
Create a new block filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<any>requiredThis method does not require any parameters.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newFilter
Create a new log filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredArray with one object describing the filter options.
idintegerrequiredResponse
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_newPendingTransactionFilter
Create a filter for pending transactions
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredJSON-RPC method name
paramsArray<any>requiredNo parameters required for this method
idintegerrequiredRequest identifier
Response
Filter ID created successfully
Authorization
api-keyAuthapiKey in headereth_sendRawTransaction
Send a raw signed transaction
Body
jsonrpcstringrequiredJSON-RPC version
methodstringrequiredMethod name
paramsArray<string>requiredArray containing a single signed transaction data (hex string)
idintegerrequiredRequest ID
Response
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sendTransaction
Send a transaction using node-managed account
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<object>requiredTransaction object
idintegerrequiredResponse
Transaction successfully sent
Authorization
api-keyAuthapiKey in headereth_sign
Sign arbitrary data using eth_sign
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>required[address, data]
- address: The account that will sign the data
- data: The data to be signed (must be a hex string)
idintegerrequiredResponse
Returns the signature of the message
Authorization
api-keyAuthapiKey in headereth_signTransaction
eth_signTransaction
Signs a transaction locally with the private key of the specified account.
Body
jsonrpcstringrequiredmethodstringeth_signTransactionrequiredparamsArray<object>requiredArray with a single object representing the transaction to sign.
idintegerrequiredResponse
JSON-RPC response with the signed transaction data
Authorization
api-keyAuthapiKey in headereth_syncing
Check if node is syncing
Body
jsonrpcstringrequiredmethodstringrequiredparamsarrayrequiredMust be an empty array.
idintegerrequiredResponse
Returns sync status object or false
Authorization
api-keyAuthapiKey in headereth_uninstallFilter
Uninstall an existing filter
Body
jsonrpcstringrequiredmethodstringrequiredparamsArray<string>requiredidintegerrequiredResponse
Success or failure of the uninstall operation
Authorization
api-keyAuthapiKey in headernet_listening
net_listening
Checks if the client is listening for network connections.
Body
jsonrpcstringrequiredmethodstringnet_listeningrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with listening status
Authorization
api-keyAuthapiKey in headernet_peerCount
net_peerCount
Returns the number of peers currently connected to the client.
Body
jsonrpcstringrequiredmethodstringnet_peerCountrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the number of connected peers
Authorization
api-keyAuthapiKey in headernet_version
net_version
Returns the current network ID of the Ethereum client.
Body
jsonrpcstringrequiredmethodstringnet_versionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the current network ID
Authorization
api-keyAuthapiKey in headerweb3_clientVersion
web3_clientVersion
Returns the current Ethereum client version.
Body
jsonrpcstringrequiredmethodstringweb3_clientVersionrequiredparamsarrayrequiredThis method takes no parameters.
idintegerrequiredResponse
JSON-RPC response with the client version string
Authorization
api-keyAuthapiKey in headerweb3_sha3
web3_sha3
Computes the Keccak-256 (SHA-3) hash of the given hex-encoded data.
Body
jsonrpcstringrequiredmethodstringweb3_sha3requiredparamsArray<string>requiredArray containing a single hex-encoded data string to hash.
idintegerrequiredResponse
JSON-RPC response with the Keccak-256 hash of the input data
Authorization
api-keyAuthapiKey in header