add_address_book

Add an entry to the address book.

Alias: None.

Inputs:

• address - string;
• payment_id - (optional) string, defaults to "0000000000000000000000000000000000000000000000000000000000000000";
• description - (optional) string, defaults to "";

Outputs:

• index - unsigned int; The index of the address book entry.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"add_address_book","params":{"address":"RYoSrF9zAg4aR2Y3ts1h24VKxE7WSZJ1GEq6NHBMqyUFCWA1g7Nw3mGe2KTrSKewV9SUrwyv9g3FeU3jqft6LFy5A1pUR2inaj1","description":"1st account"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "index":0
    }
}

start_mining

Start mining in the Ryo daemon.

Alias: None.

Inputs:

• threads_count - unsigned int; Number of threads created for mining.
• do_background_mining - boolean; Allow to start the miner in smart mining mode.
• ignore_battery - boolean; Ignore battery status (for smart mining only)

Outputs: None.

Request:

curl -X POST http://localhost:12215/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'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

stop_mining

Stop mining in the Ryo daemon.

Alias: None.

Inputs: None.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

get_balance

Return the wallet's balance.

Alias: getbalance.

Inputs:

• account_index - unsigned int; Return balance for this account.
• address_indices - array of unsigned int; (Optional) Return balance detail for those subaddresses.

Outputs:

• balance - unsigned int; The total balance of the current ryo-wallet-rpc in session.
• unlocked_balance - unsigned int; Unlocked funds are those funds that are sufficiently deep enough in the Ryo blockchain to be considered safe to spend.
• multisig_import_needed - boolean; True if importing multisig data is needed for returning a correct balance.
• per_subaddress - array of subaddress information; Balance information for each subaddress in an account.
  • address_index - unsigned int; Index of the subaddress in the account.
  • address - string; Address at this index. Base58 representation of the public keys.
  • balance - unsigned int; Balance for the subaddress (locked or unlocked).
  • unlocked_balance - unsigned int; Unlocked balance for the subaddress.
  • label - string; Label for the subaddress.
  • num_unspent_outputs - unsigned int; Number of unspent outputs available for the subaddress.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_balance","params":{"account_index":0,"address_indices":[0,1]}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "balance":4242,
        "multisig_import_needed":false,
        "per_subaddress":[
            {
                "address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY",
                "address_index":0,
                "balance":4242,
                "label":"Primary account",
                "num_unspent_outputs":2,
                "unlocked_balance":4242
            }
        ],
        "unlocked_balance":4242
    }
}
            

get_address

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

Alias: getaddress.

Inputs:

• account_index - unsigned int; Return subaddresses for this account.
• address_index - array of unsigned int; (Optional) List of subaddresses to return from an account.

Outputs:

• address - string; The 95-character hex address string of the ryo-wallet-rpc in session.
• addresses array of addresses informations
  • address string; The 95-character hex (sub)address string.
  • label string; Label of the (sub)address
  • address_index unsigned int; index of the subaddress
  • used boolean; states if the (sub)address has already received funds

Request:

curl -X POST http://127.0.0.1:12215/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'

Response:

                {
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY",
        "addresses":[
            {
                "address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY",
                "address_index":0,
                "label":"Primary account",
                "used":true
            },
            {
                "address":"RYoSrJEM9qfAZPQxRjcP22J28fmcCk55taG6k9c1SSmcY1uBsaUFzX26X1bUaN9kQMfuNjX7T3SzC1u9WAXPJH2cWjn9wvim1Qs",
                "address_index":1,
                "label":"",
                "used":false
            },
            {
                "address":"RYoSrDP4GHe7ti7nFJBrQQDb6NpGZGWA57PjSa7A66P95auvCiwDp6fFL32iVSZvmc8K3dwr82P2SLmHr3iADhAtCCk5GHET2D1",
                "address_index":4,
                "label":"",
                "used":false
            }
        ]
    }
}
            

create_address

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

Alias: None.

Inputs:

• account_index - unsigned int; Create a new address for this account.
• label - string; (Optional) Label for the new address.

Outputs:

• address - string; Newly created address. Base58 representation of the public keys.
• address_index - unsigned int; Index of the new address under the input account.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"create_address","params":{"account_index":0,"label":"new-sub"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "address":"RYoSrJEM9qfAZPQxRjcP22J28fmcCk55taG6k9c1SSmcY1uBsaUFzX26X1bUaN9kQMfuNjX7T3SzC1u9WAXPJH2cWjn9wvim1Qs",
        "address_index":1
    }
}
            

get_accounts

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

Alias: None.

Inputs:

• tag - string; (Optional) Tag for filtering accounts.

Outputs:

• subaddress_accounts - array of subaddress account information:
  • account_index - unsigned int; Index of the account.
  • balance - unsigned int; Balance of the account (locked or unlocked).
  • base_address - string; Base64 representation of the first subaddress in the account.
  • label - string; (Optional) Label of the account.
  • tag - string; (Optional) Tag for filtering accounts.
  • unlocked_balance - unsigned int; Unlocked balance for the account.
• total_balance - unsigned int; Total balance of the selected accounts (locked or unlocked).
• total_unlocked_balance - unsigned int; Total unlocked balance of the selected accounts.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_accounts","params":{"tag":"myTag"}}' -H 'Content-Type: application/json'

Response:

                {
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "subaddress_accounts":[
            {
                "account_index":0,
                "balance":0,
                "base_address":"RYoLseSV7WGdMFijLPXNffMWEFxq17ZbtENpB8hqH7d3FLQqkadt3tgi2Z9Afw135BeQGC87bKYxKc6feRTgDY883kqvAAVLEUb",
                "label":"Primary account",
                "tag":"myTag",
                "unlocked_balance":0
            },
            {
                "account_index":1,
                "balance":0,
                "base_address":"RYoSrJv53kzGWQkU2ausiTEGDaRPTcQn4h6DVSnpvyWE8ta5rJF4cPCfx2TkpkD7JMWiGLjEz7QthR7NgqtLVYXkasLthmrbjRm",
                "label":"Secondary account",
                "tag":"myTag",
                "unlocked_balance":0
            }
        ],
        "total_balance":0,
        "total_unlocked_balance":0
    }
}

