Wallet RPC Documentation

This is a list of the xolentum-wallet-rpc calls, their inputs and outputs, and examples of each.

All xolentum-wallet-rpc methods use the same JSON RPC interface. For example:

IP=127.0.0.1
                                PORT=xxxxx
                                METHOD="make_integrated_address"
                                PARAMS="{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}"
                                curl \
                                    http://$IP:$PORT/json_rpc \
                                    -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'"$PARAMS"'}' \
                                    -H 'Content-Type: application/json'
                                

If the xolentum-wallet-rpc was executed with the --rpc-login argument as username:password, then follow this example:

IP=127.0.0.1
                                PORT=13581
                                METHOD="make_integrated_address"
                                PARAMS="{\"payment_id\":\"1234567890123456789012345678900012345678901234567890123456789000\"}"
                                curl \
                                    -u username:password --digest \
                                    http://$IP:$PORT/json_rpc \
                                    -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'"$PARAMS"'}' \
                                    -H 'Content-Type: application/json'
                                

Note: atomic-units refer to the smallest fraction of 1 XOL according to the xolentumd implementation. 1 XOL = 1e12 atomic-units.

RPC Methods


set_daemon

Connect the RPC server to a Xolentum daemon.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_daemon","params": {"address":"http://localhost:18081","trusted":true,"ssl_support":"enabled","ssl_private_key_path":"path/to/ssl/key","ssl_certificate_path":"path/to/ssl/certificate","ssl_ca_file":"path/to/ssl/ca/file","ssl_allowed_fingerprints":["85:A7:68:29:BE:73:49:80:84:91:7A:BB:1F:F1:AD:7E:43:FE:CC:B8"],"ssl_allow_any_cert":true}},' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_balance

Return the wallet's balance.

Alias: getbalance.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_balance","params":{"account_index":0,"address_indices":[0,1]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "balance": 157443303037455077,
                                        "multisig_import_needed": false,
                                        "per_subaddress": [{
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "address_index": 0,
                                          "balance": 157360317826255077,
                                          "label": "Primary account",
                                          "num_unspent_outputs": 5281,
                                          "unlocked_balance": 157360317826255077
                                        },{
                                          "address": "xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o",
                                          "address_index": 1,
                                          "balance": 59985211200000,
                                          "label": "",
                                          "num_unspent_outputs": 1,
                                          "unlocked_balance": 59985211200000
                                        }],
                                        "unlocked_balance": 157443303037455077
                                      }
                                    }
                                    

get_address

Return the wallet's addresses for an account. Optionally filter for specific set of subaddresses.

Alias: getaddress.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_address","params":{"account_index":0,"address_index":[0,1,4]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                        "addresses": [{
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "address_index": 0,
                                          "label": "Primary account",
                                          "used": true
                                        },{
                                          "address": "xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o",
                                          "address_index": 1,
                                          "label": "",
                                          "used": true
                                        },{
                                          "address": "77xa6Dha7kzCQuvmd8iB5VYoMkdenwCNRU9khGhExXQ8KLL3z1N1ZATBD1sFPenyHWT9cm4fVFnCAUApY53peuoZFtwZiw5",
                                          "address_index": 4,
                                          "label": "test2",
                                          "used": true
                                        }]
                                      }
                                    }
                                    

get_address_index

Get account and address indexes from a specific (sub)address

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_address_index","params":{"address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "index": {
                                          "major": 0,
                                          "minor": 1
                                        }
                                      }
                                    }
                                    

create_address

Create a new address for an account. Optionally, label the new address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"create_address","params":{"account_index":0,"label":"new-sub"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "7BG5jr9QS5sGMdpbBrZEwVLZjSKJGJBsXdZLt8wiXyhhLjy7x2LZxsrAnHTgD8oG46ZtLjUGic2pWc96GFkGNPQQDA3Dt7Q",
                                        "address_index": 5
                                      }
                                    }
                                    

label_address

Label an address.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_address","params":{"index":{"major":0,"minor":5},"label":"myLabel"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

validate_address

Analyzes a string to determine whether it is a valid xolentum wallet address and returns the result and the address specifications.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"validate_address", params={"address":"42go2d3XqA9Mx4HjZoqr93BHspcMxwAUBivs3yJKV1FyTycEcbgjNyEaGNEcgnUE9DDDAXNanzB16YgMt88Sa8cFSm2QcHK","any_net_type":"true"},' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "valid": true,
                                        "integrated": false,
                                        "subaddress": false,
                                        "nettype": "mainnet",
                                      }
                                    }
                                    

get_accounts

Get all accounts for a wallet. Optionally filter accounts by tag.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_accounts","params":{"tag":"myTag"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "subaddress_accounts": [{
                                          "account_index": 0,
                                          "balance": 157663195572433688,
                                          "base_address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "label": "Primary account",
                                          "tag": "myTag",
                                          "unlocked_balance": 157443303037455077
                                        },{
                                          "account_index": 1,
                                          "balance": 0,
                                          "base_address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
                                          "label": "Secondary account",
                                          "tag": "myTag",
                                          "unlocked_balance": 0
                                        }],
                                        "total_balance": 157663195572433688,
                                        "total_unlocked_balance": 157443303037455077
                                      }
                                    }
                                    

