Blockbook API
v2.0.0-drafthttps://etc-blockbook.nownodes.iohttps://etc.nownodes.io/https://etc.nownodes.ioCanonical description of the Blockbook public API, based on blockbook-api.ts, api/xpub.go, and the api/server handlers.
API V2 is the current Blockbook API. It is available over REST and over WebSocket using the WsRequest/WsResponse JSON envelope documented below. The normalized API shapes are shared by all supported coins, while blockchain-specific payloads remain extensible where Blockbook returns raw backend JSON.
Amounts are strings in the lowest denomination of the chain, such as satoshis or wei, without a decimal point. Empty fields are omitted: empty means null, an empty string, numeric zero, a null object, or an empty array. Since the same API serves many different chains, this can sometimes hide otherwise meaningful zero values such as transaction version 0.
Legacy API V1 is a Bitcore Insight-compatible subset for Bitcoin-type coins. It is provided as-is for compatibility and is not being extended.
Load estimates are qualitative hints for client authors. Low means a small constant-time lookup or cached metadata. Medium means bounded indexed work or response size. High means potentially large scans, large payloads, broadcast/backend work, or external RPC enrichment. Actual cost also depends on chain speed, backend health, cache warmth, mempool size, pageSize, gap, and the number of addresses, transactions, tokens, filters, or timestamps involved.
Authentication
api-keyAuthapiKeyAPI Key: api-key in header
MAINNET / Blockbook
BlockBook
Get Blockbook and backend status.
Returns Blockbook sync state and connected backend metadata.
Load estimate: Low; constant-size status metadata.
Response
Current Blockbook and backend status.
Public API error. Public validation errors are HTTP 400; internal errors are HTTP 500.
Authorization
api-keyAuthapiKey in headerGet status from the API index handler.
Alias served by the same handler as /api/status on full public interfaces.
Load estimate: Low; constant-size status metadata.
Response
Current Blockbook and backend status.
Public API error.
Authorization
api-keyAuthapiKey in headerGet a block hash by height.
Returns the block hash for a height on the backend main chain. Blockbook follows the backend main chain; after a rollback or reorg, height lookups resolve to the current main-chain block.
Load estimate: Low; indexed height-to-hash lookup.
Parameters
heightinteger>= 0requiredpathBlock height on the backend main chain.
Response
Block hash at the requested height.
Public API error.
Authorization
api-keyAuthapiKey in headerGet a block by height or hash.
Returns block information with paged transactions. When full transaction details are unavailable, the response can contain only transaction ids.
Blockbook follows the backend main chain. Height lookups always return the current main-chain block. Hash lookups can return a block from another fork only if the backend still keeps it.
Load estimate: Medium; grows mainly with block transaction count and requested page.
Parameters
blockIdstringrequiredpathBlock height or block hash.
pageinteger>= 1query1-based page index. Values outside safe bounds are sanitized to the closest possible page.
Response
Block details.
Public API error.
Authorization
api-keyAuthapiKey in headerGet raw block hex.
Returns raw serialized block data.
Load estimate: High for large blocks; payload size grows with the raw block size.
Parameters
blockIdstringrequiredpathBlock height or block hash.
Response
Raw block data.
Public API error.
Authorization
api-keyAuthapiKey in headerGet compact block filters.
Returns compact block filters for the script type configured on this Blockbook instance. Provide either lastN or a from/to range. When to is omitted for a range, the current best height is used.
Load estimate: High for wide ranges; work and payload grow linearly with the number of requested filters.
Parameters
scriptTypestringrequiredqueryScript type configured for block filters on this instance, for example taproot.
lastNinteger>= 1queryReturn filters for the last N blocks.
frominteger>= 0queryFirst block height in the requested range.
tointeger>= 0queryLast block height in the requested range. Defaults to the current best height when omitted.
Response
Block filters keyed by block height.
Public API error.
Authorization
api-keyAuthapiKey in headerGet a normalized transaction.
Returns normalized transaction data with the same general structure for all supported coins. Coin-specific fields that do not fit the common shape are omitted here; use getTransactionSpecific for backend-native JSON.
Bitcoin-like confirmed transactions include blockHash, confirmations, blockTime, size/vsize, value/valueIn, fees, and hex. Unconfirmed transactions can include confirmationETABlocks and confirmationETASeconds.
Ethereum-like transactions have one vin and one vout, tokenTransfers, ethereumSpecific execution data, and optional addressAliases. Parsed input data is included when the 4byte signature can be resolved.
For mined transactions, blockTime is the block timestamp. For mempool transactions, blockTime is when this Blockbook instance first learned about the transaction and can differ between instances.
Load estimate: Medium; grows with inputs, outputs, token transfers, address aliases, and spending=true extra lookups.
Parameters
txidstringrequiredpathTransaction id/hash.
spendingbooleanqueryInclude spending transaction metadata for UTXO outputs when available.
Response
Normalized transaction.
Public API error.
Authorization
api-keyAuthapiKey in headerGet blockchain-specific transaction JSON.
Returns transaction data in the exact backend-specific format. Use this when a chain exposes fields that are intentionally absent from the normalized Tx schema.
Load estimate: Medium; payload size depends on chain-specific fields and transaction complexity.
Parameters
txidstringrequiredpathTransaction id/hash.
Response
Chain-specific transaction payload.
Public API error.
Authorization
api-keyAuthapiKey in headerGet raw transaction hex.
Unversioned public endpoint exposed by Blockbook for raw transaction data.
Load estimate: Medium; payload size grows with raw transaction size.
Parameters
txidstringrequiredpathTransaction id/hash.
Response
Raw transaction hex as a JSON string.
Public API error.
Authorization
api-keyAuthapiKey in headerBroadcast a raw transaction using the path.
Broadcasts hex-encoded raw transaction data. Prefer POST for large payloads.
Load estimate: High; validates and forwards to the backend, with cost growing with transaction size and backend mempool policy checks.
Parameters
hexstringrequiredpathRaw transaction.
Response
Broadcast result.
Public API error.
Authorization
api-keyAuthapiKey in headerBroadcast a raw transaction using the request body.
Broadcasts hex-encoded raw transaction data from the request body. The trailing slash is mandatory in the Blockbook handler. POST bodies are limited to 8 MiB.
Load estimate: High; validates and forwards to the backend, with cost growing with transaction size and backend mempool policy checks.
Body
Response
Broadcast result.
Public API error.
Authorization
api-keyAuthapiKey in headerGet address/account details.
Returns balances and transactions of an address. Transactions are sorted by block height with newest blocks first. Response size is controlled by the details parameter.
At details=basic, mempool transactions are not aggregated: unconfirmedBalance, unconfirmedSending, and unconfirmedReceiving are omitted, and unconfirmedTxs reports the raw mempool index size for the address.
Load estimate: Variable; basic is low, token/tokenBalances and txids/txslight are medium, and txs can be high as it grows with pageSize, transactions, token rows, filters, and protocol enrichment.
Parameters
addressstringrequiredpathChain address.
pageinteger>= 1query1-based page index. Values outside safe bounds are sanitized to the closest possible page.
pageSizeinteger[1, 1000]queryNumber of history items per page. The default and maximum for REST account endpoints is 1000.
frominteger>= 0queryFirst block height included in account transaction filtering.
tointeger>= 0queryLast block height included in account transaction filtering.
detailsstringbasictokenstokenBalancestxidstxslighttxstxidsqueryControls how much account data is returned. basic returns balances and counts only. tokens adds known token rows. tokenBalances returns token rows with balances. txids adds paged transaction ids. txslight adds limited transaction details from the index. txs adds full transaction details.
filterstring | integerqueryFilter account history by input/output side, or by numeric token/internal filter id.
contractstringqueryContract address used to filter token data.
protocolsArray<string>queryOptional protocol enrichments, comma-separated or repeated. Currently supported value: erc4626. Unknown values are rejected.
secondarystringquerySecondary currency code used to populate fiat values.
Response
Address/account details.
Public API error.
Authorization
api-keyAuthapiKey in headerGet account balance history.
Returns balance history points for an address, XPUB, or descriptor. from and to are Unix timestamps. groupBy is an aggregation interval in seconds and defaults to 3600. When fiatcurrency is omitted, rates can contain all available currencies. sentToSelf is the amount sent from an address to itself or within addresses of the same XPUB.
Load estimate: High; grows with account transaction history, time span, grouping cardinality, fiat rate lookups, and XPUB/descriptor gap.
Parameters
descriptorstringrequiredpathAddress, XPUB, or supported descriptor. URL-encode descriptors.
frominteger<int64>queryUnix timestamp lower bound.
tointeger<int64>queryUnix timestamp upper bound.
fiatcurrencystringqueryOptional fiat currency code to include in rates.
groupByinteger>= 1queryAggregation interval in seconds. Defaults to 3600.
gapinteger[0, 10000]queryXPUB/address derivation gap limit.
Response
Balance history points.
Public API error.
Authorization
api-keyAuthapiKey in headerGet contract metadata.
Returns indexed token/contract metadata and optional current protocol enrichments such as ERC4626.
blockHeight reflects the indexer's best block at request time. ERC4626 fields under protocols.erc4626 are fetched through JSON-RPC calls pinned to that exact blockHeight, so the ERC4626 values are a consistent snapshot. If a vault is detected but the underlying asset metadata cannot be resolved, protocols.erc4626 contains error and omits asset; callers must not derive fiat rates or human-unit exchange rates from such a partial response.
Load estimate: Medium; indexed metadata is cheap, but optional protocol enrichment can add backend RPC calls and token metadata lookups.
Parameters
contractstringrequiredpathSmart contract address.
currencystringquerySecondary currency code for rates.
protocolsArray<string>queryOptional protocol enrichments, comma-separated or repeated.
Response
Contract metadata.
Public API error.
Authorization
api-keyAuthapiKey in headerEstimate a fee target.
Returns backend fee estimation for the requested confirmation target.
Load estimate: Low; a small backend fee estimate lookup.
Parameters
blocksinteger>= 1requiredpathConfirmation target in blocks.
conservativebooleantruequeryUse conservative smart fee estimation where supported.
Response
Decimal fee estimate in chain base currency.
Public API error.
Authorization
api-keyAuthapiKey in headerGet fee statistics for a block.
Returns fee statistics for transactions in one block.
Load estimate: Medium to high; grows with the number of transactions in the requested block.
Parameters
blockIdstringrequiredpathBlock height or block hash.
Response
Fee statistics.
Public API error.
Authorization
api-keyAuthapiKey in headerGet current or historical fiat rates.
Returns currency rates for the requested currency and date. If a rate is unavailable for the exact timestamp, the closest available rate can be returned. Responses include the actual rate timestamp. Without a currency parameter, all available currencies can be returned. A rate of -1 marks an unavailable or invalid currency for that timestamp.
Load estimate: Low to medium; specific currency lookups are cheap, while omitted currency and token lookups increase response size.
Parameters
currencystringqueryOptional currency code. When omitted, all available rates can be returned.
timestampinteger<int64>queryUnix timestamp for historical rates.
blockstringqueryBlock height or hash whose timestamp should be used for historical rates.
tokenstringqueryOptional token symbol or contract/address key for token-specific rates.
Response
Fiat rate ticker.
Public API error.
Authorization
api-keyAuthapiKey in headerGet fiat rates for multiple timestamps.
Returns fiat rate tickers for a comma-separated list of Unix timestamps.
Load estimate: Medium; work and payload grow linearly with timestamp count, plus token/currency selection.
Parameters
timestampstringrequiredqueryComma-separated Unix timestamps.
currencystringqueryOptional currency code.
tokenstringqueryOptional token symbol or contract/address key.
Response
Fiat rate tickers.
Public API error.
Authorization
api-keyAuthapiKey in headerGet currencies available for a timestamp.
Returns available secondary currencies for a date together with the actual rate timestamp.
Load estimate: Low to medium; token lookups and wide currency lists increase response size.
Parameters
timestampinteger<int64>requiredqueryUnix timestamp for the requested currency list.
tokenstringqueryOptional token symbol or contract/address key.
Response
Available currencies.
Public API error.
Authorization
api-keyAuthapiKey in headerMAINNET / DEBUg
debug_getRawBlock
debug_getRawBlock
Returns an RLP-encoded block.
Body
jsonrpcstring2.02.0requiredmethodstringrequiredparamsArray<any>requiredidstring | integer | nullrequiredmethodstringdebug_getRawBlockdebug_getRawBlockparamsArray<string | integer>latestParameters
apiKeystringdocs-demorequiredpathResponse
Returns an RLP-encoded block.
Authorization
api-keyAuthapiKey in headerdebug_getRawHeader
debug_getRawHeader
Returns an RLP-encoded header.
Body
jsonrpcstring2.02.0requiredmethodstringrequiredparamsArray<any>requiredidstring | integer | nullrequiredmethodstringdebug_getRawHeaderdebug_getRawHeaderparamsArray<string | integer>latestParameters
apiKeystringdocs-demorequiredpathResponse
Returns an RLP-encoded header.
Authorization
api-keyAuthapiKey in headerdebug_getRawReceipts
debug_getRawReceipts
Returns an array of EIP-2718 binary-encoded receipts.
Body
jsonrpcstring2.02.0requiredmethodstringrequiredparamsArray<any>requiredidstring | integer | nullrequiredmethodstringdebug_getRawReceiptsdebug_getRawReceiptsparamsArray<string | integer>latestParameters
apiKeystringdocs-demorequiredpathResponse
Returns an array of EIP-2718 binary-encoded receipts.
Authorization
api-keyAuthapiKey in headerdebug_getRawTransaction
Debug method - debug_getRawTransaction
Returns an EIP-2718 binary-encoded transaction.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version
methodstringrequiredName of the method being called
paramsArray<string>requiredArray containing the transaction hash parameter.
idintegerrequiredA unique ID for the request
Response
The EIP-2718 binary-encoded transaction
Authorization
api-keyAuthapiKey in headerdebug_traceCall
debug_traceCall
Runs an eth_call within the context of the given block execution using the final state of parent block as the base.
Body
jsonrpcstring2.02.0requiredmethodstringrequiredparamsArray<any>requiredidstring | integer | nullrequiredmethodstringdebug_traceCalldebug_traceCallparamsArray<DebugCallObject | string | TraceConfig>[object Object],latest,[object Object]Parameters
apiKeystringdocs-demorequiredpathResponse
Returns - Array of block traces
Authorization
api-keyAuthapiKey in headerdebug_traceTransaction
debug_traceTransaction
Attempts to run the transaction in the exact same manner as it was executed on the network. It will replay any transaction that may have been executed prior to this one before it and will then attempt to execute the transaction that corresponds to the given hash.
Body
jsonrpcstring2.02.0requiredmethodstringrequiredparamsArray<any>requiredidstring | integer | nullrequiredmethodstringdebug_traceTransactiondebug_traceTransactionparamsArray<string | TraceConfig>0x0000000000000000000000000000000000000000000000000000000000000000,[object Object]Parameters
apiKeystringdocs-demorequiredpathResponse
Returns - transaction trace
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>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 header