When the filtered on tag isn't assigned to any addresses:
{
  "error": {
    "code": -1,
    "message": "Tag myTag is unregistered."
  },
  "id": "0",
  "jsonrpc": "2.0"
}

label_account

Label an account.

Alias: None.

Inputs:

• account_index - unsigned int; Apply label to account at this index.
• label - string; Label for the account.

Outputs: None.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_account","params":{"account_index":0,"label":"Primary account"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

get_account_tags

Get a list of user-defined account tags.

Alias: None.

Inputs: None.

Outputs:

• account_tags - array of account tag information:
  • tag - string; Filter tag.
  • label - string; Label for the tag.
  • accounts - array of int; List of tagged account indices.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"1","method":"get_account_tags","params":""}' -H 'Content-Type: application/json'

Response:

{
    "id":"1",
    "jsonrpc":"2.0",
    "result":{
        "account_tags":[
            {
                "accounts":[
                    0
                ],
                "label":"",
                "tag":"myTag0"
            },
            {
                "accounts":[
                    1
                ],
                "label":"",
                "tag":"myTag1"
            }
        ]
    }
}

tag_accounts

Apply a filtering tag to a list of accounts.

Alias: None.

Inputs:

• tag - string; Tag for the accounts.
• accounts - array of unsigned int; Tag this list of accounts.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

untag_accounts

Remove filtering tag from a list of accounts.

Alias: None.

Inputs:

• accounts - array of unsigned int; Remove tag from this list of accounts.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

set_account_tag_description

Set description for an account tag.

Alias: None.

Inputs:

• tag - string; Set a description for this tag.
• description - string; Description for the tag.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

get_height

Returns the wallet's current block height.

Alias: getheight.

Inputs: None.

Outputs:

• height - unsigned int; The current ryo-wallet-rpc's blockchain height. If the wallet has been offline for a long time, it may need to catch up with the daemon.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_height"}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "height":192713
    }
}

transfer

Send Ryo to a number of recipients.

Alias: None.

Inputs:

• destinations - array of destinations to receive Ryo:
  • amount - unsigned int; Amount to send to each destination, in atomic units.
  • address - string; Destination public address.
• account_index - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)
• subaddr_indices - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)
• priority - unsigned int; Set a priority for the transaction. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.
• mixin - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).
• ring_size - unsigned int; Number of outputs to mix in the transaction (this output + N decoys from the blockchain).
• unlock_time - unsigned int; Number of blocks before the ryo 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_key - boolean; (Optional) Return the transaction key after sending.
• do_not_relay - boolean; (Optional) If true, the newly created transaction will not be relayed to the ryo network. (Defaults to false)
• get_tx_hex - boolean; Return the transaction as hex string after sending (Defaults to false)
• get_tx_metadata - boolean; Return the metadata needed to relay the transaction. (Defaults to false)

Outputs:

• amount - Amount transferred for the transaction.
• fee - Integer value of the fee charged for the txn.
• multisig_txset - Set of multisig transactions in the process of being signed (empty for non-multisig).
• tx_blob - Raw transaction represented as hex string, if get_tx_hex is true.
• tx_hash - String for the publically searchable transaction hash.
• tx_key - String for the transaction key if get_tx_key is true, otherwise, blank string.
• tx_metadata - Set of transaction metadata needed to relay this transfer later, if get_tx_metadata is true.
• unsigned_txset - String. Set of unsigned tx for cold-signing purposes.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params:{"destinations":[{"amount":1000000411,"address":"RYoKswMJiouLp2u9jTBMphPiTNR3NzTWSX16GdLiuwX38ksHytnQnBZ"},{"amount":1000000042,"address":"RYoLsedkTcWcTgfaMTnUBq1kBGhw1VsH1TnZbCCnaEAL3iF1XfbZg7jezQecxz5gZsbmwZgKdHhrE8E126Kzje2sMPaNC7asCiN"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":13,"get_tx_key": true}}' -H 'Content-Type: applicati on/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "amount":2000000453,
        "fee":17000000,
        "multisig_txset":"",
        "tx_blob":"",
        "tx_hash":"e9dc5dab2d5c2a6bfc0cdf7d8d0bfedd03600d963090f337165f47587b379b56",
        "tx_key":"637c83bcf6797d633b141da7fe09d91da7a631c10aa3fc0a833db3432fba670b",
        "tx_metadata":""
    }
}
            

sign_transfer

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

Alias: None.

Inputs:

• unsigned_txset - string. Set of unsigned tx returned by "transfer" or "transfer_split" methods.
• export_raw - boolean; (Optional) If true, return the raw transaction data. (Defaults to false)

Outputs:

• signed_txset - string. Set of signed tx to be used for submitting transfer.
• tx_hash_list - array of: string. The tx hashes of every transaction.
• tx_raw_list - array of: string. The tx raw data of every transaction.

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:

submit_transfer

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

Alias: None.

Inputs:

• tx_data_hex - string; Set of signed tx returned by "sign_transfer"

Outputs:

• tx_hash_list - array of: string. The tx hashes of every transaction.

/sweep_dust

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

Alias: sweep_unmixable.

Inputs:

• get_tx_keys - boolean; (Optional) Return the transaction keys after sending.
• do_not_relay - boolean; (Optional) If true, the newly created transaction will not be relayed to the ryo network. (Defaults to false)
• get_tx_hex - boolean; (Optional) Return the transactions as hex string after sending. (Defaults to false)
• get_tx_metadata - boolean; (Optional) Return list of transaction metadata needed to relay the transfer later. (Defaults to false)

Outputs:

• tx_hash_list - array of: string. The tx hashes of every transaction.
• tx_key_list - array of: string. The transaction keys for every transaction.
• amount_list - array of: integer. The amount transferred for every transaction.
• fee_list - array of: integer. The amount of fees paid for every transaction.
• tx_blob_list - array of: string. The tx as hex string for every transaction.
• tx_metadata_list - array of: 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.

/store

Save the wallet file.

Alias: None.

Inputs: None.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

get_payments

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

Alias: None.

Inputs:

• payment_id - string; Payment ID used to find the payments (16 characters hex).

Outputs:

• payments - list of:
  • payment_id - string; Payment ID matching the input parameter.
  • tx_hash - string; Transaction hash used as the transaction ID.
  • amount - unsigned int; Amount for this payment.
  • block_height - unsigned int; Height of the block that first confirmed this payment.
  • unlock_time - unsigned int; Time (in block height) until this payment is safe to spend.
  • subaddr_index - subaddress index:
    • major - unsigned int; Account index for the subaddress.
    • minor - unsigned int; Index of the subaddress in the account.
  • address - string; Address receiving the payment; Base58 representation of the public keys.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_payments","params":{"payment_id":"d88d7c9ddacae9c1"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "payments":[
            {
                "address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY",
                "amount":500000000,
                "block_height":196431,
                "payment_id":"d88d7c9ddacae9c1",
                "subaddr_index":{
                    "major":0,
                    "minor":0
                },
                "tx_hash":"3bdce90152604154ac8936cb59d58e4afb262bb01a58c1aec2fc74f9183b2592",
                "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:

• payment_ids - array of: string; Payment IDs used to find the payments (16 characters hex).
• min_block_height - unsigned int; The block height at which to start looking for payments.

Outputs:

• payments - list of:
  • payment_id - string; Payment ID matching one of the input IDs.
  • tx_hash - string; Transaction hash used as the transaction ID.
  • amount - unsigned int; Amount for this payment.
  • block_height - unsigned int; Height of the block that first confirmed this payment.
  • unlock_time - unsigned int; Time (in block height) until this payment is safe to spend.
  • subaddr_index - subaddress index:
    • major - unsigned int; Account index for the subaddress.
    • minor - unsigned int; Index of the subaddress in the account.
  • address - string; Address receiving the payment; Base58 representation of the public keys.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_bulk_payments","params":{"payment_ids":["d88d7c9ddacae9c1"],"min_block_height":"196000"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "payments":[
            {
                "address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY",
                "amount":500000000,
                "block_height":196431,
                "payment_id":"d88d7c9ddacae9c1",
                "subaddr_index":{
                    "major":0,
                    "minor":0
                },
                "tx_hash":"3bdce90152604154ac8936cb59d58e4afb262bb01a58c1aec2fc74f9183b2592",
                "unlock_time":0
            }
        ]
    }
}

