Wallet RPC Guide
​
This is a list of the RPC calls, their inputs and outputs, and examples of each. This list is autogenerated and was last generated on: 2019-04-08
Many RPC calls use the JSON RPC interface while others use their own interfaces, as demonstrated below.
Note: "atomic units" refer to the smallest fraction of 1 BELDEX which is 1e9 atomic units.
Return the wallet's balance.
Endpoints: get_balance, getbalance
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"getbalance",
"params": {
"account_index": 2130706433,
"address_indices": [2130706433, ...]
}
}' -H 'Content-Type: application/json'
Example Response:
{
"balance": 123,
"unlocked_balance": 123,
"multisig_import_needed": true,
"per_subaddress": [{
"address_index": 2130706433,
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"balance": 123,
"unlocked_balance": 123,
"label": "TODO(beldex): Write example string",
"num_unspent_outputs": 123
}, ...]
}
Inputs:
account_index - uint32: Return balance for this account.address_indices - uint32[]: (Optional) Return balance detail for those subaddresses.
Outputs:
balance - uint64: The total balance (atomic units) of the currently opened wallet.unlocked_balance - uint64: Unlocked funds are those funds that are sufficiently deep enough in the beldex blockchain to be considered safe to spend.multisig_import_needed - bool: True if importing multisig data is needed for returning a correct balance.per_subaddress - per_subaddress_info[]: Balance information for each subaddress in an account.address_index - uint32: Index of the subaddress in the account.address - string: Address at this index. Base58 representation of the public keys.balance - uint64: Balance for the subaddress (locked or unlocked).unlocked_balance - uint64: Unlocked funds are those funds that are sufficiently deep enough in the beldex blockchain to be considered safe to spend.label - string: Label for the subaddress.num_unspent_outputs - uint64: Number of unspent outputs available for the subaddress.
Return the wallet's addresses for an account. Optionally filter for specific set of subaddresses.
Endpoints: get_address, getaddress
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"getaddress",
"params": {
"account_index": 2130706433,
"address_index": [2130706433, ...]
}
}' -H 'Content-Type: application/json'
Example Response:
{
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"addresses": [{
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"label": "TODO(beldex): Write example string",
"address_index": 2130706433,
"used": true
}, ...]
}
Inputs:
account_index - uint32: Get the wallet addresses for the specified account.address_index - uint32[]: (Optional) List of subaddresses to return from the aforementioned account.
Outputs:
address - string: (Deprecated) Remains to be compatible with older RPC formataddresses - address_info[]: Addresses informations.address - string: The (sub)address string.label - string: Label of the (sub)address.address_index - uint32: Index of the subaddressused - bool: True if the (sub)address has received funds before.
Get account and address indexes from a specific (sub)address.
Endpoints: get_address_index
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"get_address_index",
"params": {
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"index":
}
Inputs:
address - string: (Sub)address to look for.
Outputs:
index - cryptonote::subaddress_index: Account index followed by the subaddress index.
Create a new address for an account. Optionally, label the new address.
Endpoints: create_address
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"create_address",
"params": {
"account_index": 2130706433,
"label": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"address_index": 2130706433
}
Inputs:
account_index - uint32: Create a new subaddress for this account.label - string: (Optional) Label for the new subaddress.
Outputs:
address - string: The newly requested address.address_index - uint32: Index of the new address in the requested account index.
Label an address.
Endpoints: label_address
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"label_address",
"params": {
"index": ,
"label": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
​
Inputs:
index - cryptonote::subaddress_index: Major & minor address indexlabel - string: Label for the address.
Outputs:
Get all accounts for a wallet. Optionally filter accounts by tag.
Endpoints: get_accounts
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"get_accounts",
"params": {
"tag": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"total_balance": 123,
"total_unlocked_balance": 123,
"subaddress_accounts": [{
"account_index": 2130706433,
"base_address": "TODO(beldex): Write example string",
"balance": 123,
"unlocked_balance": 123,
"label": "TODO(beldex): Write example string",
"tag": "TODO(beldex): Write example string"
}, ...]
}
Inputs:
tag - string: (Optional) Tag for filtering accounts. All accounts if empty, otherwise those accounts with this tag
Outputs:
total_balance - uint64: Total balance of the selected accounts (locked or unlocked).total_unlocked_balance - uint64: Total unlocked balance of the selected accounts.subaddress_accounts - subaddress_account_info[]: Account information.account_index - uint32: Index of the account.base_address - string: The first address of the account (i.e. the primary address).balance - uint64: Balance of the account (locked or unlocked).unlocked_balance - uint64: Unlocked balance for the account.label - string: (Optional) Label of the account.tag - string: (Optional) Tag for filtering accounts.
Create a new account with an optional label.
Endpoints: create_account
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"create_account",
"params": {
"label": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"account_index": 2130706433,
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk"
}
Inputs:
label - string: (Optional) Label for the account.
Outputs:
account_index - uint32: Index of the new account.address - string: The primary address of the new account.
Label an account.
Endpoints: label_account
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"label_account",
"params": {
"account_index": 2130706433,
"label": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
​
Inputs:
account_index - uint32: Account index to set the label for.label - string: Label for the account.
Outputs:
Get a list of user-defined account tags.
Endpoints: get_account_tags
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '{ "jsonrpc":"2.0", "id":"0", "method":"get_account_tags"}' -H 'Content-Type: application/json'
Example Response:
{
"account_tags": [{
"tag": "TODO(beldex): Write example string",
"label": "TODO(beldex): Write example string",
"accounts": [2130706433, ...]
}, ...]
}
Inputs:
Outputs:
account_tags - account_tag_info[]: Account tag information:tag - string: Filter tag.label - string: Label for the tag.accounts - uint32[]: List of tagged account indices.
Apply a filtering tag to a list of accounts.
Endpoints: tag_accounts
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"tag_accounts",
"params": {
"tag": "TODO(beldex): Write example string",
"accounts": [2130706433, ...]
}
}' -H 'Content-Type: application/json'
Example Response:
​
Inputs:
tag - string: Tag for the accounts.accounts - uint32[]: Tag this list of accounts.
Outputs:
Remove filtering tag from a list of accounts.
Endpoints: untag_accounts
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"untag_accounts",
"params": {
"accounts": [2130706433, ...]
}
}' -H 'Content-Type: application/json'
Example Response:
​
Inputs:
accounts - uint32[]: Remove tag from this list of accounts.
Outputs:
Set description for an account tag.
Endpoints: set_account_tag_description
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"set_account_tag_description",
"params": {
"tag": "TODO(beldex): Write example string",
"description": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
​
Inputs:
tag - string: Set a description for this tag.description - string: Description for the tag.
Outputs:
Returns the wallet's current block height.
Endpoints: get_height, getheight
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '{ "jsonrpc":"2.0", "id":"0", "method":"getheight"}' -H 'Content-Type: application/json'
Example Response:
{
"height": 234767
}
Inputs:
Outputs:
height - uint64: The current wallet's blockchain height. If the wallet has been offline for a long time, it may need to catch up with the daemon.
Send beldex to a number of recipients. To preview the transaction fee, set do_not_relay to true and get_tx_metadata to true.
Submit the response using the data in get_tx_metadata in the RPC call, relay_tx.
Endpoints: transfer
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"transfer",
"params": {
"destinations": [, ...],
"account_index": 2130706433,
"subaddr_indices": [2130706433, ...],
"priority": 2130706433,
"mixin": 123,
"ring_size": 123,
"unlock_time": 123,
"payment_id": "f378710e54eeeb8d",
"get_tx_key": true,
"do_not_relay": true,
"get_tx_hex": true,
"get_tx_metadata": true
}
}' -H 'Content-Type: application/json'
Example Response:
{
"tx_hash": "b605cab7e3b9fe1f6d322e3167cd26e1e61c764afa9d733233ef716787786123",
"tx_key": "TODO(beldex): Write example string",
"amount": 123,
"fee": 123,
"tx_blob": "TODO(beldex): Write example string",
"tx_metadata": "TODO(beldex): Write example string",
"multisig_txset": "TODO(beldex): Write example string",
"unsigned_txset": "TODO(beldex): Write example string"
}
Inputs:
destinations - transfer_destination[]: Array of destinations to receive BELDEX.account_index - uint32: (Optional) Transfer from this account index. (Defaults to 0)subaddr_indices - uint32[]: (Optional) Transfer from this set of subaddresses. (Defaults to 0)priority - uint32: Set a priority for the transaction. Accepted Values are: default (1), or 0-3 for: unimportant, normal, elevated, priority.mixin - uint64: (Deprecated) Set to 9. Number of outputs from the blockchain to mix with. Beldex mixin statically set to 9.ring_size - uint64: (Deprecated) Set to 10. Sets ringsize to n (mixin + 1). Beldex ring_size is statically set to 10.unlock_time - uint64: Number of blocks before the beldex can be spent (0 to use the default lock time).payment_id - string: (Optional) Random 64-character hex string to identify a transaction.get_tx_key - bool: (Optional) Return the transaction key after sending.do_not_relay - bool: (Optional) If true, the newly created transaction will not be relayed to the beldex network. (Defaults to false)get_tx_hex - bool: Return the transaction as hex string after sending. (Defaults to false)get_tx_metadata - bool: Return the metadata needed to relay the transaction. (Defaults to false)
Outputs:
tx_hash - string: Publically searchable transaction hash.tx_key - string: Transaction key if get_tx_key is true, otherwise, blank string.amount - uint64: Amount transferred for the transaction.fee - uint64: Fee charged for the txn.tx_blob - string: Raw transaction represented as hex string, if get_tx_hex is true.tx_metadata - string: Set of transaction metadata needed to relay this transfer later, if get_tx_metadata is true.multisig_txset - string: Set of multisig transactions in the process of being signed (empty for non-multisig).unsigned_txset - string: Set of unsigned tx for cold-signing purposes.
Same as transfer, but can split into more than one tx if necessary.
Endpoints: transfer_split
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"transfer_split",
"params": {
"destinations": [, ...],
"account_index": 2130706433,
"subaddr_indices": [2130706433, ...],
"priority": 2130706433,
"mixin": 123,
"ring_size": 123,
"unlock_time": 123,
"payment_id": "f378710e54eeeb8d",
"get_tx_keys": true,
"do_not_relay": true,
"get_tx_hex": true,
"get_tx_metadata": true
}
}' -H 'Content-Type: application/json'
Example Response:
{
"tx_hash_list": ["TODO(beldex): Write example string", ...],
"tx_key_list": ["TODO(beldex): Write example string", ...],
"amount_list": [123, ...],
"fee_list": [123, ...],
"tx_blob_list": ["TODO(beldex): Write example string", ...],
"tx_metadata_list": ["TODO(beldex): Write example string", ...],
"multisig_txset": "TODO(beldex): Write example string",
"unsigned_txset": "TODO(beldex): Write example string"
}
Inputs:
destinations - transfer_destination[]: Array of destinations to receive BELDEX:account_index - uint32: (Optional) Transfer from this account index. (Defaults to 0)subaddr_indices - uint32[]: (Optional) Transfer from this set of subaddresses. (Defaults to 0)priority - uint32: Set a priority for the transactions. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.mixin - uint64: (Ignored) Number of outputs from the blockchain to mix with. Beldex mixin statically set to 9.ring_size - uint64: (Ignored) Sets ringsize to n (mixin + 1). Beldex ring_size is statically set to 10.unlock_time - uint64: Number of blocks before the beldex can be spent (0 to not add a lock).payment_id - string: (Optional) Random 32-byte/64-character hex string to identify a transaction.get_tx_keys - bool: (Optional) Return the transaction keys after sending.do_not_relay - bool: (Optional) If true, the newly created transaction will not be relayed to the beldex network. (Defaults to false)get_tx_hex - bool: Return the transactions as hex string after sending.get_tx_metadata - bool: Return list of transaction metadata needed to relay the transfer later.
Outputs:
tx_hash_list - string[]: The tx hashes of every transaction.tx_key_list - string[]: The transaction keys for every transaction.amount_list - uint64[]: The amount transferred for every transaction.fee_list - uint64[]: The amount of fees paid for every transaction.tx_blob_list - string[]: The tx as hex string for every transaction.tx_metadata_list - string[]: List of transaction metadata needed to relay the transactions later.multisig_txset - string: The set of signing keys used in a multisig transaction (empty for non-multisig).unsigned_txset - string: Set of unsigned tx for cold-signing purposes.
Endpoints: describe_transfer
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"describe_transfer",
"params": {
"unsigned_txset": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"desc": [{
"amount_in": 123,
"amount_out": 123,
"ring_size": 2130706433,
"unlock_time": 123,
"recipients": [{
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"amount": 123
}, ...],
"payment_id": "f378710e54eeeb8d",
"change_amount": 123,
"change_address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"fee": 123,
"dummy_outputs": 2130706433,
"extra": "TODO(beldex): Write example string"
}, ...]
}
Inputs:
unsigned_txset - string: Set of unsigned tx returned by "transfer" or "transfer_split" methods.
Outputs:
desc - transfer_description[]: List of information of transfers.amount_in - uint64: Amount in, in atomic units.amount_out - uint64: amount out, in atomic units.ring_size - uint32: Ring size of transfer.unlock_time - uint64: Number of blocks before the beldex can be spent (0 represents the default network lock time).recipients - recipient[]: List of addresses and amounts.address - string: Destination public address.amount - uint64: Amount in atomic units.
payment_id - string: Payment ID matching the input parameter.change_amount - uint64: Change received from transaction in atomic units.change_address - string: Address the change was sent to.fee - uint64: Fee of the transaction in atomic units.dummy_outputs - uint32extra - string: Data stored in the tx extra represented in hex.
Sign a transaction created on a read-only wallet (in cold-signing process).
Endpoints: sign_transfer
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"sign_transfer",
"params": {
"unsigned_txset": "TODO(beldex): Write example string",
"export_raw": true,
"get_tx_keys": true
}
}' -H 'Content-Type: application/json'
Example Response:
{
"signed_txset": "TODO(beldex): Write example string",
"tx_hash_list": ["TODO(beldex): Write example string", ...],
"tx_raw_list": ["TODO(beldex): Write example string", ...],
"tx_key_list": ["TODO(beldex): Write example string", ...]
}
Inputs:
unsigned_txset - string: Set of unsigned tx returned by "transfer" or "transfer_split" methods.export_raw - bool: (Optional) If true, return the raw transaction data. (Defaults to false)get_tx_keys - bool: (Optional) Return the transaction keys after sending.
Outputs:
signed_txset - string: Set of signed tx to be used for submitting transfer.tx_hash_list - string[]: The tx hashes of every transaction.tx_raw_list - string[]: The tx raw data of every transaction.tx_key_list - string[]: The tx key data of every transaction.
Submit a previously signed transaction on a read-only wallet (in cold-signing process).
Endpoints: submit_transfer
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"submit_transfer",
"params": {
"tx_data_hex": "TODO(beldex): Write example string"
}
}' -H 'Content-Type: application/json'
Example Response:
{
"tx_hash_list": ["TODO(beldex): Write example string", ...]
}
Inputs:
tx_data_hex - string: Set of signed tx returned by "sign_transfer".
Outputs:
tx_hash_list - string[]: The tx hashes of every transaction.
Send all dust outputs back to the wallet's, to make them easier to spend (and mix).
Endpoints: sweep_dust, sweep_unmixable
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"sweep_unmixable",
"params": {
"get_tx_keys": true,
"do_not_relay": true,
"get_tx_hex": true,
"get_tx_metadata": true
}
}' -H 'Content-Type: application/json'
Example Response:
{
"tx_hash_list": ["TODO(beldex): Write example string", ...],
"tx_key_list": ["TODO(beldex): Write example string", ...],
"amount_list": [123, ...],
"fee_list": [123, ...],
"tx_blob_list": ["TODO(beldex): Write example string", ...],
"tx_metadata_list": ["TODO(beldex): Write example string", ...],
"multisig_txset": "TODO(beldex): Write example string",
"unsigned_txset": "TODO(beldex): Write example string"
}
Inputs:
get_tx_keys - bool: (Optional) Return the transaction keys after sending.do_not_relay - bool: (Optional) If true, the newly created transaction will not be relayed to the beldex network. (Defaults to false)get_tx_hex - bool: (Optional) Return the transactions as hex string after sending. (Defaults to false)get_tx_metadata - bool: (Optional) Return list of transaction metadata needed to relay the transfer later. (Defaults to false)
Outputs:
tx_hash_list - string[]: The tx hashes of every transaction.tx_key_list - string[]: The transaction keys for every transaction.amount_list - uint64[]: The amount transferred for every transaction.fee_list - uint64[]: The amount of fees paid for every transaction.tx_blob_list - string[]: The tx as hex string for every transaction.tx_metadata_list - string[]: List of transaction metadata needed to relay the transactions later.multisig_txset - string: The set of signing keys used in a multisig transaction (empty for non-multisig).unsigned_txset - string: Set of unsigned tx for cold-signing purposes.
Send all unlocked balance to an address.
Endpoints: sweep_all
Example Request:
curl -X POST http://127.0.0.1:22023/json_rpc -d '
{
"jsonrpc":"2.0", "id":"0", "method":"sweep_all",
"params": {
"address": "8KJf3nRQ53NTX1YLjtHryjegFRa3ZCEGLKmRxUfvkBWK19UteEacVpYqpYscSJ2q8WRuHPFdk7Q5W8pQB7Py5kvUs8vKSk",
"account_index": 2130706433,
"subaddr_indices": [2130706433, ...],
"priority": 2130706433,
"mixin": 123,
"ring_size": 123,
"outputs": 123,
"unlock_time": 123,
"payment_id": "f378710e54eeeb8d",
"get_tx_keys": true,
"below_amount": 123,
"do_not_relay": true,
"get_tx_hex": true,
"get_tx_metadata": true
}
}' -H 'Content-Type: application/json'
Example Response:
{
"tx_hash_list": ["TODO(beldex): Write example string", ...],
"tx_key_list": ["TODO(beldex): Write example string", ...],
"amount_list": [123, ...],
"fee_list": [123, ...],
"tx_blob_list": ["TODO(beldex): Write example string", ...],
"tx_metadata_list": ["TODO(beldex): Write example string", ...],
"multisig_txset": "TODO(beldex): Write example string",
"unsigned_txset": "TODO(beldex): Write example string"
}
Inputs:
address - string: Destination public address.account_index - uint32: Sweep transactions from this account.subaddr_indices - uint32[]: (Optional) Sweep from this set of subaddresses in the account.priority - uint32: (Optional) Priority for sending the sweep transfer, partially determines fee.mixin - uint64: (Deprecated) Set to 9. Number of outputs from the blockchain to mix with. Beldex mixin statically set to 9.ring_size - uint64: (Deprecated) Set to 10. Sets ringsize to n (mixin + 1). Beldex ring_size is statically set to 10.