Skip to content

RPC Commands Reference ​

Complete reference for all Cloud Service JSON-RPC commands.

Blockchain Commands ​

getblockchaininfo ​

Returns information about the blockchain state.

bash
cs-cli getblockchaininfo

Response:

json
{
    "chain": "main",
    "blocks": 524288,
    "headers": 524288,
    "bestblockhash": "0000...",
    "difficulty": 12345678.90,
    "mediantime": 1234567890,
    "verificationprogress": 0.999999,
    "pruned": false,
    "chainwork": "0000..."
}

getblockhash ​

Returns hash of block at given index.

bash
cs-cli getblockhash 1000

getblock ​

Returns block information given block hash.

bash
cs-cli getblock "blockhash"
cs-cli getblock "blockhash" 2  # Verbosity level 2

getbestblockhash ​

Returns hash of the best block in the longest chain.

bash
cs-cli getbestblockhash

getblockcount ​

Returns the number of blocks in the longest chain.

bash
cs-cli getblockcount

getdifficulty ​

Returns the current proof-of-work difficulty.

bash
cs-cli getdifficulty

getrawmempool ​

Returns all transaction ids in memory pool.

bash
cs-cli getrawmempool
cs-cli getrawmempool true  # With details

getmempoolinfo ​

Returns information about the memory pool.

bash
cs-cli getmempoolinfo

Transaction Commands ​

getrawtransaction ​

Returns raw transaction data.

bash
cs-cli getrawtransaction "txid"
cs-cli getrawtransaction "txid" true  # Decoded

decoderawtransaction ​

Returns decoded transaction from raw hex.

bash
cs-cli decoderawtransaction "hexstring"

sendrawtransaction ​

Submits raw transaction to network.

bash
cs-cli sendrawtransaction "hexstring"

gettransaction ​

Returns transaction details.

bash
cs-cli gettransaction "txid"

listtransactions ​

Returns recent transactions.

bash
cs-cli listtransactions
cs-cli listtransactions "*" 10 0  # Account, count, skip

Wallet Commands ​

getbalance ​

Returns wallet balance.

bash
cs-cli getbalance
cs-cli getbalance "*" 6  # Min confirmations

getnewaddress ​

Returns new address for receiving.

bash
cs-cli getnewaddress
cs-cli getnewaddress "label"  # With label

getaddressinfo ​

Returns address information.

bash
cs-cli getaddressinfo "address"

sendtoaddress ​

Sends CS to an address.

bash
cs-cli sendtoaddress "address" amount
cs-cli sendtoaddress "address" 10.5 "comment" "subtractfeefromamount"

listreceivedbyaddress ​

Returns received transactions by address.

bash
cs-cli listreceivedbyaddress
cs-cli listreceivedbyaddress 6 true  # Min confirmations, include empty

listunspent ​

Returns unspent transaction outputs.

bash
cs-cli listunspent
cs-cli listunspent 6 9999999 ["address"]  # Min/max confirmations, addresses

encryptwallet ​

Encrypts wallet with passphrase.

bash
cs-cli encryptwallet "passphrase"

walletpassphrase ​

Unlocks encrypted wallet.

bash
cs-cli walletpassphrase "passphrase" timeout

walletlock ​

Locks encrypted wallet.

bash
cs-cli walletlock

backupwallet ​

Backs up wallet to specified path.

bash
cs-cli backupwallet "/path/backup.dat"

importprivkey ​

Imports private key.

bash
cs-cli importprivkey "privkey"
cs-cli importprivkey "privkey" "label" false  # Label, rescan

dumpprivkey ​

Returns private key for address.

bash
cs-cli dumpprivkey "address"

Mining Commands ​

getmininginfo ​

Returns mining information.

bash
cs-cli getmininginfo

getnetworkhashps ​

Returns estimated network hash rate.

bash
cs-cli getnetworkhashps
cs-cli getnetworkhashps 120 100  # Blocks, height

getblocktemplate ​

Returns block template for mining.

bash
cs-cli getblocktemplate
cs-cli getblocktemplate '{"rules": ["segwit"]}'

submitblock ​

Submits block to network.

bash
cs-cli submitblock "hexdata"

setgenerate ​

Sets mining generation.

bash
cs-cli setgenerate true
cs-cli setgenerate true 4  # Threads
cs-cli setgenerate false  # Stop

getgenerate ​

Returns generation status.

bash
cs-cli getgenerate

Network Commands ​

getnetworkinfo ​

Returns network information.

bash
cs-cli getnetworkinfo

getpeerinfo ​

Returns information about connected peers.

bash
cs-cli getpeerinfo

addnode ​

Adds or removes a node.

bash
cs-cli addnode "node:port" onetry
cs-cli addnode "node:port" add
cs-cli addnode "node:port" remove

disconnectnode ​

Disconnects from a node.

bash
cs-cli disconnectnode "node:port"
cs-cli disconnectnode "nodeid"

getconnectioncount ​

Returns number of connections.

bash
cs-cli getconnectioncount

ping ​

Sends ping to all peers.

bash
cs-cli ping

Utility Commands ​

validateaddress ​

Validates an address.

bash
cs-cli validateaddress "address"

verifymessage ​

Verifies a signed message.

bash
cs-cli verifymessage "address" "signature" "message"

signmessage ​

Signs a message with private key.

bash
cs-cli signmessage "address" "message"

help ​

Lists all commands or help for specific command.

bash
cs-cli help
cs-cli help "getblockchaininfo"

stop ​

Stops the daemon.

bash
cs-cli stop

getinfo ​

Returns general information (deprecated, use specific commands).

bash
cs-cli getinfo

Advanced Commands ​

createrawtransaction ​

Creates raw transaction.

bash
cs-cli createrawtransaction '[{"txid":"id","vout":0}]' '{"address":amount}'

signrawtransactionwithkey ​

Signs raw transaction with private key.

bash
cs-cli signrawtransactionwithkey "hexstring" '["privkey"]'

fundrawtransaction ​

Adds inputs to raw transaction.

bash
cs-cli fundrawtransaction "hexstring"

combinerawtransaction ​

Combines multiple raw transactions.

bash
cs-cli combinerawtransaction '["hex1","hex2"]'

Command Categories Summary ​

CategoryCommands
Blockchaingetblockchaininfo, getblock, getblockhash, getbestblockhash, getblockcount, getdifficulty, getrawmempool, getmempoolinfo
Transactionsgetrawtransaction, decoderawtransaction, sendrawtransaction, gettransaction, listtransactions
Walletgetbalance, getnewaddress, sendtoaddress, encryptwallet, walletpassphrase, backupwallet, importprivkey
Mininggetmininginfo, getnetworkhashps, getblocktemplate, submitblock, setgenerate
Networkgetnetworkinfo, getpeerinfo, addnode, disconnectnode, getconnectioncount
Utilityvalidateaddress, verifymessage, signmessage, help, stop

Next Steps ​

Released under the MIT License.