BlockBook RES-API
v1.0.0https://ont.nownodes.ioAuthentication
api-keyAuthapiKeyAPI Key: api-key in header
MAINNET / Blockchain_RPCs
getbalancev2
Method to obtain ONT and ONG balances for a specific address.
Body
jsonrpcstring2.0requiredJSON-RPC protocol version. Must be exactly "2.0".
methodstringgetbalancev2requiredName of the RPC method to invoke.
For this API, the method getbalancev2 is documented.
paramsArray<string>Parameters for the method. For getbalancev2, this is an array containing a single string – the wallet address.
idintegerrequiredRequest identifier. The response will echo this value, allowing the client to correlate requests and responses.
Response
Successful response
Authorization
api-keyAuthapiKey in headergetbestblockhash
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.
Body
jsonrpcstring1.02.0requiredJSON-RPC protocol version.
methodstringgetblockstatsrequiredName of the RPC method.
paramsArray<integer>Parameters for the method. For getblockstats, this is an array containing a single value – either the block height (integer) or block hash (string).
idstringrequiredRequest identifier. The response will echo this value. Can be any string or number.
Response
Successful block statistics retrieval.
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 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 / RPC
getbalancev2
Method to obtain ONT and ONG balances for a specific address.
Body
jsonrpcstring2.0requiredJSON-RPC protocol version. Must be exactly "2.0".
methodstringgetbalancev2requiredName of the RPC method to invoke.
For this API, the method getbalancev2 is documented.
paramsArray<string>Parameters for the method. For getbalancev2, this is an array containing a single string – the wallet address.
idintegerrequiredRequest identifier. The response will echo this value, allowing the client to correlate requests and responses.
Response
Successful response
Authorization
api-keyAuthapiKey in headergetbestblockhash
Get Best Block Hash
Returns the hash of the best (most recent) block in the ONT blockchain. This method retrieves the hash of the block with the highest height in the current chain.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "getbestblockhash".
paramsarrayrequiredAn array of method parameters. This method takes no parameters, so an empty array is required.
idintegerrequiredA unique identifier for the request, used to correlate the response with the request. This can be any integer value chosen by the client.
Response
Successful response containing the hash of the best block.
Authorization
api-keyAuthapiKey in headergetblock
Get Block by Hash or Height
Retrieves information about a specific block from the ONT blockchain. The block can be identified by either its hash or its height (block number). The response can be returned in different verbosity levels (0, 1, or 2).
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "getblock".
paramsArray<string | integer | integer>requiredAn array containing two parameters:
- Block hash or height (string or integer)
- Verbosity level (0, 1, or 2) - determines the detail level of the response
idintegerrequiredA unique identifier for the request, used to correlate the response with the request.
Response
Successful response containing detailed block information.
Authorization
api-keyAuthapiKey in headergetblockcount
Get Block Count
Returns the total number of blocks in the ONT blockchain. This includes the genesis block, so the lowest possible value is 1. The block count is equivalent to the height of the best block plus one.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "getblockcount".
paramsarrayrequiredAn array of method parameters. This method takes no parameters, so an empty array is required.
idintegerrequiredA unique identifier for the request, used to correlate the response with the request.
Response
Successful response containing the total block count.
Authorization
api-keyAuthapiKey in headergetblockhash
Get Block Hash by Height
Retrieves the hash of a block at a specific height (block number). Block height starts at 0 for the genesis block and increments by 1 for each subsequent block.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "getblockhash".
paramsArray<integer>requiredAn array containing a single parameter: the block height (index). Block height is a zero-based integer index.
idintegerrequiredA unique identifier for the request, used to correlate the response with the request.
Response
Successful response containing the block hash.
Authorization
api-keyAuthapiKey in headergetrawtransaction
Get Raw Transaction
Returns detailed information about a specific transaction by its hash. The verbose parameter determines the format of the returned data.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the transaction hash and the verbose flag. The first element is the transaction hash string, the second element is the verbosity level (0 for raw hex data, 1 for JSON object).
idintegerThe request identifier used to match the response with the request.
Response
Successful response with transaction details.
Authorization
api-keyAuthapiKey in headersendrawtransaction
Send Raw Transaction
Broadcasts a signed raw transaction to the ONT blockchain network. The transaction must be properly formatted and signed before submission. The node will validate the transaction and relay it to other nodes in the network if valid.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "sendrawtransaction".
paramsArray<string | boolean>requiredAn array containing one or two parameters:
- The signed raw transaction in hexadecimal format (required)
- A boolean flag to prepend the transaction (optional, default is false)
idintegerrequiredA unique identifier for the request, used to correlate the response with the request.
Response
Successful response indicating the transaction was accepted and broadcast.
Authorization
api-keyAuthapiKey in headergetallowance
Get Approved Token Allowance (v1)
Returns the amount of native ONT or ONG tokens that an approved spender is allowed to transfer on behalf of the token owner. This is the legacy v1 endpoint, supporting only native network tokens.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getallowance" for this operation.
paramsArray<string>requiredArray with three parameters:
- Asset identifier ("ont" for Ontology token, "ong" for Ontology Gas token)
- Owner address (ONT address format)
- Spender address (ONT address format)
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with allowance amount.
Authorization
api-keyAuthapiKey in headergetallowancev2
Get Approved Token Allowance (v2)
Updated v2 endpoint that returns approved allowance amounts for all OEP-4 standard tokens, including native ONT/ONG and custom deployed tokens. Uses contract script hash instead of string asset identifiers to support arbitrary tokens.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getallowancev2" for this operation.
paramsArray<string>requiredArray with three parameters:
- Token contract script hash in hexadecimal format (use native hashes for ONT: 0x01..., ONG: 0x02...)
- Owner address (ONT address format)
- Spender address (ONT address format)
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with allowance amount.
Authorization
api-keyAuthapiKey in headergetbalance
Get Balance
Returns the ONT (Ontology) and ONG (Ontology Gas) balance for a specified account address. The ONG balance includes both available and unbound portions.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the Ontology account address to query.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with account balance information.
Authorization
api-keyAuthapiKey in headergetblockheightbytxhash
Get Block Height by Transaction Hash
Returns the block height at which a specific transaction was included. The transaction is identified by its unique hash.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the transaction hash to query.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with the block height.
Authorization
api-keyAuthapiKey in headergetblocktxsbyheight
Get Block Transactions List by Block Height
Returns a simplified list of all transaction IDs included in a block at the specified height. This endpoint does not return full transaction details or block header metadata, making it lightweight for iterating over block transaction lists.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getblocktxsbyheight" for this operation.
paramsArray<integer>requiredArray with one parameter: block height (integer, zero-based) to fetch transactions for.
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with list of transactions in the block.
Authorization
api-keyAuthapiKey in headergetconnectioncount
Get Connection Count
Returns the number of active peer connections currently connected to this ONT node. This includes both incoming and outgoing connections to other nodes in the network.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" for JSON-RPC 2.0 specification compliance.
methodstringrequiredThe RPC method name. For this operation, it must be "getconnectioncount".
paramsarrayrequiredAn array of method parameters. This method takes no parameters, so an empty array is required.
idintegerrequiredA unique identifier for the request, used to correlate the response with the request.
Response
Successful response containing the number of active connections.
Authorization
api-keyAuthapiKey in headergetcontractstate
Get Contract State
Returns detailed information about a deployed smart contract, including its code, author, and other metadata. The contract is identified by its script hash.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the contract script hash in hexadecimal format.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with contract state information.
Authorization
api-keyAuthapiKey in headergetgasprice
Get Gas Price
Returns the current gas price for executing smart contract operations on the Ontology blockchain. Gas price may vary based on network congestion.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An empty array of parameters for this method.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with the gas price.
Authorization
api-keyAuthapiKey in headergetgrantong
Get Grant ONG
Returns information about ONG that has been generated from ONT holdings and the amount that has been claimed. This helps track the ONG generation and claiming progress.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the Ontology account address to query.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with ONG grant information.
Authorization
api-keyAuthapiKey in headergetmempooltxcount
Get Count of Transactions in Mempool
Returns the total number of unconfirmed transactions currently held in the node's memory pool, split between transactions that have passed validation and those pending validation.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getmempooltxcount" for this operation.
paramsarrayrequiredArray of method parameters. This method accepts no parameters, so an empty array is required.
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with mempool transaction counts.
Authorization
api-keyAuthapiKey in headergetmempooltxstate
Get Transaction State in Mempool
Checks whether a specific transaction exists in the node's unconfirmed transaction pool (mempool) and returns its current processing state. Useful for tracking transaction status before confirmation.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getmempooltxstate" for this operation.
paramsArray<string>requiredArray with one parameter: transaction ID (hash) in hexadecimal format to check in mempool.
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with transaction state in mempool.
Authorization
api-keyAuthapiKey in headerTransaction Operations
Get Merkle Proof
Returns a Merkle proof that can be used to verify that a transaction was included in a specific block. This is useful for light clients and off-chain verification.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the transaction hash to generate the Merkle proof for.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with Merkle proof information.
Authorization
api-keyAuthapiKey in headergetnetworkid
Get Network ID
Returns the network identifier of the Ontology blockchain network. Different networks (mainnet, testnet) have different network IDs.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An empty array of parameters for this method.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with the network ID.
Authorization
api-keyAuthapiKey in headergetsmartcodeevent
Get Smart Contract Events by Transaction ID
Returns all smart contract events (notifications) emitted during the execution of a confirmed transaction. Events include log data, topics, and contract addresses for each event triggered by the transaction.
Body
jsonrpcstringrequiredThe JSON-RPC protocol version. Must be "2.0" per JSON-RPC 2.0 specification.
methodstringrequiredThe RPC method name. Must be "getsmartcodeevent" for this operation.
paramsArray<string>requiredArray with one parameter: transaction ID (hash) in hexadecimal format for which to fetch events.
idintegerrequiredUnique client-generated request ID to correlate responses with requests.
Response
Successful response with smart contract event data.
Authorization
api-keyAuthapiKey in headergetstorage
Get Storage
Returns the value stored at a specific key in a smart contract's storage. This method is commonly used to read state variables from deployed smart contracts on the Ontology blockchain.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the contract script hash, the storage key (both in hexadecimal format), and optionally the block height or hash to query.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with the stored value.
Authorization
api-keyAuthapiKey in headergetunboundong
Get Unbound ONG
Returns the amount of unbound ONG for a specified account address. ONG is generated through holding ONT and becomes available for withdrawal over time. Unbound ONG refers to the portion that has been generated but not yet withdrawn.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An array containing the Ontology account address to query.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with unbound ONG balance.
Authorization
api-keyAuthapiKey in headergetversion
Get Version
Returns the version information of the Ontology node. This method does not require any parameters.
Body
jsonrpcstringThe JSON-RPC protocol version. Always "2.0".
methodstringThe RPC method name to be invoked.
paramsArray<string>An empty array of parameters for this method.
idintegerThe request identifier used to match the response with the request.
Response
Successful response with version information.
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