create_account

Create a new account with an optional label.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"create_account","params":{"label":"Secondary account"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "account_index": 1,
                                        "address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp"
                                      }
                                    }
                                    

label_account

Label an account.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_account","params":{"account_index":0,"label":"Primary account"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "account_tags": [{
                                          "accounts": [0,1],
                                          "label": "",
                                          "tag": "myTag"
                                        }]
                                      }
                                    }
                                    

get_account_tags

Get a list of user-defined account tags.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_account_tags","params":""}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "account_tags": [{
                                          "accounts": [0],
                                          "label": "Test tag",
                                          "tag": "myTag"
                                        }]
                                      }
                                    }
                                    

tag_accounts

Apply a filtering tag to a list of accounts.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"tag_accounts","params":{"tag":"myTag","accounts":[0,1]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

untag_accounts

Remove filtering tag from a list of accounts.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"untag_accounts","params":{"accounts":[1]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

set_account_tag_description

Set description for an account tag.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_account_tag_description","params":{"tag":"myTag","description":"Test tag"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_height

Returns the wallet's current block height.

Alias: getheight.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_height"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "height": 145545
                                      }
                                    }
                                    

transfer

Send Xolentum to a number of recipients.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":100000000000,"address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":200000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_key": true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "amount": 300000000000,
                                        "fee": 86897600000,
                                        "multisig_txset": "",
                                        "tx_blob": "",
                                        "tx_hash": "7663438de4f72b25a0e395b770ea9ecf7108cd2f0c4b75be0b14a103d3362be9",
                                        "tx_key": "25c9d8ec20045c80c93d665c9d3684aab7335f8b2cd02e1ba2638485afd1c70e236c4bdd7a2f1cb511dbf466f13421bdf8df988b7b969c448ca6239d7251490e4bf1bbf9f6ffacffdcdc93b9d1648ec499eada4d6b4e02ce92d4a1c0452e5d009fbbbf15b549df8856205a4c7bda6338d82c823f911acd00cb75850b198c5803",
                                        "tx_metadata": "",
                                        "unsigned_txset": ""
                                      }
                                    }
                                    

transfer_split

Same as transfer, but can split into more than one tx if necessary.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer_split","params":{"destinations":[{"amount":1000000000000,"address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":2000000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_keys": true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "amount_list": [3000000000000],
                                        "fee_list": [473710000],
                                        "multisig_txset": "",
                                        "tx_hash_list": ["4adcdc1af3f665770cdf8fb7a380887cd07ac53c2b771bd18df5ca375d5e7540"],
                                        "tx_key_list": ["5b455c0f97168be652a2c03c5c68a064bb84cdae4ddef01b5c48d73a0bbb27075fb714f2ca19ea6c8ff592417e606addea6deb1d6530e2969f75681ffcbfc4075677b94a8c9197963ae38fa6f543ee68f0a4c4bbda4c453f39538f00b28e980ea08509730b51c004960101ba2f3adbc34cbbdff0d5af9dba061b523090debd06"],
                                        "unsigned_txset": ""
                                      }
                                    }
                                    

sign_transfer

Sign a transaction created on a read-only wallet (in cold-signing process)

Alias: None.

Inputs:

Outputs:

In the example below, we first generate an unsigned_txset on a read only wallet before signing it:

Generate unsigned_txset using the above "transfer" method on read-only wallet:

curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":1000000000000,"address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"do_not_relay":true,"get_tx_hex":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "amount": 1000000000000,
                                        "fee": 15202740000,
                                        "multisig_txset": "",
                                        "tx_blob": "...long_hex...",
                                        "tx_hash": "c648ba0a049e5ce4ec21361dbf6e4b21eac0f828eea9090215de86c76b31d0a4",
                                        "tx_key": "",
                                        "tx_metadata": "",
                                        "unsigned_txset": "...long_hex..."
                                      }
                                    }
                                    

Sign tx using the previously generated unsigned_txset

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign_transfer","params":{"unsigned_txset":...long_hex..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signed_txset": "...long_hex...",
                                        "tx_hash_list": ["ff2e2d49fbfb1c9a55754f786576e171c8bf21b463a74438df604b7fa6cebc6d"]
                                      }
                                    }
                                    

submit_transfer

Submit a previously signed transaction on a read-only wallet (in cold-signing process).

Alias: None.

Inputs:

Outputs:

In the example below, we submit the transfer using the signed_txset generated above:

curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_transfer","params":{"tx_data_hex":...long_hex..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "tx_hash_list": ["40fad7c828bb383ac02648732f7afce9adc520ba5629e1f5d9c03f584ac53d74"]
                                      }
                                    }
                                    

