doc.rpc.nexa.org Open in urlscan Pro
2600:1901:0:7b8a::  Public Scan

Form analysis
2 forms found in the DOM

<form class="md-header__option" data-md-component="palette">
  <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
  <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"></path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette"
    id="__palette_1">
  <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path>
    </svg>
  </label>
  <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette"
    id="__palette_2">
  <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden="">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"></path>
    </svg>
  </label>
</form>

Name: search —

<form class="md-search__form" name="search">
  <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required="">
  <label class="md-search__icon md-icon" for="__search">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"></path>
    </svg>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
      <path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"></path>
    </svg>
  </label>
  <nav class="md-search__options" aria-label="Search">
    <a href="https://doc.rpc.nexa.org/?q=" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard="" data-clipboard-text="javascript:void(0)" data-md-component="search-share" tabindex="-1">

            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"></path></svg>
          </a>
    <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
        <path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"></path>
      </svg>
    </button>
  </nav>
  <div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>

Text Content

Skip to content

Nexa RPC API Documentation
Home

Type to start searching
GitLab
Nexa RPC API Documentation
GitLab
 * Home Home
   Table of contents
    * Nexa Remote Procedure Call (RPC) commands documentation
       * Blockchain
       * Control
       * Electrum
       * Generating
       * Mining
       * Network
       * Rawtransactions
       * Token
       * Util
       * Wallet
       * Zmq

 * Commands
   Commands
    * Abandontransaction
    * Addmultisigaddress
    * Addnode
    * Backupwallet
    * Capd
    * Clearbanned
    * Clearblockstats
    * Consolidate
    * Createmultisig
    * Createrawtransaction
    * Decoderawtransaction
    * Decodescript
    * Disconnectnode
    * Dumpprivkey
    * Dumptokenset
    * Dumputxoset
    * Dumpwallet
    * Encryptwallet
    * Enqueuerawtransaction
    * Estimatefee
    * Estimatesmartfee
    * Evicttransaction
    * Expedited
    * Fundrawtransaction
    * Generate
    * Generatetoaddress
    * Genesis
    * Get
    * Getaccount
    * Getaccountaddress
    * Getaddednodeinfo
    * Getaddressesbyaccount
    * Getaddressforms
    * Getbalance
    * Getbestblockhash
    * Getblock
    * Getblockchaininfo
    * Getblockcount
    * Getblockhash
    * Getblockheader
    * Getblockstats
    * Getblocktemplate
    * Getblockversion
    * Getchaintips
    * Getchaintxstats
    * Getconnectioncount
    * Getdifficulty
    * Getelectruminfo
    * Getinfo
    * Getminercomment
    * Getminingcandidate
    * Getmininginfo
    * Getminingmaxblock
    * Getnettotals
    * Getnetworkhashps
    * Getnetworkinfo
    * Getnewaddress
    * Getorphanpoolinfo
    * Getpeerinfo
    * Getrawblocktransactions
    * Getrawchangeaddress
    * Getraworphanpool
    * Getrawtransaction
    * Getrawtransactionssince
    * Getrawtxpool
    * Getreceivedbyaccount
    * Getreceivedbyaddress
    * Getstat
    * Getstatlist
    * Gettrafficshaping
    * Gettransaction
    * Gettxout
    * Gettxoutproof
    * Gettxoutproofs
    * Gettxoutsetinfo
    * Gettxpoolancestors
    * Gettxpooldescendants
    * Gettxpoolentry
    * Gettxpoolinfo
    * Getunconfirmedbalance
    * Getwalletinfo
    * Getzmqnotifications
    * Help
    * Importaddress
    * Importaddresses
    * Importprivatekeys
    * Importprivkey
    * Importprunedfunds
    * Importpubkey
    * Importwallet
    * Issuealert
    * Keypoolrefill
    * Listaccounts
    * Listactiveaddresses
    * Listaddressgroupings
    * Listbanned
    * Listlockunspent
    * Listreceivedbyaccount
    * Listreceivedbyaddress
    * Listsinceblock
    * Listtransactions
    * Listtransactionsfrom
    * Listunspent
    * Lockunspent
    * Log
    * Logline
    * Move
    * Ping
    * Prioritisetransaction
    * Pushtx
    * Removeprunedfunds
    * Savemsgpool
    * Saveorphanpool
    * Savetxpool
    * Scantokens
    * Sendfrom
    * Sendmany
    * Sendrawtransaction
    * Sendtoaddress
    * Set
    * Setaccount
    * Setban
    * Setblockversion
    * Setminercomment
    * Setminingmaxblock
    * Settrafficshaping
    * Signdata
    * Signmessage
    * Signrawtransaction
    * Stop
    * Submitblock
    * Submitminingsolution
    * Token
    * Uptime
    * Validateaddress
    * Validateblocktemplate
    * Validatechainhistory
    * Validaterawtransaction
    * Verifychain
    * Verifymessage
    * Verifytxoutproof

Table of contents
 * Nexa Remote Procedure Call (RPC) commands documentation
    * Blockchain
    * Control
    * Electrum
    * Generating
    * Mining
    * Network
    * Rawtransactions
    * Token
    * Util
    * Wallet
    * Zmq


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

Back to top
Made with Material for MkDocs