Home

Nexa Remote Procedure Call (RPC) commands documentation

Blockchain

• dumputxoset "filename"
• evicttransaction "txid"
• getbestblockhash
• getblock hash_or_height ( verbosity ) ( tx_count )
• getblockchaininfo
• getblockcount
• getblockhash index
• getblockheader hash_or_height ( verbose )
• getblockstats hash_or_height ( stats )
• getchaintips
• getchaintxstats ( nblocks blockhash )
• getdifficulty
• getorphanpoolinfo
• getraworphanpool
• getrawtxpool ( verbose ) (id or idem)
• getrawtxpool ( verbose ) ( id or idem)
• gettxout "txidem" n ( includetxpool )
• gettxoutproof "txid",...
• gettxoutproofs "txid",...
• gettxoutsetinfo
• gettxpoolancestors txid (verbose)
• gettxpooldescendants txid (verbose)
• gettxpoolentry txid
• gettxpoolinfo
• saveorphanpool
• savetxpool
• scantokens ( )
• verifychain ( checklevel numblocks )
• verifytxoutproof "proof"

Control

• getinfo
• help ( "command" )
• stop
• uptime

Electrum

• getelectruminfo

Generating

• generate numblocks ( maxtries )
• generatetoaddress numblocks address ( maxtries )

Mining

• genesis
• getblocktemplate ( "jsonrequestobject" )
• getblockversion
• getminercomment
• getminingcandidate
• getmininginfo
• getminingmaxblock
• getnetworkhashps ( blocks height )
• prioritisetransaction
• setblockversion blockVersionNumber
• setminercomment
• setminingmaxblock blocksize
• submitblock "hexdata" ( "jsonparametersobject" )
• submitminingsolution "Mining-Candidate data" ( "jsonparametersobject" )
• validateblocktemplate "hexdata"

Network

• addnode "node" "add|remove|onetry"
• capd
• clearbanned
• clearblockstats
• disconnectnode "node"
• expedited block|tx "node IP addr" on|off
• getaddednodeinfo dns ( "node" )
• getconnectioncount
• getnettotals
• getnetworkinfo
• getpeerinfo [peer IP address]
• gettrafficshaping
• listbanned
• ping
• pushtx "node"
• savemsgpool
• setban "ip(/netmask)" "add|remove" (bantime) (absolute)
• settrafficshaping "send|receive" "burstKB" "averageKB"

Rawtransactions

• createrawtransaction [{"outpoint":"id","amount":n},...] {"address":amount,"data":"hex",...} ( locktime )
• decoderawtransaction "hexstring"
• decodescript "hex"
• enqueuerawtransaction "hexstring" ( options )
• fundrawtransaction "hexstring" includeWatching
• getrawblocktransactions
• getrawtransaction "tx id, idem or outpoint" ( verbose "blockhash" )
• getrawtransactionssince
• sendrawtransaction "hexstring" ( allowhighfees, allownonstandard, verbose )
• signrawtransaction "hexstring" ( [{"outpoint":"hash","amount":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype sigtype )
• validaterawtransaction "hexstring" ( allowhighfees, allownonstandard )

Token

• dumptokenset

Util

• createmultisig nrequired ["key",...]
• estimatefee nblocks
• estimatesmartfee nblocks
• get
• getaddressforms "address"
• getstat
• getstatlist
• issuealert "alert"
• log "category|all" "on|off"
• logline 'string'
• set
• validateaddress "address"
• validatechainhistory [hash]
• verifymessage "address" "signature" "message"

Wallet

• abandontransaction "txid" or "txidem"
• addmultisigaddress nrequired ["key",...] ( "account" )
• backupwallet "destination"
• consolidate ("num" "toleave")
• dumpprivkey "nexaaddress"
• dumpwallet "filename"
• encryptwallet "passphrase"
• getaccount "address"
• getaccountaddress "account"
• getaddressesbyaccount "account"
• getbalance ( "account" minconf includeWatchonly )
• getnewaddress ("type" "account" )
• getrawchangeaddress
• getreceivedbyaccount "account" ( minconf )
• getreceivedbyaddress "address" ( minconf )
• gettransaction "txid or txidem" ( includeWatchonly )
• getunconfirmedbalance
• getwalletinfo
• importaddress "address" ( "label" rescan p2sh )
• importaddresses [rescan | no-rescan] "address"...
• importprivatekeys [rescan | no-rescan] "nexaprivatekey"...
• importprivkey "nexaprivkey" ( "label" rescan )
• importprunedfunds
• importpubkey "pubkey" ( "label" rescan )
• importwallet "filename"
• keypoolrefill ( newsize )
• listaccounts ( minconf includeWatchonly)
• listactiveaddresses
• listaddressgroupings
• listlockunspent
• listreceivedbyaccount ( minconf includeempty includeWatchonly)
• listreceivedbyaddress ( minconf includeempty includeWatchonly)
• listsinceblock ( "blockhash" target-confirmations includeWatchonly)
• listtransactions ( "account" count from includeWatchonly)
• listtransactionsfrom ( "account" count from includeWatchonly)
• listunspent ( minconf maxconf ["address",...] )
• lockunspent unlock [{"txidem":"txidem","vout":n},...]
• move "fromaccount" "toaccount" amount ( minconf "comment" )
• removeprunedfunds "txidem"
• sendfrom "fromaccount" "toaddress" amount ( minconf "comment" "comment-to" )
• sendmany "fromaccount" {"address":amount,...} ( minconf "comment" ["address",...] )
• sendtoaddress "address" amount ( "comment" "comment-to" subtractfeefromamount )
• setaccount "address" "account"
• signdata "address" "msgFormat" "message"
• signmessage "address" "message"
• token [info, new, mint, melt, balance, send, authority, tracker, subgroup, mintage]

Zmq

• getzmqnotifications