Skip to content

Latest commit

 

History

History
202 lines (175 loc) · 2.96 KB

index.rst

File metadata and controls

202 lines (175 loc) · 2.96 KB

RPC API Reference

Blockchain RPCs

.. toctree::
  :maxdepth: 1

  getbestblockhash
  getblock
  getblockchaininfo
  getblockcount
  getblockfilter
  getblockhash
  getblockheader
  getblockstats
  getchaintips
  getchaintxstats
  getdifficulty
  getmempoolancestors
  getmempooldescendants
  getmempoolentry
  getmempoolinfo
  getrawmempool
  gettxout
  gettxoutproof
  gettxoutsetinfo
  preciousblock
  pruneblockchain
  savemempool
  scantxoutset
  verifychain
  verifytxoutproof

Control RPCs

.. toctree::
  :maxdepth: 1

  getmemoryinfo
  getrpcinfo
  help
  logging
  stop
  uptime

Generating RPCs

.. toctree::
  :maxdepth: 1

  generateblock
  generatetoaddress
  generatetodescriptor

Mining RPCs

.. toctree::
  :maxdepth: 1

  getblocktemplate
  getmininginfo
  getnetworkhashps
  prioritisetransaction
  submitblock
  submitheader

Network RPCs

.. toctree::
  :maxdepth: 1

  addnode
  clearbanned
  disconnectnode
  getaddednodeinfo
  getconnectioncount
  getnettotals
  getnetworkinfo
  getnodeaddresses
  getpeerinfo
  listbanned
  ping
  setban
  setnetworkactive

Rawtransactions RPCs

.. toctree::
  :maxdepth: 1

  analyzepsbt
  combinepsbt
  combinerawtransaction
  converttopsbt
  createpsbt
  createrawtransaction
  decodepsbt
  decoderawtransaction
  decodescript
  finalizepsbt
  fundrawtransaction
  getrawtransaction
  joinpsbts
  sendrawtransaction
  signrawtransactionwithkey
  testmempoolaccept
  utxoupdatepsbt

Util RPCs

.. toctree::
  :maxdepth: 1

  createmultisig
  deriveaddresses
  estimatesmartfee
  getdescriptorinfo
  getindexinfo
  signmessagewithprivkey
  validateaddress
  verifymessage

Wallet RPCs

Note: the wallet RPCs are only available if Bitcoin Core was built with wallet support, which is the default.

.. toctree::
  :maxdepth: 1

  abandontransaction
  abortrescan
  addmultisigaddress
  backupwallet
  bumpfee
  createwallet
  dumpprivkey
  dumpwallet
  encryptwallet
  getaddressesbylabel
  getaddressinfo
  getbalance
  getbalances
  getnewaddress
  getrawchangeaddress
  getreceivedbyaddress
  getreceivedbylabel
  gettransaction
  getunconfirmedbalance
  getwalletinfo
  importaddress
  importdescriptors
  importmulti
  importprivkey
  importprunedfunds
  importpubkey
  importwallet
  keypoolrefill
  listaddressgroupings
  listlabels
  listlockunspent
  listreceivedbyaddress
  listreceivedbylabel
  listsinceblock
  listtransactions
  listunspent
  listwalletdir
  listwallets
  loadwallet
  lockunspent
  psbtbumpfee
  removeprunedfunds
  rescanblockchain
  send
  sendmany
  sendtoaddress
  sethdseed
  setlabel
  settxfee
  setwalletflag
  signmessage
  signrawtransactionwithwallet
  unloadwallet
  upgradewallet
  walletcreatefundedpsbt
  walletlock
  walletpassphrase
  walletpassphrasechange
  walletprocesspsbt