sweep_dust

Send all dust outputs back to the wallet's, to make them easier to spend (and mix).

Alias: sweep_unmixable.

Inputs:

Outputs:

Example (In this example, sweep_dust returns nothing because there are no funds to sweep):

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_dust","params":{"get_tx_keys":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "multisig_txset": "",
                                        "unsigned_txset": ""
                                      }
                                    }
                                    

sweep_all

Send all unlocked balance to an address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_all","params":{"address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","subaddr_indices":[4],"ring_size":7,"unlock_time":0,"get_tx_keys":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "amount_list": [9985885770000],
                                        "fee_list": [14114230000],
                                        "multisig_txset": "",
                                        "tx_hash_list": ["ab4b6b65cc8cd8c9dd317d0b90d97582d68d0aa1637b0065b05b61f9a66ea5c5"],
                                        "tx_key_list": ["b9b4b39d3bb3062ddb85ec0266d4df39058f4c86077d99309f218ce4d76af607"],
                                        "unsigned_txset": ""
                                      }
                                    }
                                    

sweep_single

Send all of a specific unlocked output to an address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_single","params":{"address":"74Jsocx8xbpTBEjm3ncKE5LBQbiJouyCDaGhgSiebpvNDXZnTAbW2CmUR5SsBeae2pNk9WMVuz6jegkC4krUyqRjA6VjoLD","ring_size":7,"unlock_time":0,"key_image":"a7834459ef795d2efb6f665d2fd758c8d9288989d8d4c712a68f8023f7804a5e","get_tx_keys":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "amount": 27126892247503,
                                        "fee": 14111630000,
                                        "multisig_txset": "",
                                        "tx_blob": "",
                                        "tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
                                        "tx_key": "",
                                        "tx_metadata": "",
                                        "unsigned_txset": ""
                                      }
                                    }
                                    

relay_tx

Relay a transaction previously created with "do_not_relay":true.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"relay_tx","params":{"hex":"...tx_metadata..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "tx_hash": "1c42dcc5672bb09bccf33fb1e9ab4a498af59a6dbd33b3d0cfb289b9e0e25fa5"
                                      }
                                    }
                                    

store

Save the wallet file.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"store"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_payments

Get a list of incoming payments using a given payment id.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_payments","params":{"payment_id":"60900e5603bf96e3"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "payments": [{
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "amount": 1000000000000,
                                          "block_height": 127606,
                                          "payment_id": "60900e5603bf96e3",
                                          "subaddr_index": {
                                            "major": 0,
                                            "minor": 0
                                          },
                                          "tx_hash": "3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f",
                                          "unlock_time": 0
                                        }]
                                      }
                                    }
                                    

get_bulk_payments

Get a list of incoming payments using a given payment id, or a list of payments ids, from a given height. This method is the preferred method over get_payments because it has the same functionality but is more extendable. Either is fine for looking up transactions by a single payment ID.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_bulk_payments","params":{"payment_ids":["60900e5603bf96e3"],"min_block_height":"120000"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "payments": [{
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "amount": 1000000000000,
                                          "block_height": 127606,
                                          "payment_id": "60900e5603bf96e3",
                                          "subaddr_index": {
                                            "major": 0,
                                            "minor": 0
                                          },
                                          "tx_hash": "3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f",
                                          "unlock_time": 0
                                        }]
                                      }
                                    }
                                    

incoming_transfers

Return a list of incoming transfers to the wallet.

Inputs:

Outputs:

Example, get all transfers:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"all","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "transfers": [{
                                          "amount": 60000000000000,
                                          "global_index": 122405,
                                          "key_image": "768f5144777eb23477ab7acf83562581d690abaf98ca897c03a9d2b900eb479b",
                                          "spent": true,
                                          "subaddr_index": 3,
                                          "tx_hash": "f53401f21c6a43e44d5dd7a90eba5cf580012ad0e15d050059136f8a0da34f6b",
                                          "tx_size": 159
                                        },{
                                          "amount": 27126892247503,
                                          "global_index": 594994,
                                          "key_image": "7e561394806afd1be61980cc3431f6ef3569fa9151cd8d234f8ec13aa145695e",
                                          "spent": false,
                                          "subaddr_index": 3,
                                          "tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
                                          "tx_size": 157
                                        },{
                                          "amount": 27169374733655,
                                          "global_index": 594997,
                                          "key_image": "e76c0a3bfeaae35e4173712f782eb34011198e26b990225b71aa787c8ba8a157",
                                          "spent": false,
                                          "subaddr_index": 3,
                                          "tx_hash": "0bd959b59117ee1254bd8e5aa8e77ec04ef744144a1ffb2d5c1eb9380a719621",
                                          "tx_size": 158
                                        }]
                                      }
                                    }
                                    