incoming_transfers

Return a list of incoming transfers to the wallet.

Inputs:

• transfer_type - string; "all": all the transfers, "available": only transfers which are not yet spent, OR "unavailable": only transfers which are already spent.
• account_index - unsigned int; (Optional) Return transfers for this account. (defaults to 0)
• subaddr_indices - array of unsigned int; (Optional) Return transfers sent to these subaddresses.
• verbose - boolean; (Optional) Enable verbose output, return key image if true.

Outputs:

• transfers - list of:
  • amount - unsigned int; Amount of this transfer.
  • global_index - unsigned int; Mostly internal use, can be ignored by most users.
  • key_image - string; Key image for the incoming transfer's unspent output (empty unless verbose is true).
  • spent - boolean; Indicates if this transfer has been spent.
  • subaddr_index - unsigned int; Subaddress index for incoming transfer.
  • tx_hash - string; Several incoming transfers may share the same hash if they were in the same transaction.
  • tx_size - unsigned int; Size of transaction in bytes.

Example, get all transfers: curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"all","account_index":0,"verbose":true}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "transfers":[
            {
                "amount":1000000411,
                "global_index":1938236,
                "key_image":"832f6cc913d1558275df87b44db5ca175f5a97a89267398b979f4ab08feeb816",
                "spent":false,
                "subaddr_index":0,
                "tx_hash":"eec97b86454ff04acf0f1cf6d625ba2062833d67f07d346055ee2fa4efaa3957",
                "tx_size":277
            },
            {
                "amount":411,
                "global_index":1938259,
                "key_image":"f3c027605fe867b2156a846a246d93207fbf783a6abdeeec7e0d72a4a8c80943",
                "spent":false,
                "subaddr_index":0,
                "tx_hash":"7a1477549dceebc91832e3698cc2e8b80aa023426f1fb1f8e54393b4a86d8ead",
                "tx_size":278
            }
        ]
    }
}

Example, get available transfers:
curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"available","account_index":0,"verbose":true}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "transfers":[
            {
                "amount":1000000411,
                "global_index":1938236,
                "key_image":"832f6cc913d1558275df87b44db5ca175f5a97a89267398b979f4ab08feeb816",
                "spent":false,
                "subaddr_index":0,
                "tx_hash":"eec97b86454ff04acf0f1cf6d625ba2062833d67f07d346055ee2fa4efaa3957",
                "tx_size":277
            },
            {
                "amount":411,
                "global_index":1938259,
                "key_image":"f3c027605fe867b2156a846a246d93207fbf783a6abdeeec7e0d72a4a8c80943",
                "spent":false,
                "subaddr_index":0,
                "tx_hash":"7a1477549dceebc91832e3698cc2e8b80aa023426f1fb1f8e54393b4a86d8ead",
                "tx_size":278
            }
        ]
    }
}

Example, get unavailable (already spent outputs) transfers:
curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"incoming_transfers","params":{"transfer_type":"unavailable","account_index":0,"verbose":true}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "transfers":[
            {
                "amount":42,
                "global_index":1916795,
                "key_image":"c74e20e795e42ecd371121328890aaefb04d5fd1fe83a9d004525a5724c13fac",
                "spent":true,
                "subaddr_index":0,
                "tx_hash":"8db01164118ff929cbdded9cfd82512fc46f2ed9d954dfd53d30978917d7d8b7",
                "tx_size":244
            },
            {
                "amount":1000000000,
                "global_index":1934981,
                "key_image":"914a98f5a41b15c3cb6570062391933fbcb2842337a35a117908dd84658f86fd",
                "spent":true,
                "subaddr_index":0,
                "tx_hash":"0e6343b70001df5b5c834612866d6414f713a7c2c8a09b260b2c649a7acee6f4",
                "tx_size":244
            },
            {
                "amount":2000000000,
                "global_index":1935160,
                "key_image":"ca37e175365c8cde067fc2bbaa9e332f3246f8d60b2826380f20c74ef769d1f0",
                "spent":true,
                "subaddr_index":0,
                "tx_hash":"1f5da095d97d37be308f23142aed77dab51c9b357b5eea389127df497e233d9e",
                "tx_size":172
            }
        ]
    }
}
            

