BlockBook RES-API
v1.0.0https://sys-btc.nownodes.iohttps://sys-evm.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
MAINNET / Blockchain_RPCs
getbestblockhash
getbestblockhash
Returns the hash of the best block in the most-work fully-validated chain. The best block is the tip of the blockchain, representing the most recent block that has been validated and added to the chain.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetbestblockhashrequiredparamsArray<any>requiredResponse
Valid response
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblock
getblock
Returns information about the block with the given block hash. Optional verbosity levels determine the level of detail in the response:
0: Returns a string that is serialized, hex-encoded data for the block.1: Returns a JSON object with basic block details and txids.2: Returns a JSON object with detailed transaction info.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockrequiredparamsArray<string | integer>requiredParameters:
blockhash(string) – The hash of the blockverbosity(integer, optional) – Level of detail: 0, 1, or 2
Response
Block information retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblockchaininfo
getblockchaininfo
Returns an object containing various state info regarding blockchain processing.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockchaininforequiredparamsArray<any>requiredResponse
Blockchain state information retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblockcount
getblockcount
Returns the number of blocks in the longest blockchain. This number increases as new blocks are added.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockcountrequiredparamsarrayrequiredThis method takes no parameters.
Response
Current block height retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblockhash
getblockhash
Returns the block hash of the block at the given height in the blockchain. You must provide a block height (0-based index).
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockhashrequiredparamsArray<integer>requiredParameters:
height(integer) — The height (index) of the block.
Response
Block hash successfully retrieved
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblockheader
getblockheader
Returns information about the block header given a block hash.
You can specify whether to return a JSON object or raw hex-encoded string using the verbose flag.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockheaderrequiredparamsArray<string | boolean>requiredParameters:
blockhash(string) — The hash of the block.verbose(boolean, optional) — If true, returns a JSON object; if false, returns a hex string. Default is true.
Response
Block header information retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetblockstats
getblockstats
Returns a variety of statistics about the block identified by its height or block hash. Available in Bitcoin Core v0.17.0 and later.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetblockstatsrequiredparamsArray<integer | string | Array<string>>requiredParameters:
height_or_hash(integer or string) — The block height (integer) or block hash (string).stats(array, optional) — Specific stats to return. If not specified, returns all.
Response
Block statistics returned successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetchaintips
getchaintips
Returns information about all known tips in the block tree, including the main chain as well as orphaned forks.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetchaintipsrequiredparamsarrayrequiredThis method takes no parameters.
Response
Chain tips retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetchaintxstats
getchaintxstats
Compute statistics about the total number and rate of transactions in the blockchain. You can optionally specify the number of blocks and a block hash to start from.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetchaintxstatsrequiredparamsArray<integer | string>requiredParameters:
nblocks(integer, optional) — Number of blocks to average over. Default: 1 month worth (~4320).blockhash(string, optional) — Hash of the block to stop at; defaults to the chain tip.
Response
Chain transaction statistics retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetdifficulty
getdifficulty
Returns the current difficulty as a multiple of the minimum difficulty (lowest possible difficulty on the network). This is a relative measure of how difficult it is to find a new block.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetdifficultyrequiredparamsarrayrequiredThis method takes no parameters.
Response
Difficulty value returned successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetmempoolancestors
getmempoolancestors
Returns all in-mempool ancestor transactions for a given transaction ID. An ancestor is a transaction whose outputs are used as inputs in another transaction. You can get a summary or detailed object output.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetmempoolancestorsrequiredparamsArray<string | boolean>requiredParameters:
txid(string, required) — Transaction ID to query.verbose(boolean, optional) — Whether to return a JSON object or just an array of txids. Default is false.
Response
Ancestor transaction(s) retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetmempooldescendants
getmempooldescendants
Returns all in-mempool descendant transactions for a given transaction ID. Descendants are transactions that depend on the outputs of the specified transaction. Can return either a simple list of transaction IDs or detailed JSON objects.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetmempooldescendantsrequiredparamsArray<string | boolean>requiredParameters:
txid(string, required) — Transaction ID to query descendants for.verbose(boolean, optional) — Return JSON object if true, or list of txids if false. Default: false.
Response
Descendant transactions retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetmempoolentry
getmempoolentry
Returns detailed information about a transaction currently in the mempool.
Requires the transaction ID (txid) as a parameter.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetmempoolentryrequiredparamsArray<string>requiredParameters:
txid(string, required) — Transaction ID to query.
Response
Mempool entry details retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetmempoolinfo
getmempoolinfo
Returns details about the current state of the mempool, including size, usage, fees, and more. No parameters required.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetmempoolinforequiredparamsArray<any>requiredNo parameters required
Response
Mempool info retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetnetworkinfo
getnetworkinfo
Returns various state info regarding P2P networking
Body
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringrequiredRPC method name
paramsArray<any>Method parameters (not required for getnetworkinfo)
Response
Successful response with network information
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetrawmempool
getrawmempool
Returns all transaction IDs currently in the mempool.
If verbose is true, returns a JSON object with detailed mempool entry information for each transaction.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetrawmempoolrequiredparamsArray<boolean>requiredParameters:
verbose(boolean, optional) — If true, return detailed JSON objects instead of txid array. Default: false.
Response
Mempool transactions retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergettxout
gettxout
Returns details about an unspent transaction output (UTXO) specified by transaction ID and output index.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgettxoutrequiredparamsArray<string | integer | boolean>requiredParameters:
txid(string, required) — The transaction ID.vout(integer, required) — The output index.include_mempool(boolean, optional, default: true) — Whether to include mempool transactions.
Response
UTXO details retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergettxoutproof
gettxoutproof
Returns a hex-encoded proof that one or more transactions are included in a block.
The proof can be validated with verifytxoutproof.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgettxoutproofrequiredparamsArray<Array<string> | string>requiredParameters:
txids(array[string], required) — Array of transaction IDs to prove inclusion.blockhash(string, optional) — Hash of the block to look for transactions. If omitted, searches the entire blockchain.
Response
Proof retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerpreciousblock
preciousblock
Marks a block as "precious," causing the node to reconsider the chain from that block. This can be used to manually reorganize the chain to a particular fork.
Body
jsonrpcstringrequiredidstringrequiredmethodstringpreciousblockrequiredparamsArray<string>requiredParameters:
blockhash(string, required) — The hash of the block to mark as precious.
Response
Block marked as precious successfully
Unauthorized
Internal 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>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 headerMAINNET / Mining_RPCs
getmininginfo
getmininginfo
Returns mining-related information such as current block, difficulty, network hash rate, etc. No parameters are required.
Body
jsonrpcstringrequiredJSON-RPC version (always "1.0")
idstringrequiredRequest identifier
methodstringgetmininginforequiredThe RPC method name
paramsarrayrequiredNo parameters required
Response
Mining info retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetnetworkhashps
getnetworkhashps
Returns the estimated network hashes per second (hash rate) based on the last nblocks blocks.
This provides an estimate of the total computational power securing the network.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version (always "1.0")
idstringrequiredThe identifier for the request
methodstringgetnetworkhashpsrequiredThe name of the RPC method
paramsArray<integer>requiredOptional parameters:
nblocks(integer) — The number of blocks to average over. Default is 120.height(integer) — Use the block at this height instead of the current tip. Use -1 for the tip.
Response
Hash rate retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerMAINNET / Rawtransactions_RPCs
createrawtransaction
createrawtransaction
Creates an unsigned raw transaction from a list of inputs and outputs. The transaction is returned as a serialized hex string, which can then be signed and broadcast.
Body
jsonrpcstringrequiredidstringrequiredmethodstringcreaterawtransactionrequiredparamsArray<Array<object> | object | integer | boolean>requiredParameters:
inputs(array) — List of transaction inputs, each includingtxidandvout.outputs(object) — Destination addresses and amounts.locktime(integer, optional) — Locktime value.replaceable(boolean, optional) — Whether this transaction signals BIP125 replaceability.
Response
Unsigned raw transaction created successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerdecoderawtransaction
decoderawtransaction
Decodes a raw hex-encoded Bitcoin transaction and returns a JSON object with readable fields. Useful for viewing the contents of raw transactions before broadcasting.
Body
jsonrpcstringrequiredidstringrequiredmethodstringdecoderawtransactionrequiredparamsArray<string>requiredParameters:
hexstring(string, required) — The raw transaction hex string.
Response
Transaction decoded successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerdecodescript
decodescript
Decodes a hex-encoded script (usually scriptPubKey) and returns a JSON representation including the script type and addresses. Useful for analyzing output scripts or creating Pay-to-Script-Hash addresses.
Body
jsonrpcstringrequiredJSON-RPC version
idstringrequiredRequest identifier
methodstringdecodescriptrequiredRPC method name
paramsArray<string>requiredParameters:
hexstring(string, required) — The script in hex format to decode.
Response
Script decoded successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headergetrawtransaction
getrawtransaction
Retrieves a raw transaction by its txid.
If verbose is false or omitted, the result is a raw hex string.
If verbose is true, returns a JSON object with decoded transaction details.
Body
jsonrpcstringrequiredidstringrequiredmethodstringgetrawtransactionrequiredparamsArray<string | boolean>requiredParameters:
txid(string, required) — The transaction ID.verbose(boolean, optional) — If true, return JSON; if false, return hex. Default: false.
Response
Transaction retrieved successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headersendrawtransaction
sendrawtransaction
Submits a raw transaction (hex-encoded string) to the mempool and broadcasts it to the network. Returns the transaction ID (txid) if accepted.
Body
jsonrpcstringrequiredidstringrequiredmethodstringsendrawtransactionrequiredparamsArray<string | number | boolean>requiredParameters:
hexstring(string, required): The raw transaction in hex format.maxfeerate(number or boolean, optional): Reject transactions with fees higher than this (BTC/KB). Usefalseto disable check.
Response
Transaction accepted and broadcasted
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headersignrawtransactionwithkey
signrawtransactionwithkey
Signs inputs for a raw transaction using explicitly provided private keys, without needing access to a local wallet. Useful for offline signing or stateless transaction construction.
Body
jsonrpcstringrequiredidstringrequiredmethodstringsignrawtransactionwithkeyrequiredparamsArray<string | Array<string> | Array<object>>requiredParameters:
hexstring(string, required): The raw transaction hex string.privkeys(array of strings, required): Array of WIF private keys.prevtxs(array, optional): Array of previous output details for inputs to sign.
Response
Transaction signed successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerMAINNET / Util_RPCs
signmessagewithprivkey
signmessagewithprivkey
Signs a message with the given private key (in WIF format). Returns the base64-encoded signature.
Body
jsonrpcstringrequiredidstringrequiredmethodstringsignmessagewithprivkeyrequiredparamsArray<string>requiredParameters:
privkey(string, required): The private key in WIF format.message(string, required): The message to sign.
Response
Message signed successfully
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headervalidateaddress
validateaddress
Validate a Bitcoin address and return useful information such as whether it is valid, script, or witness, and optionally if it's linked to the wallet.
Body
jsonrpcstringrequiredidstringrequiredmethodstringvalidateaddressrequiredparamsArray<string>requiredParameters:
address(string, required): The Bitcoin address to validate.
Response
Address validation result
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in headerverifymessage
verifymessage
Verify a message signature. Returns true if the signature is valid and corresponds to the provided address and message.
Body
jsonrpcstringrequiredidstringrequiredmethodstringverifymessagerequiredparamsArray<string>requiredParameters:
address(string, required): The Bitcoin address to verify.signature(string, required): The base64-encoded signature.message(string, required): The original signed message.
Response
Signature verification result
Unauthorized
Internal Server Error
Authorization
api-keyAuthapiKey in header