Example, get available transfers:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"available","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "transfers": [{
                                          "amount": 27126892247503,
                                          "global_index": 594994,
                                          "key_image": "7e561394806afd1be61980cc3431f6ef3569fa9151cd8d234f8ec13aa145695e",
                                          "spent": false,
                                          "subaddr_index": 3,
                                          "tx_hash": "106d4391a031e5b735ded555862fec63233e34e5fa4fc7edcfdbe461c275ae5b",
                                          "tx_size": 157
                                        },{
                                          "amount": 27169374733655,
                                          "global_index": 594997,
                                          "key_image": "e76c0a3bfeaae35e4173712f782eb34011198e26b990225b71aa787c8ba8a157",
                                          "spent": false,
                                          "subaddr_index": 3,
                                          "tx_hash": "0bd959b59117ee1254bd8e5aa8e77ec04ef744144a1ffb2d5c1eb9380a719621",
                                          "tx_size": 158
                                        }]
                                      }
                                    }
                                    

Example, get unavailable transfers:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"unavailable","account_index":0,"subaddr_indices":[3],"verbose":true}}' -H 'Content-Type: application/json'
                                    {
                                    "id": "0",
                                    "jsonrpc": "2.0",
                                    "result": {
                                      "transfers": [{
                                        "amount": 60000000000000,
                                        "global_index": 122405,
                                        "key_image": "768f5144777eb23477ab7acf83562581d690abaf98ca897c03a9d2b900eb479b",
                                        "spent": true,
                                        "subaddr_index": 3,
                                        "tx_hash": "f53401f21c6a43e44d5dd7a90eba5cf580012ad0e15d050059136f8a0da34f6b",
                                        "tx_size": 159
                                      }]
                                    }
                                    }
                                    

query_key

Return the spend or view private key.

Alias: None.

Inputs:

Outputs:

Example (Query view key):

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"query_key","params":{"key_type":"view_key"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "key": "0a1a38f6d246e894600a3e27238a064bf5e8d91801df47a17107596b1378e501"
                                      }
                                    }
                                    

Example (Query mnemonic key):

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"query_key","params":{"key_type":"mnemonic"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "key": "vocal either anvil films dolphin zeal bacon cuisine quote syndrome rejoices envy okay pancakes tulips lair greater petals organs enmity dedicated oust thwart tomorrow tomorrow"
                                      }
                                    }
                                    

make_integrated_address

Make an integrated address from the wallet address and a payment id.

Alias: None.

Inputs:

Outputs:

Example (Payment ID is empty, use a random ID):

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_integrated_address","params":{"standard_address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "integrated_address": "iF38Rw9HKeaLQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZXCkbHUXdPHyiUeRyokn",
                                        "payment_id": "420fa29b2d9a49f5"
                                      }
                                    }
                                    

split_integrated_address

Retrieve the standard address and payment id corresponding to an integrated address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"split_integrated_address","params":{"integrated_address": "iF38Rw9HKeaLQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZXCkbHUXdPHyiUeRyokn"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "is_subaddress": false,
                                        "payment_id": "420fa29b2d9a49f5",
                                        "standard_address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"
                                      }
                                    }
                                    

stop_wallet

Stops the wallet, storing the current state.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_wallet"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

rescan_blockchain

Rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself.
This includes destination addresses, tx secret keys, tx notes, etc.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_blockchain"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

set_tx_notes

Set arbitrary string notes for transactions.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_tx_notes","params":{"txids":["3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f"],"notes":["This is an example"]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_tx_notes

Get string notes for transactions.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_notes","params":{"txids":["3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f"]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "notes": ["This is an example"]
                                      }
                                    }
                                    

set_attribute

Set arbitrary attribute.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_attribute","params":{"key":"my_attribute","value":"my_value"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_attribute

Get attribute value by name.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_attribute","params":{"key":"my_attribute"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "value": "my_value"
                                      }
                                    }
                                    

get_tx_key

Get transaction secret key from transaction id.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_key","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "tx_key": "feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06"
                                      }
                                    }
                                    

check_tx_key

Check a transaction in the blockchain with its secret key.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_tx_key","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","tx_key":"feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06","address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "confirmations": 0,
                                        "in_pool": false,
                                        "received": 1000000000000
                                      }
                                    }
                                    

get_tx_proof

Get transaction signature to prove it.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signature": "InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"
                                      }
                                    }
                                    

check_tx_proof

Prove a transaction by checking its signature.

Alias: None.

Inputs:

Outputs:

In the example below, the transaction has been proven:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "confirmations": 482,
                                        "good": true,
                                        "in_pool": false,
                                        "received": 1000000000000
                                      }
                                    }
                                    

In the example below, the wrong message is used, avoiding the transaction to be proved:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"wrong message","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "confirmations": 0,
                                        "good": false,
                                        "in_pool": false,
                                        "received": 0
                                      }
                                    }
                                    

get_spend_proof

