PAI Client RPC

Commands and Information for interacting with the PAI client RPC interface.

Abandon Transaction

The abandontransaction RPC marks an in-wallet transaction and all its in-wallet descendants as ab...

Add Multi Sig Address

Requires wallet support. The addmultisigaddress RPC adds a P2SH multisig address to the wallet. ...

Add Node

The addnode RPC attempts to add or remove a node from the addnode list, or to try a connection to...

Add Witness Address

Add Witness Address Requires wallet support. Requires an unlocked wallet or an unencrypted walle...

Backup Wallet

Requires wallet support. The backupwallet RPC safely copies wallet.dat to the specified file, wh...

Bump Free

Requires wallet support. Wallet must be unlocked. The bumpfee RPC The increased fee is deducted...

Clear Banned

The clearbanned RPC clears list of banned nodes. Parameters: none Result—null on success ...

Create Multi Sig

The createmultisig RPC creates a P2SH multi-signature address. Parameter #1—the number of signat...

Create Raw Transaction

The createrawtransaction RPC creates an unsigned serialized transaction that spends a previous ou...

Decode Raw Transaction

The decoderawtransaction RPC decodes a serialized transaction hex string into a JSON object descr...

Decode Script

The decodescript RPC Parameter #1—a hex-encoded redeem script Name Type ...

Disconnect Node

The disconnectnode RPC immediately disconnects from a specified node. Parameter #1—hostname/IP a...

Dump Priv Key

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The dumpprivkey R...

Dump Wallet

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The dumpwallet R...

Encrypt Wallet

Requires wallet support. The encryptwallet RPC encrypts the wallet with a passphrase. This is on...

Estimate Fee

The estimatefee RPC estimates the transaction fee per kilobyte that needs to be paid for a transa...

Estimate Priority

The estimatepriority RPC estimates the priority (coin age) that a transaction needs in order to b...

Fund Raw Transaction

Requires wallet support. The fundrawtransaction RPC adds inputs to a transaction until it has en...

Generate

Requires wallet support. The generate RPC nearly instantly generates PAIs. Parameter #1—the num...

Generate to Address

Requires wallet support. The generatetoaddress RPC mines blocks immediately to a specified addre...

Get Account

Requires wallet support. The getaccount RPC returns the name of the account associated with the ...

Get Account Address

Requires wallet support. The getaccountaddress RPC returns the current pai address for receiving...

Get Added Node Info

