Bitcoin Cash Node JSON-RPC commands

Blockchain

• finalizeblock"blockhash"
• getbestblockhash
• getblock"blockhash" ( verbosity patterns )
• getblockchaininfo
• getblockcount
• getblockhashheight
• getblockheader"hash_or_height" ( verbose )
• getblockstatshash_or_height ( stats )
• getchaintips
• getchaintxstats( nblocks "blockhash" )
• getdifficulty
• getdsproof"dspid_or_txid_or_outpoint" ( verbosity recursive )
• getdsprooflist( verbosity include_orphans )
• getdsproofscore"txid"
• getfinalizedblockhash
• getmempoolancestors"txid" ( verbose )
• getmempooldescendants"txid" ( verbose )
• getmempoolentry"txid"
• getmempoolinfo
• getrawmempool( verbose )
• gettxout"txid" n ( include_mempool patterns )
• gettxoutproof["txid",...] ( "blockhash" )
• gettxoutsetinfo( "hash_type" hash_or_height use_index )
• invalidateblock"blockhash"
• parkblock"blockhash"
• preciousblock"blockhash"
• pruneblockchainheight
• reconsiderblock"blockhash"
• savemempool
• scantxoutset"action" [scanobjects,...]
• unparkblock"blockhash"
• verifychain( checklevel nblocks )
• verifytxoutproof"proof"

Control

• getmemoryinfo( "mode" )
• getrpcinfo
• help( "command" )
• logging( ["include_category",...] ["exclude_category",...] )
• stop
• uptime

Generating

• generatenblocks ( maxtries )
• generatetoaddressnblocks "address" ( maxtries )

Mining

• getblocktemplate( "template_request" )
• getblocktemplatelight( "template_request" "additional_txs" )
• getmininginfo
• getnetworkhashps( nblocks height )
• prioritisetransaction"txid" ( dummy ) fee_delta
• submitblock"hexdata" ( "dummy" )
• submitblocklight"hexdata" "job_id"
• submitheader"hexdata"
• validateblocktemplate"hexdata"

Network

• addnode"node" "command"
• clearbanned( manual automatic )
• disconnectnode( "address" nodeid )
• getaddednodeinfo( "node" )
• getconnectioncount
• getexcessiveblock
• getnettotals
• getnetworkinfo
• getnodeaddresses( count )
• getpeerinfo
• listbanned
• ping
• setban"subnet" "command" ( bantime absolute )
• setnetworkactivestate

Rawtransactions

• combinepsbt["psbt",...]
• combinerawtransaction["hexstring",...]
• converttopsbt"hexstring" ( permitsigdata )
• createpsbt[{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"address":},{"data":"hex"},...] ( locktime )
• createrawtransaction[{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"address":},{"data":"hex"},...] ( locktime )
• decodepsbt"psbt"
• decoderawtransaction"hexstring"
• decodescript"hexstring"
• finalizepsbt"psbt" ( extract )
• fundrawtransaction"hexstring" ( options )
• getrawtransaction"txid" ( verbosity "blockhash" patterns )
• sendrawtransaction"hexstring" ( allowhighfees )
• signrawtransactionwithkey"hexstring" ["privatekey",...] ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","amount":amount,"tokenData":},...] "sighashtype" )
• testmempoolaccept["rawtx",...] ( allowhighfees )

Util

• createmultisignrequired ["key",...]
• estimatefee
• getindexinfo( "index_name" )
• signmessagewithprivkey"privkey" "message"
• validateaddress"address"
• verifymessage"address" "signature" "message"

Wallet

• abandontransaction"txid"
• abortrescan
• addmultisigaddressnrequired ["key",...] ( "label" )
• backupwallet"destination"
• createwallet"wallet_name" ( disable_private_keys blank "passphrase" )
• dumpprivkey"address"
• dumpwallet"filename"
• encryptwallet"passphrase"
• getaddressesbylabel"label"
• getaddressinfo"address"
• getbalance( "dummy" minconf include_watchonly )
• getnewaddress( "label" )
• getrawchangeaddress
• getreceivedbyaddress"address" ( minconf )
• getreceivedbylabel"label" ( minconf )
• gettransaction"txid" ( include_watchonly )
• getunconfirmedbalance
• getwalletinfo
• importaddress"address" ( "label" rescan p2sh )
• importmulti"requests" ( "options" )
• importprivkey"privkey" ( "label" rescan )
• importprunedfunds"rawtransaction" "txoutproof"
• importpubkey"pubkey" ( "label" rescan )
• importwallet"filename"
• keypoolrefill( newsize )
• listaddressgroupings
• listlabels( "purpose" )
• listlockunspent
• listreceivedbyaddress( minconf include_empty include_watchonly "address_filter" )
• listreceivedbylabel( minconf include_empty include_watchonly )
• listsinceblock( "blockhash" target_confirmations include_watchonly include_removed )
• listtransactions( "label" count skip include_watchonly )
• listunspent( minconf maxconf ["address",...] include_unsafe query_options )
• listwalletdir
• listwallets
• loadwallet"filename"
• lockunspentunlock ( [{"txid":"hex","vout":n},...] )
• removeprunedfunds"txid"
• rescanblockchain( start_height stop_height )
• sendmany"" {"address":amount} ( minconf "comment" ["address",...] coinsel include_unsafe )
• sendtoaddress"address" amount ( "comment" "comment_to" subtractfeefromamount coinsel include_unsafe )
• sethdseed( newkeypool "seed" )
• setlabel"address" "label"
• settxfeeamount
• signmessage"address" "message"
• signrawtransactionwithwallet"hexstring" ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","amount":amount,"tokenData":},...] "sighashtype" )
• unloadwallet( "wallet_name" )
• walletcreatefundedpsbt[{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount},{"address":},{"data":"hex"},...] ( locktime options bip32derivs )
• walletlock
• walletpassphrase"passphrase" timeout
• walletpassphrasechange"oldpassphrase" "newpassphrase"
• walletprocesspsbt"psbt" ( sign "sighashtype" bip32derivs )

Zmq

• getzmqnotifications

Bitcoin Cash Node Daemon version v29.1.1-6f20e6c

Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.