Generate a signature to prove a spend. Unlike proving a transaction, it does not requires the destination public address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"this is my transaction"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signature": "SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"
                                      }
                                    }
                                    

check_spend_proof

Prove a spend using a signature. Unlike proving a transaction, it does not requires the destination public address.

Alias: None.

Inputs:

Outputs:

In the example below, the spend has been proven:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"this is my transaction","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": true
                                      }
                                    }
                                    

In the example below, the wrong message is used, avoiding the spend to be proved:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": false
                                      }
                                    }
                                    

get_reserve_proof

Generate a signature to prove of an available amount in a wallet.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_reserve_proof","params":{"all":false,"account_index":0,"amount":100000000000}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signature": "ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A"
                                      }
                                    }
                                    

check_reserve_proof

Proves a wallet has a disposable reserve using a signature.

Alias: None.

Inputs:

Outputs:

In the example below, the reserve has been proven:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": true,
                                        "spent": 0,
                                        "total": 100000000000
                                      }
                                    }
                                    

In the example below, all wallet reserve has been proven:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","message":"I have 10 at least","signature":"...signature..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": true,
                                        "spent": 0,
                                        "total": 164113855714662789
                                      }
                                    }
                                    

In the example below, the wrong message is used, avoiding the reserve to be proved:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": false
                                      }
                                    }
                                    

get_transfers

Returns a list of transfers.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfers","params":{"in":true,"account_index":1}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "in": [{
                                          "address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
                                          "amount": 200000000000,
                                          "confirmations": 1,
                                          "double_spend_seen": false,
                                          "fee": 21650200000,
                                          "height": 153624,
                                          "note": "",
                                          "payment_id": "0000000000000000",
                                          "subaddr_index": {
                                            "major": 1,
                                            "minor": 0
                                          },
                                          "suggested_confirmations_threshold": 1,
                                          "timestamp": 1535918400,
                                          "txid": "c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a",
                                          "type": "in",
                                          "unlock_time": 0
                                        }]
                                      }
                                    }
                                    

get_transfer_by_txid

Show information about a transfer to/from this address.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfer_by_txid","params":{"txid":"c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "transfer": {
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "amount": 300000000000,
                                          "confirmations": 1,
                                          "destinations": [{
                                            "address": "xBnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o",
                                            "amount": 100000000000
                                          },{
                                            "address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
                                            "amount": 200000000000
                                          }],
                                          "double_spend_seen": false,
                                          "fee": 21650200000,
                                          "height": 153624,
                                          "note": "",
                                          "payment_id": "0000000000000000",
                                          "subaddr_index": {
                                            "major": 0,
                                            "minor": 0
                                          },
                                          "suggested_confirmations_threshold": 1,
                                          "timestamp": 1535918400,
                                          "txid": "c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a",
                                          "type": "out",
                                          "unlock_time": 0
                                        }
                                      }
                                    }
                                    

describe_transfer

Returns details for each transaction in an unsigned or multisig transaction set. Transaction sets are obtained as return values from one of the following RPC methods:

These methods return unsigned transaction sets if the wallet is view-only (i.e. the wallet was created without the private spend key).

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"describe_transfer","params":{"unsigned_txset":"...long hex..."}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "desc": [{
                                          "amount_in": 886489038634812,
                                          "amount_out": 886455352051344,
                                          "change_address": "5BqWeZrK944YesCy5VdmBneWeaSZutEijFVAKjpVHeVd4unsCSM55CjgViQsK9WFNHK1eZgcCuZ3fRqYpzKDokqSUmQfJzvswQs13AAidJ",
                                          "change_amount": 4976287087263,
                                          "dummy_outputs": 0,
                                          "extra": 01b998f16459bcbac9c92074d3128d10724f10b74f5a7b1ec8e5a1e7f1150544020209010000000000000000",
                                          "fee": 33686583468, 
                                          "payment_id": "0000000000000000000000000000000000000000000000000000000000000000",
                                          "recipients": [{
                                            "address": "0b057f69acc1552014cb157138e5c4dd495347d333f68ff0af70494b979aed10",
                                            "amount": 881479064964081
                                          }],       
                                          "ring_size": 11,
                                          "unlock_time": 0
                                        ]}
                                      }
                                    }
                                    

sign

Sign a string.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign","params":{"data":"This is sample data to be signed"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signature": "SigV14K6G151gycjiGxjQ74tKX6A2LwwghvuHjcDeuRFQio5LS6Gb27BNxjYQY1dPuUvXkEbGQUkiHSVLPj4nJAHRrrw3"
                                      }
                                    }
                                    

verify

Verify a signature on a string.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"verify","params":{"data":"This is sample data to be signed","address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"SigV14K6G151gycjiGxjQ74tKX6A2LwwghvuHjcDeuRFQio5LS6Gb27BNxjYQY1dPuUvXkEbGQUkiHSVLPj4nJAHRrrw3"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "good": true
                                      }
                                    }
                                    

export_outputs