stop_wallet

Stops the wallet, storing the current state.

Alias: None.

Inputs: None.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

set_tx_notes

Set arbitrary string notes for transactions.

Alias: None.

Inputs:

• txids - array of string; transaction ids
• notes - array of string; notes for the transactions

Outputs: None.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_tx_notes","params":{"txids":["c595e58c057a9a831fb94efdc3fbfe34d482ebdbf57ee084e4e81002739c52fd"],"notes":["Nostradamus knows the future"]}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

get_tx_proof

Get transaction signature to prove it.

Alias: None.

Inputs:

• txid - string; transaction id.
• address - string; destination public address of the transaction.
• message - string; (Optional) add a message to the signature to further authenticate the prooving process.

Outputs:

• signature - string; transaction signature.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_proof","params":{"txid":"7a1477549dceebc91832e3698cc2e8b80aa023426f1fb1f8e54393b4a86d8ead","address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY","message":"John Snow knows NOTHING!"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "signature":"InProofV1GNUGf8Ty32UPR52dVqAVJvjYtNnQWvtinG1YAbFviYKvKaZMakCHCMjPSrc517doh5HDQaNw1CmqxZNuvsPGFCotjE6Z6tQb6b72CovxpWcrD44mUHagXQXHg7g7S7TRuGTh"
    }
}
            

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:

• txid - string; transaction id.
• message - string; (Optional) add a message to the signature to further authenticate the prooving process.

Outputs:

• signature - string; transaction signature.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_spend_proof","params":{"txid":"7a1477549dceebc91832e3698cc2e8b80aa023426f1fb1f8e54393b4a86d8ead","message":"The monkey Jules has no friends"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "signature":"SpendProofV1f9PKMjyb2WREM2QJdNgGE1J6WkJUMsRWpexDt5MpghV5Bmp5qrAZFbC1AZ1SXJnW5hP8VYsFPt9TE1P7NWXwJFemgvvsMa5C7uRRUUWUbt62mWA8tBuUdPCoNiV7HYGBRpbs7h9q1L1aA8XaXsrsw8wYWP18hxkxny8Cv2RU4iYEf8d2STb43xvG72SUcAHKSGA8S7TEfmi27JrWbGF4Sz71h3gojZn3sGrSHDoSVnPQ8LrY79T9UpN8p5RhBGip5GtPQzG76C2k1HPFUCeEEuboNTokBURFuRXy8WnKLB9Epv4GEK9K76rvbYpuuVVMa46P8CiZzYbpWAd6pLksnQPiVHEFCixVKFArrFfYBm9A33JJjFj3ZZ1p2K641WJXMfGFnrWSSChLh6Ksbm7z9VDiL3XZFVRMTmVkCUaAMvKBdjFTqZQN8GvgDU6hd5r53cc2qzK6GuvKdJPt1gkkiafhLXJYT4gMS8HiEBoLsyFmexPR4kMJT3uK6Mgo7cjkD7cG4ike4VYsKj6fK14ui7N3oBnJaZrrRJcH2i6LTwqoPADbRgsbNSNPf8yrB6ooz5nH2d7QJGEjAb44y7gv3HTNTY9Tn65ynQAjUiLxK6oqpAUkFah8TNhCpDo4hyFKmAvvMWA45WMyX2qhsUta4oHvNVkBZhfAZrSCt8yK2ccfhsdpBw1DQ1AY888onwyuF3HpkdPThBbRk2KeNdNc8gVKaCxww7osYU97pWhUJ9SYWgZnEFvj4q62PH9Rv6RKnoE2ogPpwsk7FXtvFXFcfcD1HWUvEuaMrndC96bPJ1U9STNXB28NkPKM1iAoPntRVf8MGuFazRp3NyJMB1BzeEHqoPJcFBCFbYZ6wQ9gazY8dnaAWeP6J4Xz8LNSWcGBAgT2st7UZE6c7qtWMKjp5KpxEwU2ikqxbBg2jhJ2BNpMRTkbHQUQ9hTvU7GZNRUhSWua467v8b4T8eiJNdCNCGkJTnT821daTdQasmmD6axHokJx8BpCXEWLNWT8cnqRA7GBGmLxDwMcywFFVTaDKKNvBAqek98A5h5AoALMMqH7Zh996kMfCBfU8Ros1ZvXWKnqQbquX4p6NrqHqMrmWUw67Nw2op2wrNH9g7cAr785z9LqxMU2VtPKTbnNnF3z86GWsn8Z1HjjxVau5Fb3CfxmyDaAXwm3qmUZPdeostz4QJLKinGnbfqTiQ7HGfoh6MCfgVhytBdnbRELdXq1GURCj4HcZ6iAVp7U7TiFSQsXxhSuZUf5pCepxF6CEUq5evUTLhB43P9AhRUmZuSD8tbN9m839iH1BLzpGRmC4FWDV5xgWToiZjQpUfT8HFAafpHwKNrAp1YGX1ZkJfiE9r13Qf1rE2nZvtyfCQm9xNLJcAtmcuQDYYFdkCVTR5nZHCqdSfDkFXURANF4KqxuJg9CbbhDf4LYoNQpv7ibCCuy3M4Z7CrDFFhLuKFEumpsjEfWdm9Rc6naBTqn6Seu4cC31jHY4YX9F4vbr2YWataY6iSbuxHHoQxXvPkMfjakB9aGMmuogDFDVvRgNKgdnMXzBhcVRhrozwRqVQK14L8oMWiG8uWM17jsCjNBPAdwsMKhbDMGzXeCc6DWT23pyR7bkWZSR5tYC9RQxVpgYGCs4N15qXa54RHnmBsQWTQeQMip2TKTgzGzK586Rj9Z9k4hkLJqAwR4iueRxoHm7Pi73BtLA1zeiyKvcpk5tjoNQEWbrekvpyWSpa8EJSDm78NDzwTssvLQYW4cdLekwCiYXMd21oLBSfbnfbzx73uMjdSfawEjBNjzgGPt46s9jD1TnJmZmMYCpMiZ5Hg2BrKJAbWpqc9a7guBNsGeHfrwYhyTG7zDBAA33ybxdwQsYckKsWMML6tbTisYattPoGJ2Fac8j4LJoA21Vr9kynAZ2rFu1icKkuZHHRxrKxnydY4FY4kEqisE58t3k6RY4s2JSxM7XVH63Z8GDETUKoUmiorpWQHCMwXgAyX91eRTSKtGgSZF9aYfWxbFUMxgNzosyGcvUjUbzGQjZVs8c5VFzP1Hgc9Bdje5xD78nQvMVYXwr3qLGPdcbZc1vEgKioD2o93V1DcNsNbgEWyzWrZJXGwyHxGychUAMr5mVMiv2jj9nsS4D8ZNAQpk9cvtLMAdZhpW847Fw1zhcdvzQ2rMD2VCUAu2uShCHBe18zBdanwNL8gxe6pZa5mHPQM9XknoMJUs73hxxnsxQVyXBEGeKXADPviZWimNPmpWhBnZ8pnSbCTegkSxHzrhQ6sx6B7jwvfo"
    }
}
            

