pivx-cli

pivx-cli

PIVX Core RPC client version v5.4.0

Usage:  pivx-cli [options] <command> [params]  Send command to PIVX Core
or:     pivx-cli [options] -named <command> [name=value]... Send command to PIVX Core (with named arguments)
or:     pivx-cli [options] help                List commands
or:     pivx-cli [options] help <command>      Get help for a command

Options:

  -?
       This help message

  -conf=<file>
       Specify configuration file (default: pivx.conf)

  -datadir=<dir>
       Specify data directory

Chain selection options:

  -testnet
       Use the test chain

  -regtest
       Enter regression test mode, which uses a special chain in which blocks
       can be solved instantly. This is intended for regression testing tools
       and app development.

  -named
       Pass named instead of positional arguments (default: false)

  -rpcconnect=<ip>
       Send commands to node running on <ip> (default: 127.0.0.1)

  -rpcport=<port>
       Listen for JSON-RPC connections on <port> (default: 51473 or testnet:
       51475)

  -rpcwait
       Wait for RPC server to start

  -rpcuser=<user>
       Username for JSON-RPC connections

  -rpcpassword=<pw>
       Password for JSON-RPC connections

  -rpcclienttimeout=<n>
       Timeout in seconds during HTTP requests, or 0 for no timeout. (default:
       900)

  -rpcwallet=<walletname>
       Send RPC for non-default wallet on RPC server (needs to exactly match
       corresponding -wallet option passed to pivxd)



pivx-cli [options] <command> [params]
>>>

#### Blockchain ==
getbestblockhash
getbestsaplinganchor
getblock "blockhash" ( verbose )
getblockchaininfo
getblockcount
getblockhash height
getblockheader "blockhash" ( verbose )
getblockindexstats height range
getchaintips
getdifficulty
getfeeinfo blocks
getmempoolinfo
getrawmempool ( verbose )
getsupplyinfo ( force_update )
gettxout "txid" n ( include_mempool )
gettxoutsetinfo
verifychain ( nblocks )

#### Budget ==
checkbudgets
getbudgetinfo ( "name" )
getbudgetprojection
getbudgetvotes "name"
getnextsuperblock
mnbudgetrawvote "collat_txid" collat_vout "hash" votecast time "sig"
mnbudgetvote "local|many|alias" "hash" "yes|no" ( "alias" legacy )
mnfinalbudget "command"... ( "passphrase" )
preparebudget "name" "url" npayments start "address" monthly_payment
submitbudget "name" "url" npayments start "address" monthly_payment "fee_txid"

#### Control ==
getinfo
getmemoryinfo
help ( "command" )
mnsync "status|reset"
spork "name" ( value )
stop

#### Masternode ==
createmasternodebroadcast "command" ( "alias")
createmasternodekey
decodemasternodebroadcast "hexstring"
getmasternodecount
getmasternodeoutputs
getmasternodescores ( blocks )
getmasternodestatus
getmasternodewinners ( blocks "filter" )
initmasternode ( "privkey" "address" deterministic )
listmasternodeconf ( "filter" )
listmasternodes ( "filter" )
masternodecurrent
relaymasternodebroadcast "hexstring"
startmasternode "local|all|many|missing|disabled|alias" lockwallet ( "alias" reload_conf )

#### Mining ==
prioritisetransaction "txid" priority_delta fee_delta

#### Network ==
addnode "node" "add|remove|onetry"
clearbanned
disconnectnode "node" 
getaddednodeinfo dummy ( "node" )
getconnectioncount
getnettotals
getnetworkinfo
getnodeaddresses ( count "network" )
getpeerinfo
listbanned
ping
setban "subnet" "add|remove" ( bantime absolute )

#### Rawtransactions ==
createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,...} ( locktime )
decoderawtransaction "hexstring"
decodescript "hexstring"
getrawtransaction "txid" ( verbose "blockhash" )
sendrawtransaction "hexstring" ( allowhighfees )
signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )

#### Util ==
createmultisig nrequired ["key",...]
estimatefee nblocks
estimatesmartfee nblocks
logging [include,...] ( [exclude,...] )
validateaddress "pivxaddress"
verifymessage "pivxaddress" "signature" "message"

#### Wallet ==
abandontransaction "txid"
abortrescan
addmultisigaddress nrequired ["key",...] ( "label" )
autocombinerewards (Deprecated, will be removed in v6.0. To use this command, start pivxd with -deprecatedrpc=autocombinerewards)
backupwallet "destination"
bip38decrypt "encrypted_key" "passphrase"
bip38encrypt "address" "passphrase"
delegatestake "staking_addr" amount ( "owner_addr" ext_owner include_delegated from_shield force )
delegatoradd "address" ( "label" )
delegatorremove "address"
dumpprivkey "address"
dumpwallet "filename"
encryptwallet "passphrase"
exportsaplingkey "shield_addr"
exportsaplingviewingkey "shield_addr"
fundrawtransaction "hexstring" ( options )
getaddressesbylabel "label"
getaddressinfo ( "address" )
getautocombinethreshold
getbalance ( minconf include_watchonly include_delegated include_shield )
getcoldstakingbalance
getdelegatedbalance
getnewaddress ( "label" )
getnewshieldaddress ( "label" )
getnewstakingaddress ( "label" )
getrawchangeaddress
getreceivedbyaddress "address" ( minconf )
getreceivedbylabel "label" ( minconf )
getsaplingnotescount ( minconf )
getshieldbalance "address" ( minconf include_watchonly )
getstakesplitthreshold
getstakingstatus
gettransaction "txid" ( include_watchonly )
getunconfirmedbalance
getwalletinfo
importaddress "script" ( "label" rescan )
importmulti "requests" ( "options" )
importprivkey "privkey" ( "label" rescan is_staking_address )
importpubkey "pubkey" ( "label" rescan )
importsaplingkey "key" ( rescan height )
importsaplingviewingkey "vkey" ( rescan height )
importwallet "filename"
keypoolrefill ( newsize )
listaddressgroupings
listcoldutxos ( not_whitelisted )
listdelegators ( blacklist )
listlabels ( "purpose" )
listlockunspent
listreceivedbyaddress ( minconf include_empty include_watchonly filter)
listreceivedbylabel ( minconf include_empty include_watchonly)
listreceivedbyshieldaddress "address" ( minconf )
listshieldaddresses ( include_watchonly )
listshieldunspent ( minconf maxconf include_watchonly ["shield_addr",...] )
listsinceblock ( "blockhash" target_confirmations include_watchonly)
liststakingaddresses
listtransactions ( "dummy" count from include_watchonly include_delegated include_cold)
listunspent ( minconf maxconf  ["address",...] watchonly_config [query_options] include_unsafe)
listwallets
lockunspent unlock [{"txid":"txid","vout":n},...]
rawdelegatestake "staking_addr" amount ( "owner_addr" ext_owner include_delegated from_shield )
rawshieldsendmany "fromaddress" [{"address":... ,"amount":...},...] ( minconf fee )
rescanblockchain (start_height) (stop_height)
sendmany "" {"address":amount,...} ( minconf "comment" include_delegated )
sendtoaddress "address" amount ( "comment" "comment-to" subtract_fee )
setautocombinethreshold enable ( value )
sethdseed ( newkeypool "seed" )
setlabel "address" "label"
setstakesplitthreshold value
settxfee amount
shieldsendmany "fromaddress" [{"address":... ,"amount":...},...] ( minconf fee subtract_fee_from )
signmessage "address" "message"
upgradewallet
viewshieldtransaction "txid"
walletlock
walletpassphrase "passphrase" timeout ( staking_only )
walletpassphrasechange "oldpassphrase" "newpassphrase"