Export all outputs in hex format.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"export_outputs"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "outputs_data_hex": "...outputs..."
                                      }
                                    }
                                    

import_outputs

Import outputs in hex format.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_outputs","params":{"outputs_data_hex":"...outputs..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "num_imported": 6400
                                      }
                                    }
                                    

export_key_images

Export a signed set of key images.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"export_key_images"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "signed_key_images": [{
                                          "key_image": "cd35239b72a35e26a57ed17400c0b66944a55de9d5bda0f21190fed17f8ea876",
                                          "signature": "c9d736869355da2538ab4af188279f84138c958edbae3c5caf388a63cd8e780b8c5a1aed850bd79657df659422c463608ea4e0c730ba9b662c906ae933816d00"
                                        },{
                                          "key_image": "65158a8ee5a3b32009b85a307d85b375175870e560e08de313531c7dbbe6fc19",
                                          "signature": "c96e40d09dfc45cfc5ed0b76bfd7ca793469588bb0cf2b4d7b45ef23d40fd4036057b397828062e31700dc0c2da364f50cd142295a8405b9fe97418b4b745d0c"
                                        },...]
                                      }
                                    }
                                    

import_key_images

Import signed key images list and verify their spent status.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_key_images", "params":{"signed_key_images":[{"key_image":"cd35239b72a35e26a57ed17400c0b66944a55de9d5bda0f21190fed17f8ea876","signature":"c9d736869355da2538ab4af188279f84138c958edbae3c5caf388a63cd8e780b8c5a1aed850bd79657df659422c463608ea4e0c730ba9b662c906ae933816d00"},{"key_image":"65158a8ee5a3b32009b85a307d85b375175870e560e08de313531c7dbbe6fc19","signature":"c96e40d09dfc45cfc5ed0b76bfd7ca793469588bb0cf2b4d7b45ef23d40fd4036057b397828062e31700dc0c2da364f50cd142295a8405b9fe97418b4b745d0c"}]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "height": 76428,
                                        "spent": 62708953408711,
                                        "unspent": 0
                                      }
                                    }
                                    

make_uri

Create a payment URI using the official URI spec.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_uri","params":{"address":"x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","amount":10,"payment_id":"420fa29b2d9a49f5","tx_description":"Testing out the make_uri function.","recipient_name":"el00ruobuob Stagenet wallet"}}'  -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "uri": "Xolentum:x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?tx_payment_id=420fa29b2d9a49f5&tx_amount=0.000000000010&recipient_name=el00ruobuob%20Stagenet%20wallet&tx_description=Testing%20out%20the%20make_uri%20function."
                                      }
                                    }
                                    

parse_uri

Parse a payment URI to get payment information.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"parse_uri","params":{"uri":"Xolentum:x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?tx_payment_id=420fa29b2d9a49f5&tx_amount=0.000000000010&recipient_name=el00ruobuob%20Stagenet%20wallet&tx_description=Testing%20out%20the%20make_uri%20function."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "uri": {
                                          "address": "x5LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt",
                                          "amount": 10,
                                          "payment_id": "420fa29b2d9a49f5",
                                          "recipient_name": "el00ruobuob Stagenet wallet",
                                          "tx_description": "Testing out the make_uri function."
                                        }
                                      }
                                    }
                                    

get_address_book

Retrieves entries from the address book.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_address_book","params":{"entries":[0,1]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "entries": [{
                                          "address": "77Vx9cs1VPicFndSVgYUvTdLCJEZw9h81hXLMYsjBCXSJfUehLa9TDW3Ffh45SQa7xb6dUs18mpNxfUhQGqfwXPSMrvKhVp",
                                          "description": "Second account",
                                          "index": 0,
                                          "payment_id": "0000000000000000000000000000000000000000000000000000000000000000"
                                        },{
                                          "address": "78P16M3XmFRGcWFCcsgt1WcTntA1jzcq31seQX1Eg92j8VQ99NPivmdKam4J5CKNAD7KuNWcq5xUPgoWczChzdba5WLwQ4j",
                                          "description": "Third account",
                                          "index": 1,
                                          "payment_id": "0000000000000000000000000000000000000000000000000000000000000000"
                                        }]
                                      }
                                    }
                                    

add_address_book

Add an entry to the address book.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"add_address_book","params":{"address":"78P16M3XmFRGcWFCcsgt1WcTntA1jzcq31seQX1Eg92j8VQ99NPivmdKam4J5CKNAD7KuNWcq5xUPgoWczChzdba5WLwQ4j","description":"Third account"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "index": 1
                                      }
                                    }
                                    

edit_address_book

Edit an existing address book entry.

Alias: None

Inputs:

Outputs: none.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"edit_address_book","params":{"index":0, "set_address":true, "address":"0b057f69acc1552014cb157138e5c4dd495347d333f68ff0af70494b979aed10", "set_payment_id":true, "payment_id":"60900e5603bf96e3", "set_description":true, "description":"Example description."}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