The getaddednodeinfo RPC returns information about the given added node, or all added nodes (exce...

Get Addresses by Account

Requires wallet support. The getaddressesbyaccount RPC returns a list of every address assigned ...

Get Balance

Requires wallet support. The getbalance RPC gets the balance in decimal pais across all accounts...

Get Best Block Hash

The getbestblockhash RPC returns the header hash of the most recent block on the best block chain...

Get Best Block Hash

The getblock RPC gets a block with a particular header hash from the local block database either ...

Get Block Chain Info

The getblockchaininfo RPC provides information about the current state of the block chain. Param...

Get Block Count

The getblockcount RPC returns the number of blocks in the local best block chain. Parameters: no...

Get Block Hash

The getblockhash RPC returns the header hash of a block at the given height in the local best blo...

Get Block Header

The getblockheader RPC gets a block header with a particular header hash from the local block dat...

Get Block Template

The getblocktemplate RPC gets a block template or proposal for use with mining software. For more...

Get Chain Tips

The getchaintips RPC returns information about the highest-height block (tip) of each local block...

Get Connection Count

The getconnectioncount RPC returns the number of connections to other nodes. Parameters: none R...

Get Difficulty

The getdifficulty RPC Parameters: none Result—the current difficulty Name ...

Get Generate

Requires wallet support. See also Generate: nearly instantly generates blocks. GenerateToA...

Get Hashes per Sec

Requires wallet support. See also Generate: nearly instantly generates blocks. GetMiningIn...

GetInfo

The getinfo RPC prints various information about the node and the network. Parameters: none Res...

GetMemPoolAncestors

The getmempoolancestors RPC returns all in-mempool ancestors for a transaction in the mempool. P...

GetMemPoolDescendants

The getmempooldescendants RPC returns all in-mempool descendants for a transaction in the mempool...

GetMemPoolEntry

The getmempoolentry RPC returns mempool data for given transaction (must be in mempool). Paramet...

GetMemPoolInfo

The getmempoolinfo RPC returns information about the node’s current transaction memory pool. Par...

GetMemoryInfo

The getmemoryinfo RPC returns information about memory usage. Parameters: none Result—informati...

GetMiningInfo

The getmininginfo RPC returns various mining-related information. Parameters: none Result—vario...

GetNetTotals

The getnettotals RPC returns information about network traffic, including bytes in, bytes out, an...

GetNetworkHashPS

The getnetworkhashps RPC returns the estimated current or historical network hashes per second ba...

GetNetworkInfo

The getnetworkinfo RPC returns information about the node’s connection to the network. Parameter...

GetNewAddress

GetNewAddress Requires wallet support. The getnewaddress RPC returns a new Pai address for rece...

GetPeerInfo

The getpeerinfo RPC returns data about each connected network node. Parameters: none Result—inf...

GetRawChangeAddress

Requires wallet support. The getrawchangeaddress RPC returns a new Pai address for receiving cha...

GetRawMemPool

The getrawmempool RPC returns all transaction identifiers (TXIDs) in the memory pool as a JSON ar...

GetRawTransaction

The getrawtransaction RPC gets a hex-encoded serialized transaction or a JSON object describing t...

GetReceivedByAccount

Requires wallet support. The getreceivedbyaccount RPC returns the total amount received by addre...

GetReceivedByAddress

GetReceivedByAddress Requires wallet support. The getreceivedbyaddress RPC returns the total am...

GetTransaction

Requires wallet support. The gettransaction RPC gets detailed information about an in-wallet tra...

GetTxOut

The gettxout RPC returns details about an unspent transaction output (UTXO). Parameter #1—the TX...

GetTxOutProof

The gettxoutproof RPC returns a hex-encoded proof that one or more specified transactions were in...

GetTxOutSetInfo

The gettxoutsetinfo RPC returns statistics about the confirmed unspent transaction output (UTXO) ...

GetUnconfirmedBalance

Requires wallet support. The getunconfirmedbalance RPC returns the wallet’s total unconfirmed ba...

GetWalletInfo

Parameters: none Result—information about the wallet Name Type Prese...

GetWork

See also GetBlockTemplate: gets a block template or proposal for use with mining software. ...

Hash Byte Order

HASH BYTE ORDER PAI Core RPCs accept and return the byte-wise reverse of computed SHA-256 hash v...

Help

The help RPC lists all available public RPC commands, or gets help for the specified RPC. Command...

ImportAddress

Requires wallet support. The importaddress RPC adds an address or pubkey script to the wallet wi...

ImportMulti

Requires wallet support. Wallet must be unlocked. The importmulti RPC imports addresses or scri...

ImportPrivKey

Requires wallet support. Wallet must be unlocked. The importprivkey RPC adds a private key to y...

ImportPrunedFunds

Requires wallet support. The importprunedfunds RPC imports funds without the need of a rescan. M...

ImportWallet

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The importwallet ...

KeyPoolRefill

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The keypoolrefil...

ListAccounts

Requires wallet support. The listaccounts RPC lists accounts and their balances. listaccounts w...

ListAddressGrouping

Requires wallet support. The listaddressgroupings RPC lists groups of addresses that may have ha...

ListBanned

The listbanned RPC lists all banned IPs/Subnets. Parameters: none Result—information about each...

ListLockUnspent

Requires wallet support. The listlockunspent RPC returns a list of temporarily unspendable (lock...

ListReceivedByAccount

Requires wallet support. The listreceivedbyaccount RPC lists the total number of pai’s received ...

ListReceivedByAddress

Requires wallet support. The listreceivedbyaddress RPC lists the total number of pai’s received ...

ListSinceBlock

Requires wallet support. The listsinceblock RPC gets all transactions affecting the wallet which...

ListTransactions

Requires wallet support. The listtransactions RPC returns the most recent transactions that affe...

ListUnspent

Requires wallet support. The listunspent RPC returns an array of unspent transaction outputs bel...

LockUnspent

Requires wallet support. The lockunspent RPC temporarily locks or unlocks specified transaction ...

Move

Requires wallet support. The move RPC moves a specified amount from one account in your wallet t...

Ping

The ping RPC sends a P2P ping message to all connected nodes to measure ping time. Results are pr...

PreciousBlock

The preciousblock RPC treats a block as if it were received before others with the same work. A l...

PrioritiseTransaction

The prioritisetransaction RPC adds virtual priority or fee to a transaction, allowing it to be ac...

PruneBlockChain

The pruneblockchain RPC prunes the blockchain up to a specified height or timestamp. The -prune o...

Quick Reference

PAI RPCs GetBestBlockHash: returns the header hash of the most recent block on the best ...

Remote Procedure Calls (RPCs)

PAI Core provides a remote procedure call (RPC) interface for various administrative tasks, walle...

RemovePrunedFunds

The removeprunedfunds RPC deletes the specified transaction from the wallet. Meant for use with p...

RPCs

The block chain and memory pool can include arbitrary data which several of the commands below wi...

SendFrom

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The sendfrom RPC ...

SendMany

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The sendmany RPC ...

SendRawTransaction

The sendrawtransaction RPC validates a transaction and broadcasts it to the peer-to-peer network....

SendToAddress

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The sendtoaddress...

SetAccount

Requires wallet support. The setaccount RPC puts the specified address in the given account. se...

SetBan

The setban RPC attempts add or remove a IP/Subnet from the banned list. Parameter #1—IP/Subnet o...

SetGenerate

Requires wallet support. See also Generate: nearly instantly generates blocks. GenerateToA...

SetNetworkActive

Added The setnetworkactive RPC disables/enables all P2P network activity. Parameter #1—whether ...

SetTxFee

Requires wallet support. The settxfee RPC sets the transaction fee per kilobyte paid by transact...

SignMessage

Requires wallet support. Requires an unlocked wallet or an unencrypted wallet. The signmessage R...

SignMessageWithPrivKey

The signmessagewithprivkey RPC signs a message with a given private key. Parameter #1—the privat...

SignRawTransaction

The signrawtransaction RPC signs a transaction in the serialized transaction format using private...

Stop

The stop RPC safely shuts down the Pai Core server. Parameters: none Result—the server is safel...

SubmitBlock

The submitblock RPC accepts a block, verifies it is a valid addition to the block chain, and broa...

ValidateAddress

The validateaddress RPC returns information about the given Pai address. Parameter #1—a P2PKH or...

VerifyChain

The verifychain RPC verifies each entry in the local block chain database. Parameter #1—how thor...

VerifyMessage

The verifymessage RPC verifies a signed message. Parameter #1—the address corresponding to the s...

VerifyTxOutProof

The verifytxoutproof RPC verifies that a proof points to one or more transactions in a block, ret...

WalletLock

Requires wallet support. Requires an unlocked wallet. The walletlock RPC removes the wallet encr...

WalletPasshraseChange

Requires wallet support. Requires an encrypted wallet. The walletpassphrasechange RPC changes t...

WalletPasshrase

Requires wallet support. Requires an encrypted wallet. The walletpassphrase RPC stores the walle...