/check_reserve_proof

Proves a wallet as a disposable reserve using a signature.

Alias: None.

Inputs:

• address - string; Public address of the wallet.
• message - string; (Optional) Should be the same message used in get_reserve_proof.
• signature - string; transaction signature to confirm.

Outputs:

• good - boolean; States if the inputs proves the transaction.

Returns a list of transfers.

Alias: None.

Inputs:

• in - boolean; (Optional) Include incoming transfers.
• out - boolean; (Optional) Include outgoing transfers.
• pending - boolean; (Optional) Include pending transfers.
• failed - boolean; (Optional) Include failed transfers.
• pool - boolean; (Optional) Include transfers from the daemon's transaction pool.
• filter_by_height - boolean; (Optional) Filter transfers by block height.
• min_height - unsigned int; (Optional) Minimum block height to scan for transfers, if filtering by height is enabled.
• max_height - unsigned int; (Opional) Maximum block height to scan for transfers, if filtering by height is enabled (defaults to max block height).
• account_index - unsigned int; (Optional) Index of the account to query for transfers. (defaults to 0)
• subaddr_indices - array of unsigned int; (Optional) List of subaddress indices to query for transfers. (defaults to 0)

Outputs:

• in array of transfers:
  • address - string; Public address of the transfer.
  • amount - unsigned int; Amount transferred.
  • confirmations - unsigned int; Number of block mined since the block containing this transaction (or block height at which the transaction should be added to a block if not yet confirmed).
  • double_spend_seen - boolean; True if the key image(s) for the transfer have been seen before.
  • fee - unsigned int; Transaction fee for this transfer.
  • height - unsigned int; Height of the first block that confirmed this transfer (0 if not mined yet).
  • note - string; Note about this transfer.
  • payment_id - string; Payment ID for this transfer.
  • subaddr_index - JSON object containing the major & minor subaddress index:
    • major - unsigned int; Account index for the subaddress.
    • minor - unsigned int; Index of the subaddress under the account.
  • suggested_confirmations_threshold - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.
  • timestamp - unsigned int; POSIX timestamp for when this transfer was first confirmed in a block (or timestamp submission if not mined yet).
  • txid - string; Transaction ID for this transfer.
  • type - string; Transfer type: "in"
  • unlock_time - unsigned int; Number of blocks until transfer is safely spendable.
• out array of transfers (see above).
• pending array of transfers (see above).
• failed array of transfers (see above).
• pool array of transfers (see above).

Request:

In the example below, the reserve has been proven: curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112Wfh1111118PKz8tVddiuAC4fhpN116U5efs9vS82eLMPdZY2FoP2296BDS7113UaRiFDreV5SEGHJo7Cn4eaAq2ue6KkBspBjb9Bx39Xd3RHG71yvfbwjfwJBW39ZD7ujYBEfSquFZGAbGbybFDgzpagTYMMxj113kcrAyoDgNiKGKuSdwMCRVMCn8S9Eiy2zkyrvJfE1hS8h2th6wno63GP1KH3ciUzhz82ZaMwDjnSVTPtaDhikiJFnUcuktPZJ8HURrvhib2MRZyEdx8kojaaL1edMjRcvnKfrC3q24Cu9ePJ28sqDAqfcXiabx2csemVkczUBcvmeAEenMqNuGj9B4RYjbdhuVsu9WgULTBi41PTnY88PRwMmnCJaiXqoA1jv1Ak9cHApHYkjWRPSoNn6ryXYyNZqg8BjdJnYp52Lj5gjKfnzRxe4WS5TayoCfBvHUUgDXt2KRvm4egXHekw8zAddVvnwJwgot6M5MFb6ci4xseZuUKF99DNd43vUaatpAnNuj6k49iCUhxjC9xmABYJycyTqfPEb5LVhegDW7cFT54Xb3KPnjkiGaaUBoVkgqxfXRwcFaT2cKrFfQZy5meRT8PSmgB4QnErDZsc2g2gJNRsPioT5tQRkXVPN7hmbRaNBbP4RiRMAqEeiybf1Ak9kFwCEibK4qt2yG2FEc9PwATJ7affi7hswQRdEyeVAvevrspAjHeey74cLxqTHqGVJL5SKvHec5yfqneHhup1DjFiGfpTqQC6VU8X8eRVVQ52WxVRD7iDLHpsjqknQoP4WSMqzyQ5XYQG4AHyWjwVHeR9yJeSAnZKvBEPU1x6ssxMPJAZZhqvXTL9oo67arU6oWFdaK6g5pKhLQigivokVNWjTqfJ8Tf21cWECNpd4TfABWan5DBATfYATUc6XMs44mEfUPTsnjXE7PPbVhw3zs9UkiaKyjQM2LAhNABEwdCDQ2bBWFHkZaTBfLAWAougJTWUBnS5Bkqj3ws8rXzj4RZKXYvfNu6rGPgZLu1fpJF91Wh7h91Bx1GqbMxomJdYipqKVJURZx6Bi7vfu3GNFTT8EgsqVU3kAMkwyV7QbZL2vHR3DLcHWziS2MzpRS7heQqKTW7fg79Hh7fLZTK7a8e182TrDndSQSRS5mpw6o78dqLw4HG42eYU4nffPNta8fURTMV1GQoz3p5evHm4zbcXCtohTVnZm4XtQGsUYtNaBK8jeytivZMW7mXK9JAFHEo5uYg7xABFGcFeCfix5Arq45e68fDkG9ogd7VHtnVdinrXMXns88aoFUfVSYVA8vsKT1Bx4JNxLQyUhC8s1UtTadzY8fJ2GUSXCG9m7ieQ1gmw7AbGa6qhoMMfQKyrASRVXpYXgiQgCM9FSCJszp74p8nVoWPoH642wWwqRz86j55i4oA64kwiVFC1bBdb2T6CA5aWaZZaW9rcjcj61D8wFsjXSwEK2ePxWEkwoCe2y264x6BJ2GnhdAL3PLhCJEnKjDAK56UAA9wAi6AwxtdkiAARWMurJ21Sr8KNFaJsFtiThvPtbR2Sz7k8QKvAEe4Ka5c5Vf6hABvR4gTsotuL25YBjYwoJJJ1xXoynGqx1D8bsvSY5GiUrJf7YqsuRYXs8RrmkQGepCG1BvrRvaKsCsVM28Besiffoc2YrddN6tvk9LT4Zj63LppNkMSqSrPf4TeWX9VddGgiQaf8RKnAJKECNjHMtRYRFu9edUsnRdgPq7fX37MmPhBeJPCnB7mXxLN5eYReJZX1g5d1GM4Vr"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "good":true,
        "spent":0,
        "total":13918002061
    }
}
In the example below, all wallet reserve has been proven:
curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY","message":"Full proof of ALL","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112Wfh1111118Nv46ginpB3bqyC6Hd7TP2Yigtp1Dkv8BAHY8yVYBJp9jspZQK113URmZVHh77K6shdb684NVtAphm2ioJ8dQjfLaDY8bCVw5Uh5Y2k42cqNJkRo2vQZ5scN41XMFFtXsACBhGbp61HdZ6VdGL29d113keChLFA7RqY4FgNAnFDQ9nPDdfKB9Kff6N99fp1EL4SUxrbhvbUXhV7ZKvKvJbNNQ4oeQ165UEMrvkHbV8XuLZTxNCyz2hcBA2eX6HSNCxYAkCnm6z3uwkTLB5AkvU7ZiD7LsWRSaVE95fdsYkCSQ333L24UDBVCpsXv1xMZiusdM9BHCGui4hGUdrprzXJ9aCB39tHqyVZemQH4qSNdi7pWhGwKiW2S9i1E1LSpc3MESPgV5SEGHJo7Cn4eaAq2ue6KkBspBjb9Bx39Xd3RHPV9VKf9bhxVwFMtv7T8ZjSAAjApVVP8e9KfqeB9AQ3NLNMqYYbenwFa132zxuBiGq5XUAGwXR3uHj7YJpVMSDHcTXKR34YFPCN6tbCF9sSsxp4P4L1RoWrzjTBMBgQUPUHDBKNHeQ8BrsTtJQUdRBPwcqJ1BM7bZKU5U4nTNvJJSNcrzTAkDet1a5RATuWV3MaiSyWT8oNqa4AyACenLsrQSgAWL8JRK7D2LerzW8U5F2ENWHgJcQk3o7Jzz26j43WXMweChZHMVV8VUPP5iGBao8guBdKPAaFcDBKjFQLfB7HPDx3jrih6RSeZZhjoxwTMgC6T6qpX6Tb442XTcHVPrXou4pia3NdTWikV4VDR3zLDnfFDevrGcq5hDgB33QsGHG1cGfcjaXYY5KQATXX3Z5TtF8Pzanf9x8a6daxKQsa3cKhMLUJdABAaq3geQoTpUUZZUshW789TSoo7Zcna2aeE9eMghCZLj8hCZcmS9XzGA4rNPgCv7Bn5TkuvFcqemAPPUy72ErFxAtFPFCb7pzNY4ehTc48ukox2qgQHf4RYjbdhuVsu9WgULTBi41PTnY88PRwMmnCJaiXqoA1jv1Ak9cHApHYkjWRPSoNn6ryXYyNZqg8BjdJnYp52Lj5gjKfnzRxe4WS5TayoCfBvHUUgDXt2KRvm4egXHekw8zAddVvnwJwgotAEEvvWY5WT3S2QZ1umxvpGvLNvT4SB3JeTBLCF4z1m9vCKQg5wD8bXQrXUaQvRwMgBZx9LBWYbnmJpmU2vYoYr2bjWBsEWS87Vd2M1cByEDGPu4fKNB7u6KLXFwX8ui4kMcTYH2Q5rfFcdoD6U2rHgaTon99L9tE2mD5SowVEkMWwKnD4K21FWtEtD5gpMWQfzg8kirWj9eZrY2TZMnNDsEZxTfaZYT9YLZX4xVHWRHYLCvWmcYHKvH8YN5uUkKLhqSu4N3d7mhpXuhfnJWSjACsfNdfXCCZbt3zpRmeyyoNUXCqyDX7QG6J9vM5vYhQT1D97YGF2XX5BWZkeWsQMjz1wLenE16UxqL8skiPiBh5EMaTHNAwBLDKKjhJKUmFeYjCk3r3QRK4hPcGCHjyZba4dHQ4iK8Z1fuugmgB3cphVs95pi7CtTbuuniFR3iAK61HdhZuo24JbknwZAU4Y9MZqYE84dpAHDk6aKf7HD62wvCgmWryNuinvmon1BvrRvaKsCsVM28Besiffoc2YrddN6tvk9LT4Zj63LppNkMSqSj8Az1arHgS2VQuGm5Ldzp8foR99TZnpEkL2Kb36K8oZwVoZ72Koa52xii9kTGUwxkxwbfp8FXsBB3vH1xr5aiinV"}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "good":true,
        "spent":0,
        "total":13918002061
    }
}
In the example below, the wrong message is used, avoiding the transaction to be proved:
curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"RYoLsfGWE6FfLjaV87ervPdbZRP4GZoUqWr7XbM5Ws61LibMVcrvYUJ5JAZW2xHXdjSQtnPDkc9CWZM3EJocHVSHCFwQZVSyxnY","message":"Failed proof, wrong msg","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112Wfh1111118Nv46ginpB3bqyC6Hd7TP2Yigtp1Dkv8BAHY8yVYBJp9jspZQK113URmZVHh77K6shdb684NVtAphm2ioJ8dQjfLaDY8bCVw5Uh5Y2k42cqNJkRo2vQZ5scN41XMFFtXsACBhGbp61HdZ6VdGL29d113keChLFA7RqY4FgNAnFDQ9nPDdfKB9Kff6N99fp1EL4SUxrbhvbUXhV7ZKvKvJbNNQ4oeQ165UEMrvkHbV8XuLZTxNCyz2hcBA2eX6HSNCxYAkCnm6z3uwkTLB5AkvU7ZiD7LsWRSaVE95fdsYkCSQ333L24UDBVCpsXv1xMZiusdM9BHCGui4hGUdrprzXJ9aCB39tHqyVZemQH4qSNdi7pWhGwKiW2S9i1E1LSpc3MESPgV5SEGHJo7Cn4eaAq2ue6KkBspBjb9Bx39Xd3RHPV9VKf9bhxVwFMtv7T8ZjSAAjApVVP8e9KfqeB9AQ3NLNMqYYbenwFa132zxuBiGq5XUAGwXR3uHj7YJpVMSDHcTXKR34YFPCN6tbCF9sSsxp4P4L1RoWrzjTBMBgQUPUHDBKNHeQ8BrsTtJQUdRBPwcqJ1BM7bZKU5U4nTNvJJSNcrzTAkDet1a5RATuWV3MaiSyWT8oNqa4AyACenLsrQSgAWL8JRK7D2LerzW8U5F2ENWHgJcQk3o7Jzz26j43WXMweChZHMVV8VUPP5iGBao8guBdKPAaFcDBKjFQLfB7HPDx3jrih6RSeZZhjoxwTMgC6T6qpX6Tb442XTcHVPrXou4pia3NdTWikV4VDR3zLDnfFDevrGcq5hDgB33QsGHG1cGfcjaXYY5KQATXX3Z5TtF8Pzanf9x8a6daxKQsa3cKhMLUJdABAaq3geQoTpUUZZUshW789TSoo7Zcna2aeE9eMghCZLj8hCZcmS9XzGA4rNPgCv7Bn5TkuvFcqemAPPUy72ErFxAtFPFCb7pzNY4ehTc48ukox2qgQHf4RYjbdhuVsu9WgULTBi41PTnY88PRwMmnCJaiXqoA1jv1Ak9cHApHYkjWRPSoNn6ryXYyNZqg8BjdJnYp52Lj5gjKfnzRxe4WS5TayoCfBvHUUgDXt2KRvm4egXHekw8zAddVvnwJwgotAEEvvWY5WT3S2QZ1umxvpGvLNvT4SB3JeTBLCF4z1m9vCKQg5wD8bXQrXUaQvRwMgBZx9LBWYbnmJpmU2vYoYr2bjWBsEWS87Vd2M1cByEDGPu4fKNB7u6KLXFwX8ui4kMcTYH2Q5rfFcdoD6U2rHgaTon99L9tE2mD5SowVEkMWwKnD4K21FWtEtD5gpMWQfzg8kirWj9eZrY2TZMnNDsEZxTfaZYT9YLZX4xVHWRHYLCvWmcYHKvH8YN5uUkKLhqSu4N3d7mhpXuhfnJWSjACsfNdfXCCZbt3zpRmeyyoNUXCqyDX7QG6J9vM5vYhQT1D97YGF2XX5BWZkeWsQMjz1wLenE16UxqL8skiPiBh5EMaTHNAwBLDKKjhJKUmFeYjCk3r3QRK4hPcGCHjyZba4dHQ4iK8Z1fuugmgB3cphVs95pi7CtTbuuniFR3iAK61HdhZuo24JbknwZAU4Y9MZqYE84dpAHDk6aKf7HD62wvCgmWryNuinvmon1BvrRvaKsCsVM28Besiffoc2YrddN6tvk9LT4Zj63LppNkMSqSj8Az1arHgS2VQuGm5Ldzp8foR99TZnpEkL2Kb36K8oZwVoZ72Koa52xii9kTGUwxkxwbfp8FXsBB3vH1xr5aiinV"}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "good":false,
        "spent":0,
        "total":0
    }
}