delete_address_book

Delete an entry from the address book.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"delete_address_book","params":{"index":1}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

refresh

Refresh a wallet after openning.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"refresh","params":{"start_height":100000}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "blocks_fetched": 24,
                                        "received_money": true
                                      }
                                    }
                                    

auto_refresh

Set whether and how often to automatically refresh the current wallet.

Inputs:

Outputs: none.

Example:

$ curl http://127.0.0.1:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"auto_refresh","params":{"enable":true, "period":10}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

rescan_spent

Rescan the blockchain for spent outputs.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_spent"}' -H 'Content-Type: application/json'
                                    
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

start_mining

Start mining in the Xolentum daemon.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"start_mining","params":{"threads_count":1,"do_background_mining":true,"ignore_battery":false}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

stop_mining

Stop mining in the Xolentum daemon.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_mining"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

get_languages

Get a list of available languages for your wallet's seed.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_languages"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "languages": ["Deutsch","English","Español","Français","Italiano","Nederlands","Português","русский язык","日本語","简体中文 (中国)","Esperanto","Lojban"]
                                      }
                                    }
                                    

create_wallet

Create a new wallet. You need to have set the argument "--wallet-dir" when launching xolentum-wallet-rpc to make this work.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"create_wallet","params":{"filename":"mytestwallet","password":"mytestpassword","language":"English"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

open_wallet

Open a wallet. You need to have set the argument "--wallet-dir" when launching xolentum-wallet-rpc to make this work.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"mytestwallet","password":"mytestpassword"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

restore_deterministic_wallet

Create and open a wallet on the RPC server from an existing mnemonic phrase and close the currently open wallet.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:38083/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"restore_deterministic_wallet","params":{"filename":"My Wallet","password":"mypassword123","seed":"awkward vogue odometer amply bagpipe kisses poker aspire slug eluded hydrogen selfish later toolbox enigma wolf tweezers eluded gnome soprano ladder broken jukebox lordship aspire","restore_height":0, "language":"English","seed_offset":"","autosave_current":true}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "9wB1Jc5fy5hjTkFBnv4UNY3WfhUswhx8M7uWjZrwRBzH2uatJcn8AqiKEHWuSNrnapApCzzTxP4iSiV3y3pqYcRbDHNboJK",
                                        "info": "Wallet has been restored successfully.",
                                        "seed": "awkward vogue odometer amply bagpipe kisses poker aspire slug eluded hydrogen selfish later toolbox enigma wolf tweezers eluded gnome soprano ladder broken jukebox lordship aspire",
                                        "was_deprecated": false
                                      }
                                    }
                                    

close_wallet

Close the currently opened wallet, after trying to save it.

Alias: None.

Inputs: None.

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"close_wallet"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

change_wallet_password

Change a wallet password.

Alias: None.

Inputs:

Outputs: None.

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"change_wallet_password","params":{"old_password":"theCurrentSecretPassPhrase","new_password":"theNewSecretPassPhrase"}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                      }
                                    }
                                    

is_multisig

Check if a wallet is a multisig one.

Alias: None.

Inputs: None.

Outputs:

Example for a non-multisig wallet:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "multisig": false,
                                        "ready": false,
                                        "threshold": 0,
                                        "total": 0
                                      }
                                    }
                                    

Example for a multisig wallet:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json'                  {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "multisig": true,
                                        "ready": true,
                                        "threshold": 2,
                                        "total": 2
                                      }
                                    }
                                    

prepare_multisig

Prepare a wallet for multisig by generating a multisig string to share with peers.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"prepare_multisig"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "multisig_info": "MultisigV1BFdxQ653cQHB8wsj9WJQd2VdnjxK89g5M94dKPBNw22reJnyJYKrz6rJeXdjFwJ3Mz6n4qNQLd6eqUZKLiNzJFi3UPNVcTjtkG2aeSys9sYkvYYKMZ7chCxvoEXVgm74KKUcUu4V8xveCBFadFuZs8shnxBWHbcwFr5AziLr2mE7KHJT"
                                      }
                                    }
                                    

make_multisig

Make a wallet multisig by importing peers multisig string.

Alias: None.

Inputs:

Outputs:

Example for 2/2 Multisig Wallet:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_multisig","params":{"multisig_info":["MultisigV1K4tGGe8QirZdHgTYoBZMumSug97fdDyM3Z63M3ZY5VXvAdoZvx16HJzPCP4Rp2ABMKUqLD2a74ugMdBfrVpKt4BwD8qCL5aZLrsYWoHiA7JJwDESuhsC3eF8QC9UMvxLXEMsMVh16o98GnKRYz1HCKXrAEWfcrCHyz3bLW1Pdggyowop"],"threshold":2}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "55SoZTKH7D39drxfgT62k8T4adVFjmDLUXnbzEKYf1MoYwnmTNKKaqGfxm4sqeKCHXQ5up7PVxrkoeRzXu83d8xYURouMod",
                                        "multisig_info": ""
                                      }
                                    }
                                    