/export_outputs

Export all outputs in hex format.

Alias: None.

Inputs: None.

Outputs:

• outputs_data_hex - string; wallet outputs in hex format.

/import_outputs

Import outputs in hex format.

Alias: None.

Inputs:

• outputs_data_hex - string; wallet outputs in hex format.

Outputs:

• num_imported - unsigned int; number of outputs imported.

/export_key_images

Export a signed set of key images.

Alias: None.

Inputs: filename (string).

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"export_key_images","params":{"filename":"1"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
    }
}
            

/import_key_images

Import signed key images list and verify their spent status.

Alias: None.

Inputs: filename (string)

Outputs:

• height - unsigned int;
• spent - unsigned int; Amount (in atomic units) spent from those key images.
• unspent - unsigned int; Amount (in atomic units) still available from those key images.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_key_images","params":{"filename":"1"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "height":192334,
        "spent":4242,
        "unspent":0
    }
}
            

/delete_address_book

Delete an entry from the address book.

Alias: None.

Inputs:

• index - unsigned int; The index of the address book entry.

Outputs: None.

Request:

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"delete_address_book","params":{"index":0}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "index":0
    }
}

/refresh

Refresh a wallet after openning.

Alias: None.

Inputs:

• start_height - unsigned int; (Optional) The block height from which to start refreshing.

Outputs:

• blocks_fetched - unsigned int; Number of new blocks scanned.
• received_money - boolean; States if transactions to the wallet have been found in the blocks.