Example for 2/3 Multisig Wallet:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_multisig","params":{"multisig_info":["MultisigV1MTVm4DZAdJw1PyVutpSy8Q4WisZBCFRAaZY7hhQnMwr5AZ4swzThyaSiVVQM5FHj1JQi3zPKhQ4k81BZkPSEaFjwRJtbfqfJcVvCqRnmBVcWVxhnihX5s8fZWBCjKrzT3CS95spG4dzNzJSUcjheAkLzCpVmSzGtgwMhAS3Vuz9Pas24","MultisigV1TEx58ycKCd6ADCfxF8hALpcdSRAkhZTi1bu4Rs6FdRC98EdB1LY7TAkMxasM55khFgcxrSXivaSr5FCMyJGHmojm1eE4HpGWPeZKv6cgCTThRzC4u6bkkSoFQdbzWN92yn1XEjuP2XQrGHk81mG2LMeyB51MWKJAVF99Pg9mX2BpmYFj"],"threshold":2}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "51sLpF8fWaK1111111111111111111111111111111111ABVbHNf1JFWJyFp5YZgZRQ44RiviJi1sPHgLVMbckRsDkTRgKS",
                                        "multisig_info": "MultisigxV18jCaYAQQvzCMUJaAWMCaAbAoHpAD6WPmYDmLtBtazD654E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2Sscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskaDKuTAWtdB9VTBGW7iG1cd7Zm1dYgur3CiemkGjRUAj9bL3xTEuyaKGYSDhtpFZFp99HQX57EawhiRHk3qq4hjWX"
                                      }
                                    }
                                    

export_multisig_info

Export multisig info for other participants.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"export_multisig_info"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "info": "4d6f6e65726f206d756c7469736967206578706f72740105cf6442b09b75f5eca9d846771fe1a879c9a97ab0553ffbcec64b1148eb7832b51e7898d7944c41cee000415c5a98f4f80dc0efdae379a98805bb6eacae743446f6f421cd03e129eb5b27d6e3b73eb6929201507c1ae706c1a9ecd26ac8601932415b0b6f49cbbfd712e47d01262c59980a8f9a8be776f2bf585f1477a6df63d6364614d941ecfdcb6e958a390eb9aa7c87f056673d73bc7c5f0ab1f74a682e902e48a3322c0413bb7f6fd67404f13fb8e313f70a0ce568c853206751a334ef490068d3c8ca0e"
                                      }
                                    }
                                    

import_multisig_info

Import multisig info from other participants.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_multisig_info","params":{"info":["...multisig_info..."]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "n_outputs": 35
                                      }
                                    }
                                    

finalize_multisig

Turn this wallet into a multisig wallet, extra step for N-1/N wallets.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"finalize_multisig","params":{"multisig_info":["MultisigxV1JNC6Ja2oBt5Sqea9LN2YEF7WYZCpHqr2EKvPG89Trf3X4E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2McPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZEKVAQ4HPPyQciSCdNjgwsuFRBzrskMdMUwNMgKst1debYfm37i6PSzDoS2tk4kYTYj83kkAdR7kdshet1axQPd6HQ","MultisigxV1Unma7Ko4zdd8Ps3Af4oZwtj2JdWKzwNfP6s2G9ZvXhMoSscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskMcPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZE1LTpWxLoC3vPMSrqVVcjnmL9LYfdCZz3fECjNZbCEDq3PHDiUuY5jurQTcNoGhDTio5WM9xaAdim9YByiS5KyqF4"]}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "address": "5B9gZUTDuHTcGGuY3nL3t8K2tDnEHeRVHSBQgLZUTQxtFYVLnho5JJjWJyFp5YZgZRQ44RiviJi1sPHgLVMbckRsDqDx1gV"
                                      }
                                    }
                                    

sign_multisig

Sign a transaction in multisig.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign_multisig","params":{"tx_data_hex":"...multisig_txset..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "tx_data_hex": "...multisig_txset...",
                                        "tx_hash_list": ["4996091b61c1be112c1097fd5e97d8ff8b28f0e5e62e1137a8c831bacf034f2d"]
                                      }
                                    }
                                    

submit_multisig

Submit a signed multisig transaction.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_multisig","params":{"tx_data_hex":"...tx_data_hex..."}}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "tx_hash_list": ["4996091b61c1be112c1097fd5e97d8ff8b28f0e5e62e1137a8c831bacf034f2d"]
                                      }
                                    }
                                    

get_version

Get RPC version Major & Minor integer-format, where Major is the first 16 bits and Minor the last 16 bits.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://localhost:13581/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_version"}' -H 'Content-Type: application/json'
                                    {
                                      "id": "0",
                                      "jsonrpc": "2.0",
                                      "result": {
                                        "version": 65539
                                      }
                                    }