Request:

Response:

/rescan_spent

Rescan the blockchain for spent outputs.

Alias: None.

Inputs: None.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

/open_wallet

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

Alias: None.

Inputs:

• filename - string; wallet name stored in –wallet-dir.
• password - string; (Optional) only needed if the wallet has a password defined.

Outputs: None.

Request:

With a password: curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"myTestWallet","password":"myTestPassword"}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
Two options for without password:
curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"noPassword"}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}

curl -X POST http://localhost:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"noPassword","password":""}}' -H 'Content-Type: application/json'

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

/close_wallet

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

Alias: None.

Inputs: None.

Outputs: None.

Request:

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

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{

    }
}
            

/change_wallet_password

Change a wallet password.

Alias: None.

Inputs:

• old_password - string; (Optional) Current wallet password, if defined.
• new_password - string; (Optional) New wallet password, if not blank.

Outputs: None.

/transfer_split

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

Alias: None.

Inputs:

• destinations - array of destinations to receive Ryo:
  • amount - unsigned int; Amount to send to each destination, in atomic units.
  • address - string; Destination public address.
• account_index - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)
• subaddr_indices - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)
• mixin - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).
• ring_size - unsigned int; Sets ringsize to n (mixin + 1).
• unlock_time - unsigned int; Number of blocks before the ryo 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 - boolean; (Optional) Return the transaction keys after sending.
• priority - unsigned int; Set a priority for the transactions. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.
• do_not_relay - boolean; (Optional) If true, the newly created transaction will not be relayed to the ryo network. (Defaults to false)
• get_tx_hex - boolean; Return the transactions as hex string after sending
• new_algorithm - boolean; True to use the new transaction construction algorithm, defaults to false.
• get_tx_metadata - boolean; Return list of transaction metadata needed to relay the transfer later.

Outputs:

• tx_hash_list - array of: string. The tx hashes of every transaction.
• tx_key_list - array of: string. The transaction keys for every transaction.
• amount_list - array of: integer. The amount transferred for every transaction.
• fee_list - array of: integer. The amount of fees paid for every transaction.
• tx_blob_list - array of: string. The tx as hex string for every transaction.
• tx_metadata_list - array of: 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.

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer_split","params":{"destinations":[{"amount":411,"address":"RYoLsfmhLANNkFT5dUDDsvMM3Z1Fzd57zFvJnMHcghD5j1zFEyyKovcSHMKAQ9NZZ5HeWWmzDHCL3bmdXK9b43Z7hLkWF5vzzFF"},{"amount":411,"address":"RYoLsedkTcWcTgfaMTnUBq1kBGhw1VsH1TnZbCCnaEAL3iF1XfbZg7jezQecxz5gZsbmwZgKdHhrE8E126Kzje2sMPaNC7asCiN"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":13,"get_tx_key": true}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "amount_list":[
            822
        ],
        "fee_list":[
            17000000
        ],
        "multisig_txset":"",
        "tx_hash_list":[
            "7a1477549dceebc91832e3698cc2e8b80aa023426f1fb1f8e54393b4a86d8ead"
        ]
    }
}
            

/get_transfers

Returns a list of transfers.

Alias: None.

Inputs:

• in - boolean; (Optional) Include incoming transfers.
• out - boolean; (Optional) Include outgoing transfers.
• pending - boolean; (Optional) Include pending transfers.
• failed - boolean; (Optional) Include failed transfers.
• pool - boolean; (Optional) Include transfers from the daemon's transaction pool.
• filter_by_height - boolean; (Optional) Filter transfers by block height.
• min_height - unsigned int; (Optional) Minimum block height to scan for transfers, if filtering by height is enabled.
• max_height - unsigned int; (Opional) Maximum block height to scan for transfers, if filtering by height is enabled (defaults to max block height).
• account_index - unsigned int; (Optional) Index of the account to query for transfers. (defaults to 0)
• subaddr_indices - array of unsigned int; (Optional) List of subaddress indices to query for transfers. (defaults to 0)

Outputs:

• in array of transfers:
  • address - string; Public address of the transfer.
  • amount - unsigned int; Amount transferred.
  • confirmations - unsigned int; Number of block mined since the block containing this transaction (or block height at which the transaction should be added to a block if not yet confirmed).
  • double_spend_seen - boolean; True if the key image(s) for the transfer have been seen before.
  • fee - unsigned int; Transaction fee for this transfer.
  • height - unsigned int; Height of the first block that confirmed this transfer (0 if not mined yet).
  • note - string; Note about this transfer.
  • payment_id - string; Payment ID for this transfer.
  • subaddr_index - JSON object containing the major & minor subaddress index:
    • major - unsigned int; Account index for the subaddress.
    • minor - unsigned int; Index of the subaddress under the account.
  • suggested_confirmations_threshold - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.
  • timestamp - unsigned int; POSIX timestamp for when this transfer was first confirmed in a block (or timestamp submission if not mined yet).
  • txid - string; Transaction ID for this transfer.
  • type - string; Transfer type: "in"
  • unlock_time - unsigned int; Number of blocks until transfer is safely spendable.
• out array of transfers (see above).
• pending array of transfers (see above).
• failed array of transfers (see above).
• pool array of transfers (see above).

Request:

curl -X POST http://127.0.0.1:12215/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfers","params":{"in":true,"account_index":1}}' -H 'Content-Type: application/json'

Response:

{
    "id":"0",
    "jsonrpc":"2.0",
    "result":{
        "in":[
            {
                "address":"RYoLseSV7WGdMFijLPXNffMWEFxq17ZbtENpB8hqH7d3FLQqkadt3tgi2Z9Afw135BeQGC87bKYxKc6feRTgDY883kqvAAVLEUb",
                "amount":1000000000,
                "double_spend_seen":false,
                "fee":14000000,
                "height":196309,
                "note":"",
                "payment_id":"0000000000000000",
                "subaddr_index":{
                    "major":0,
                    "minor":0
                },
                "timestamp":1542235829,
                "txid":"c595e58c057a9a831fb94efdc3fbfe34d482ebdbf57ee084e4e81002739c52fd",
                "type":"in",
                "unlock_time":0
            }
        ]
    }
}