</code></pre></div><p>If the monero-wallet-rpc was executed with the <code>--rpc-login</code> argument as <code>username:password</code>, then follow this example:</p><divclass=highlight><pre><span></span><code><spanclass=nv>IP</span><spanclass=o>=</span><spanclass=m>127</span>.0.0.1
</code></pre></div><p>Note: "atomic units" refer to the smallest fraction of 1 XMR according to the monerod implementation. <strong>1 XMR = 1e12 atomic units.</strong></p><h3id=index-of-json-rpc-methods>Index of JSON RPC Methods:<aclass=headerlinkhref=#index-of-json-rpc-methodstitle="Permanent link">¶</a></h3><ul><li><ahref=#add_address_book>add_address_book</a></li><li><ahref=#change_wallet_password>change_wallet_password</a></li><li><ahref=#check_reserve_proof>check_reserve_proof</a></li><li><ahref=#check_spend_proof>check_spend_proof</a></li><li><ahref=#check_tx_key>check_tx_key</a></li><li><ahref=#check_tx_proof>check_tx_proof</a></li><li><ahref=#close_wallet>close_wallet</a></li><li><ahref=#create_account>create_account</a></li><li><ahref=#create_address>create_address</a></li><li><ahref=#create_wallet>create_wallet</a></li><li><ahref=#delete_address_book>delete_address_book</a></li><li><ahref=#export_key_images>export_key_images</a></li><li><ahref=#export_multisig_info>export_multisig_info</a></li><li><ahref=#export_outputs>export_outputs</a></li><li><ahref=#finalize_multisig>finalize_multisig</a></li><li><ahref=#get_accounts>get_accounts</a></li><li><ahref=#get_account_tags>get_account_tags</a></li><li><ahref=#get_address_book>get_address_book</a></li><li><ahref=#get_address>get_address</a></li><li><ahref=#get_address_index>get_address_index</a></li><li><ahref=#get_attribute>get_attribute</a></li><li><ahref=#get_balance>get_balance</a></li><li><ahref=#get_bulk_payments>get_bulk_payments</a></li><li><ahref=#get_height>get_height</a></li><li><ahref=#get_languages>get_languages</a></li><li><ahref=#get_payments>get_payments</a></li><li><ahref=#get_reserve_proof>get_reserve_proof</a></li><li><ahref=#get_spend_proof>get_spend_proof</a></li><li><ahref=#get_transfer_by_txid>get_transfer_by_txid</a></li><li><ahref=#get_transfers>get_transfers</a></li><li><ahref=#get_tx_key>get_tx_key</a></li><li><ahref=#get_tx_notes>get_tx_notes</a></li><li><ahref=#get_tx_proof>get_tx_proof</a></li><li><ahref=#get_version>get_version</a></li><li><ahref=#import_key_images>import_key_images</a></li><li><ahref=#import_multisig_info>import_multisig_info</a></li><li><ahref=#import_outputs>import_outputs</a></li><li><ahref=#incoming_transfers>incoming_transfers</a></li><li><ahref=#is_multisig>is_multisig</a></li><li><ahref=#label_account>label_account</a></li><li><ahref=#label_address>label_address</a></li><li><ahref=#make_integrated_address>make_integrated_address</a></li><li><ahref=#make_multisig>make_multisig</a></li><li><ahref=#make_uri>make_uri</a></li><li><ahref=#open_wallet>open_wallet</a></li><li><ahref=#parse_uri>parse_uri</a></li><li><ahref=#prepare_multisig>prepare_multisig</a></li><li><ahref=#query_key>query_key</a></li><li><ahref=#refresh>refresh</a></li><li><ahref=#relay_tx>relay_tx</a></li><li><ahref=#rescan_blockchain>rescan_blockchain</a></li><li><ahref=#rescan_spent>rescan_spent</a></li><li><ahref=#set_account_tag_description>set_account_tag_description</a></li><li><ahref=#set_attribute>set_attribute</a></li><li><ahref=#set_tx_notes>set_tx_notes</a></li><li><ahref=#sign_multisig>sign_multisig</a></li><li><ahref=#sign>sign</a></li><li><ahref=#sign_transfer>sign_transfer</a></li><li><ahref=#split_integrated_address>split_integrated_address</a></li><li><ahref=#start_mining>start_mining</a></li><li><ahref=#stop_mining>stop_mining</a></li><li><ahref=#stop_wallet>stop_wallet</a></li><li><ahref=#store>store</a></li><li><ahref=#submit_multisig>submit_multisig</a></li><li><ahref=#submit_transfer>submit_transfer</a></li><li><ahref=#sweep_all>sweep_all</a></li><li><ahref=#sweep_dust>sweep_dust</a></li><li><ahref=#sweep_single>sweep_single</a></li><li><ahref=#tag_accounts>tag_accounts</a></li><li><ahref=#transfer_split>transfer_split</a></li><li><ahref=#transfer>transfer</a></li><li><ahref=#untag_accounts>untag_accounts</a></li><li><ahref=#verify>verify</a></li></ul><h2id=json-rpc
</code></pre></div><h3id=change_wallet_password><strong>change_wallet_password</strong><aclass=headerlinkhref=#change_wallet_passwordtitle="Permanent link">¶</a></h3><p>Change a wallet password.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>old_password</em> - string; (Optional) Current wallet password, if defined.</li><li><em>new_password</em> - string; (Optional) New wallet password, if not blank.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"change_wallet_password","params":{"old_password":"theCurrentSecretPassPhrase","new_password":"theNewSecretPassPhrase"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=check_reserve_proof><strong>check_reserve_proof</strong><aclass=headerlinkhref=#check_reserve_prooftitle="Permanent link">¶</a></h3><p>Proves a wallet has a disposable reserve using a signature.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>address</em> - string; Public address of the wallet.</li><li><em>message</em> - string; (Optional) Should be the same message used in <code>get_reserve_proof</code>.</li><li><em>signature</em> - string; reserve signature to confirm.</li></ul><p>Outputs:</p><ul><li><em>good</em> - boolean; States if the inputs proves the reserve.</li></ul><p>In the example below, the reserve has been proven:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE1111112VKmH111118NfCYJQjZ6c46gT2kXgcHCaSSZeL8sRdzqjqx7i1e7FQfQGu2o113UYFVdwzHQi3iENDPa76Kn1BvywbKz3bMkXdZkBEEhBSF4kjjGaiMJ1ucKb6wvMVC4A8sA4nZEdL2Mk3wBucJCYTZwKqA8i1M113kqakDkG25FrjiDqdQTCYz2wDBmfKxF3eQiV5FWzZ6HmAyxnqTWUiMWukP9A3Edy3ZXqjP1b23dhz7Mbj39bBxe3ZeDNu9HnTSqYvHNRyqCkeUMJpHyQweqjGUJ1DSfFYr33J1E7MkhMnEi1o7trqWjVix32XLetYfePG73yvHbS24837L7Q64i5n1LSpd9yMiQZ3Dyaysi5y6jPx7TpAvnSqBFtuCciKoNzaXoA3dqt9cuVFZTXzdXKqdt3cXcVJMNxY8RvKPVQHhUur94Lpo1nSpxf7BN5a5rHrbZFqoZszsZmiWikYPkLX72XUdw6NWjLrTBxSy7KuPYH86c6udPEXLo2xgN6XHMBMBJzt8FqqK7EcpNUBkuHm2AtpGkf9CABY3oSjDQoRF5n4vNLd3qUaxNsG4XJ12L9gJ7GrK273BxkfEA8fDdxPrb1gpespbgEnCTuZHqj1A"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><p>In the example below, all wallet reserve has been proven:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_reserve_proof","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","message":"I have 10 at least","signature":"...signature..."}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><p>In the example below, the wrong message is used, avoiding the reserve to be proved:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=check_spend_proof><strong>check_spend_proof</strong><aclass=headerlinkhref=#check_spend_prooftitle="Permanent link">¶</a></h3><p>Prove a spend using a signature. Unlike proving a transaction, it does not requires the destination public address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; transaction id.</li><li><em>message</em> - string; (Optional) Should be the same message used in <code>get_spend_proof</code>.</li><li><em>signature</em> - string; spend signature to confirm.</li></ul><p>Outputs:</p><ul><li><em>good</em> - boolean; States if the inputs proves the spend.</li></ul><p>In the example below, the spend has been proven:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"this is my transaction","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><p>In the example below, the wrong message is used, avoiding the spend to be proved:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_spend_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","message":"wrong message","signature":"SpendProofV1aSh8Todhk54736iXgV6vJAFP7egxByuMWZeyNDaN2JY737S95X5zz5mNMQSuCNSLjjhi5HJCsndpNWSNVsuThxwv285qy1KkUrLFRkxMSCjfL6bbycYN33ScZ5UB4Fzseceo1ndpL393T1q638VmcU3a56dhNHF1RPZFiGPS61FA78nXFSqE9uoKCCoHkEz83M1dQVhxZV5CEPF2P6VioGTKgprLCH9vvj9k1ivd4SX19L2VSMc3zD1u3mkR24ioETvxBoLeBSpxMoikyZ6inhuPm8yYo9YWyFtQK4XYfAV9mJ9knz5fUPXR8vvh7KJCAg4dqeJXTVb4mbMzYtsSZXHd6ouWoyCd6qMALdW8pKhgMCHcVYMWp9X9WHZuCo9rsRjRpg15sJUw7oJg1JoGiVgj8P4JeGDjnZHnmLVa5bpJhVCbMhyM7JLXNQJzFWTGC27TQBbthxCfQaKdusYnvZnKPDJWSeceYEFzepUnsWhQtyhbb73FzqgWC4eKEFKAZJqT2LuuSoxmihJ9acnFK7Ze23KTVYgDyMKY61VXADxmSrBvwUtxCaW4nQtnbMxiPMNnDMzeixqsFMBtN72j5UqhiLRY99k6SE7Qf5f29haNSBNSXCFFHChPKNTwJrehkofBdKUhh2VGPqZDNoefWUwfudeu83t85bmjv8Q3LrQSkFgFjRT5tLo8TMawNXoZCrQpyZrEvnodMDDUUNf3NL7rxyv3gM1KrTWjYaWXFU2RAsFee2Q2MTwUW7hR25cJvSFuB1BX2bfkoCbiMk923tHZGU2g7rSKF1GDDkXAc1EvFFD4iGbh1Q5t6hPRhBV8PEncdcCWGq5uAL5D4Bjr6VXG8uNeCy5oYWNgbZ5JRSfm7QEhPv8Fy9AKMgmCxDGMF9dVEaU6tw2BAnJavQdfrxChbDBeQXzCbCfep6oei6n2LZdE5Q84wp7eoQFE5Cwuo23tHkbJCaw2njFi3WGBbA7uGZaGHJPyB2rofTWBiSUXZnP2hiE9bjJghAcDm1M4LVLfWvhZmFEnyeru3VWMETnetz1BYLUC5MJGFXuhnHwWh7F6r74FDyhdswYop4eWPbyrXMXmUQEccTGd2NaT8g2VHADZ76gMC6BjWESvcnz2D4n8XwdmM7ZQ1jFwhuXrBfrb1dwRasyXxxHMGAC2onatNiExyeQ9G1W5LwqNLAh9hvcaNTGaYKYXoceVzLkgm6e5WMkLsCwuZXvB"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=check_tx_key><strong>check_tx_key</strong><aclass=headerlinkhref=#check_tx_keytitle="Permanent link">¶</a></h3><p>Check a transaction in the blockchain with its secret key.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; transaction id.</li><li><em>tx_key</em> - string; transaction secret key.</li><li><em>address</em> - string; destination public address of the transaction.</li></ul><p>Outputs:</p><ul><li><em>confirmations</em> - unsigned int; Number of block mined after the one with the transaction.</li><li><em>in_pool</em> - boolean; States if the transaction is still in pool or has been added to a block.</li><li><em>received</em> - unsigned int; Amount of the transaction.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_tx_key","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","tx_key":"feba662cf8fb6d0d0da18fc9b70ab28e01cc76311278fdd7fe7ab16360762b06","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=check_tx_proof><strong>check_tx_proof</strong><aclass=headerlinkhref=#check_tx_prooftitle="Permanent link">¶</a></h3><p>Prove a transaction by checking its signature.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; transaction id.</li><li><em>address</em> - string; destination public address of the transaction.</li><li><em>message</em> - string; (Optional) Should be the same message used in <code>get_tx_proof</code>.</li><li><em>signature</em> - string; transaction signature to confirm.</li></ul><p>Outputs:</p><ul><li><em>confirmations</em> - unsigned int; Number of block mined after the one with the transaction.</li><li><em>good</em> - boolean; States if the inputs proves the transaction.</li><li><em>in_pool</em> - boolean; States if the transaction is still in pool or has been added to a block.</li><li><em>received</em> - unsigned int; Amount of the transaction.</li></ul><p>In the example below, the transaction has been proven:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><p>In the example below, the wrong message is used, avoiding the transaction to be proved:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"check_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"wrong message","signature":"InProofV13vqBCT6dpSAXkypZmSEMPGVnNRFDX2vscUYeVS4WnSVnV5BwLs31T9q6Etfj9Wts6tAxSAS4gkMeSYzzLS7Gt4vvCSQRh9niGJMUDJsB5hTzb2XJiCkUzWkkcjLFBBRVD5QZ"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=close_wallet><strong>close_wallet</strong><aclass=headerlinkhref=#close_wallettitle="Permanent link">¶</a></h3><p>Close the currently opened wallet, after trying to save it.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"close_wallet"}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=create_account><strong>create_account</strong><aclass=headerlinkhref=#create_accounttitle="Permanent link">¶</a></h3><p>Create a new account with an optional label.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>label</em> - string; (Optional) Label for the account.</li></ul><p>Outputs:</p><ul><li><em>account_index</em> - unsigned int; Index of the new account.</li><li><em>address</em> - string; Address for this account. Base58 representation of the public keys.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"create_account","params":{"label":"Secondary account"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=create_address><strong>create_address</strong><aclass=headerlinkhref=#create_addresstitle="Permanent link">¶</a></h3><p>Create a new address for an account. Optionally, label the new address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>account_index</em> - unsigned int; Create a new address for this account.</li><li><em>label</em> - string; (Optional) Label for the new address.</li></ul><p>Outputs:</p><ul><li><em>address</em> - string; Newly created address. Base58 representation of the public keys.</li><li><em>address_index</em> - unsigned int; Index of the new address under the input account.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"create_address","params":{"account_index":0,"label":"new-sub"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=create_wallet><strong>create_wallet</strong><aclass=headerlinkhref=#create_wallettitle="Permanent link">¶</a></h3><p>Create a new wallet. You need to have set the argument "–wallet-dir" when launching monero-wallet-rpc to make this work.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>filename</em> - string; Wallet file name.</li><li><em>password</em> - string; (Optional) password to protect the wallet.</li><li><em>language</em> - string; Language for your wallets' seed.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"create_wallet","params":{"filename":"mytestwallet","password":"mytestpassword","language":"English"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=delete_address_book><strong>delete_address_book</strong><aclass=headerlinkhref=#delete_address_booktitle="Permanent link">¶</a></h3><p>Delete an entry from the address book.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>index</em> - unsigned int; The index of the address book entry.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"delete_address_book","params":{"index":1}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=export_key_images><strong>export_key_images</strong><aclass=headerlinkhref=#export_key_imagestitle="Permanent link">¶</a></h3><p>Export a signed set of key images.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>signed_key_images</em> - array of signed key images:<ul><li><em>key_image</em> - string;</li><li><em>signature</em> - string;</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"export_key_images"}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=export_multisig_info><strong>export_multisig_info</strong><aclass=headerlinkhref=#export_multisig_infotitle="Permanent link">¶</a></h3><p>Export multisig info for other participants.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>info</em> - string; Multisig info in hex format for other participants.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"export_multisig_info"}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=finalize_multisig><strong>finalize_multisig</strong><aclass=headerlinkhref=#finalize_multisigtitle="Permanent link">¶</a></h3><p>Turn this wallet into a multisig wallet, extra step for N-1/N wallets.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>multisig_info</em> - array of string; List of multisig string from peers.</li><li><em>password</em> - string; Wallet password</li></ul><p>Outputs:</p><ul><li><em>address</em> - string; multisig wallet address.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"finalize_multisig","params":{"multisig_info":["MultisigxV1JNC6Ja2oBt5Sqea9LN2YEF7WYZCpHqr2EKvPG89Trf3X4E8RWkLaGRf29fJ3stU471MELKxwufNYeigP7LoE4tn2McPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZEKVAQ4HPPyQciSCdNjgwsuFRBzrskMdMUwNMgKst1debYfm37i6PSzDoS2tk4kYTYj83kkAdR7kdshet1axQPd6HQ","MultisigxV1Unma7Ko4zdd8Ps3Af4oZwtj2JdWKzwNfP6s2G9ZvXhMoSscwn5g7PyCfcBc1V4ffRHY3Kxqq6VocSCUTncpVeUskMcPr4SbL9q15xNvZT5uwC9YRr7UwjXqSZHmTWN9PBuZE1LTpWxLoC3vPMSrqVVcjnmL9LYfdCZz3fECjNZbCEDq3PHDiUuY5jurQTcNoGhDTio5WM9xaAdim9YByiS5KyqF4"]}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=get_account_tags><strong>get_account_tags</strong><aclass=headerlinkhref=#get_account_tagstitle="Permanent link">¶</a></h3><p>Get a list of user-defined account tags.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>account_tags</em> - array of account tag information:<ul><li><em>tag</em> - string; Filter tag.</li><li><em>label</em> - string; Label for the tag.</li><li><em>accounts</em> - array of int; List of tagged account indices.</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"get_account_tags","params":""}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=get_accounts><strong>get_accounts</strong><aclass=headerlinkhref=#get_accountstitle="Permanent link">¶</a></h3><p>Get all accounts for a wallet. Optionally filter accounts by tag.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tag</em> - string; (Optional) Tag for filtering accounts.</li></ul><p>Outputs:</p><ul><li><em>subaddress_accounts</em> - array of subaddress account information:<ul><li><em>account_index</em> - unsigned int; Index of the account.</li><li><em>balance</em> - unsigned int; Balance of the account (locked or unlocked).</li><li><em>base_address</em> - string; Base64 representation of the first subaddress in the account.</li><li><em>label</em> - string; (Optional) Label of the account.</li><li><em>tag</em> - string; (Optional) Tag for filtering accounts.</li><li><em>unlocked_balance</em> - unsigned int; Unlocked balance for the account.</li></ul></li><li><em>total_balance</em> - unsigned int; Total balance of the selected accounts (locked or unlocked).</li><li><em>total_unlocked_balance</em> - unsigned int; Total unlocked balance of the selected accounts.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"get_accounts","params":{"tag":"myTag"}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=get_address><strong>get_address</strong><aclass=headerlinkhref=#get_addresstitle="Permanent link">¶</a></h3><p>Return the wallet's addresses for an account. Optionally filter for specific set of subaddresses.</p><p>Alias: <em>getaddress</em>.</p><p>Inputs:</p><ul><li><em>account_index</em> - unsigned int; Return subaddresses for this account.</li><li><em>address_index</em> - array of unsigned int; (Optional) List of subaddresses to return from an account.</li></ul><p>Outputs:</p><ul><li><em>address</em> - string; The 95-character hex address string of the monero-wallet-rpc in session.</li><li><em>addresses</em> array of addresses informations<ul><li><em>address</em> string; The 95-character hex (sub)address string.</li><li><em>label</em> string; Label of the (sub)address</li><li><em>address_index</em> unsigned int; index of the subaddress</li><li><em>used</em> boolean; states if the (sub)address has already received funds</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"get_address","params":{"account_index":0,"address_index":[0,1,4]}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=get_address_book><strong>get_address_book</strong><aclass=headerlinkhref=#get_address_booktitle="Permanent link">¶</a></h3><p>Retrieves entries from the address book.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>entries</em> - array of unsigned int; indices of the requested address book entries</li></ul><p>Outputs:</p><ul><li><em>entries</em> - array of entries:<ul><li><em>address</em> - string; Public address of the entry</li><li><em>description</em> - string; Description of this address entry</li><li><em>index</em> - unsigned int;</li><li><em>payment_id</em> - string;</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d <spanclass=s1>'{"jsonrpc":"2.0","id":"0","method":"get_address_book","params":{"entries":[0,1]}}'</span> -H <spanclass=s1>'Content-Type: application/json'</span>
</code></pre></div><h3id=get_bulk_payments><strong>get_bulk_payments</strong><aclass=headerlinkhref=#get_bulk_paymentstitle="Permanent link">¶</a></h3><p>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 <code>get_payments</code>because it has the same functionality but is more extendable. Either is fine for looking up transactions by a single payment ID.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>payment_ids</em> - array of: string; Payment IDs used to find the payments (16 characters hex).</li><li><em>min_block_height</em> - unsigned int; The block height at which to start looking for payments.</li></ul><p>Outputs:</p><ul><li><em>payments</em> - list of:<ul><li><em>payment_id</em> - string; Payment ID matching one of the input IDs.</li><li><em>tx_hash</em> - string; Transaction hash used as the transaction ID.</li><li><em>amount</em> - unsigned int; Amount for this payment.</li><li><em>block_height</em> - unsigned int; Height of the block that first confirmed this payment.</li><li><em>unlock_time</em> - unsigned int; Time (in block height) until this payment is safe to spend.</li><li><em>subaddr_index</em> - subaddress index:<ul><li><em>major</em> - unsigned int; Account index for the subaddress.</li><li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li></ul></li><li><em>address</em> - string; Address receiving the payment; Base58 representation of the public keys.</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><h3id=get_height><strong>get_height</strong><aclass=headerlinkhref=#get_heighttitle="Permanent link">¶</a></h3><p>Returns the wallet's current block height.</p><p>Alias: <em>getheight</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>height</em> - unsigned int; The current monero-wallet-rpc's blockchain height. If the wallet has been offline for a long time, it may need to catch up with the daemon.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_height"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_languages><strong>get_languages</strong><aclass=headerlinkhref=#get_languagestitle="Permanent link">¶</a></h3><p>Get a list of available languages for your wallet's seed.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>languages</em> - array of string; List of available languages</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_languages"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_payments><strong>get_payments</strong><aclass=headerlinkhref=#get_paymentstitle="Permanent link">¶</a></h3><p>Get a list of incoming payments using a given payment id.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>payment_id</em> - string; Payment ID used to find the payments (16 characters hex).</li></ul><p>Outputs:</p><ul><li><em>payments</em> - list of:<ul><li><em>payment_id</em> - string; Payment ID matching the input parameter.</li><li><em>tx_hash</em> - string; Transaction hash used as the transaction ID.</li><li><em>amount</em> - unsigned int; Amount for this payment.</li><li><em>block_height</em> - unsigned int; Height of the block that first confirmed this payment.</li><li><em>unlock_time</em> - unsigned int; Time (in block height) until this payment is safe to spend.</li><li><em>subaddr_index</em> - subaddress index:<ul><li><em>major</em> - unsigned int; Account index for the subaddress.</li><li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li></ul></li><li><em>address</em> - string; Address receiving the payment; Base58 representation of the public keys.</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_payments","params":{"payment_id":"60900e5603bf96e3"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_reserve_proof><strong>get_reserve_proof</strong><aclass=headerlinkhref=#get_reserve_prooftitle="Permanent link">¶</a></h3><p>Generate a signature to prove of an available amount in a wallet.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>all</em> - boolean; Proves all wallet balance to be disposable.</li><li><em>account_index</em> - unsigned int; Specify the account from witch to prove reserve. (ignored if <code>all</code> is set to true)</li><li><em>amount</em> - unsigned int; Amount (in atomic units) to prove the account has for reserve. (ignored if <code>all</code> is set to true)</li><li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li></ul><p>Outputs:</p><ul><li><em>signature</em> - string; reserve signature.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><h3id=get_spend_proof><strong>get_spend_proof</strong><aclass=headerlinkhref=#get_spend_prooftitle="Permanent link">¶</a></h3><p>Generate a signature to prove a spend. Unlike proving a transaction, it does not requires the destination public address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; transaction id.</li><li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li></ul><p>Outputs:</p><ul><li><em>signature</em> - string; spend signature.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><h3id=get_transfer_by_txid><strong>get_transfer_by_txid</strong><aclass=headerlinkhref=#get_transfer_by_txidtitle="Permanent link">¶</a></h3><p>Show information about a transfer to/from this address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; Transaction ID used to find the transfer.</li><li><em>account_index</em> - unsigned int; (Optional) Index of the account to query for the transfer.</li></ul><p>Outputs:</p><ul><li><em>transfer</em> - JSON object containing payment information:<ul><li><em>address</em> - string; Address that transferred the funds. Base58 representation of the public keys.</li><li><em>amount</em> - unsigned int; Amount of this transfer.</li><li><em>confirmations</em> - 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).</li><li><em>destinations</em> - array of JSON objects containing transfer destinations:<ul><li><em>amount</em> - unsigned int; Amount transferred to this destination.</li><li><em>address</em> - string; Address for this destination. Base58 representation of the public keys.</li></ul></li><li><em>double_spend_seen</em> - boolean; True if the key image(s) for the transfer have been seen before.</li><li><em>fee</em> - unsigned int; Transaction fee for this transfer.</li><li><em>height</em> - unsigned int; Height of the first block that confirmed this transfer.</li><li><em>note</em> - string; Note about this transfer.</li><li><em>payment_id</em> - string; Payment ID for this transfer.</li><li><em>subaddr_index</em> - JSON object containing the major & minor subaddress index:<ul><li><em>major</em> - unsigned int; Account index for the subaddress.</li><li><em>minor</em> - unsigned int; Index of the subaddress under the account.</li></ul></li><li><em>suggested_confirmations_threshold</em> - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.</li><li><em>timestamp</em> - unsigned int; POSIX timestamp for the block that confirmed this transfer (or timestamp submission if not mined yet).</li><li><em>txid</em> - string; Transaction ID of this transfer (same as input TXID).</li><li><em>type</em> - string; Type of transfer, one of the following: "in", "out", "pending", "failed", "pool"</li><li><em>unlock_time</em> - unsigned int; Number of blocks until transfer is safely spendable.</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfer_by_txid","params":{"txid":"c36258a276018c3a4bc1f195a7fb530f50cd63a4fa765fb7c6f7f49fc051762a"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_transfers><strong>get_transfers</strong><aclass=headerlinkhref=#get_transferstitle="Permanent link">¶</a></h3><p>Returns a list of transfers.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>in</em> - boolean; (Optional) Include incoming transfers.</li><li><em>out</em> - boolean; (Optional) Include outgoing transfers.</li><li><em>pending</em> - boolean; (Optional) Include pending transfers.</li><li><em>failed</em> - boolean; (Optional) Include failed transfers.</li><li><em>pool</em> - boolean; (Optional) Include transfers from the daemon's transaction pool.</li><li><em>filter_by_height</em> - boolean; (Optional) Filter transfers by block height.</li><li><em>min_height</em> - unsigned int; (Optional) Minimum block height to scan for transfers, if filtering by height is enabled.</li><li><em>max_height</em> - unsigned int; (Opional) Maximum block height to scan for transfers, if filtering by height is enabled (defaults to max block height).</li><li><em>account_index</em> - unsigned int; (Optional) Index of the account to query for transfers. (defaults to 0)</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) List of subaddress indices to query for transfers. (defaults to 0)</li></ul><p>Outputs:</p><ul><li><em>in</em> array of transfers:<ul><li><em>address</em> - string; Public address of the transfer.</li><li><em>amount</em> - unsigned int; Amount transferred.</li><li><em>confirmations</em> - 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).</li><li><em>double_spend_seen</em> - boolean; True if the key image(s) for the transfer have been seen before.</li><li><em>fee</em> - unsigned int; Transaction fee for this transfer.</li><li><em>height</em> - unsigned int; Height of the first block that confirmed this transfer (0 if not mined yet).</li><li><em>note</em> - string; Note about this transfer.</li><li><em>payment_id</em> - string; Payment ID for this transfer.</li><li><em>subaddr_index</em> - JSON object containing the major & minor subaddress index:<ul><li><em>major</em> - unsigned int; Account index for the subaddress.</li><li><em>minor</em> - unsigned int; Index of the subaddress under the account.</li></ul></li><li><em>suggested_confirmations_threshold</em> - unsigned int; Estimation of the confirmations needed for the transaction to be included in a block.</li><li><em>timestamp</em> - unsigned int; POSIX timestamp for when this transfer was first confirmed in a block (or timestamp submission if not mined yet).</li><li><em>txid</em> - string; Transaction ID for this transfer.</li><li><em>type</em> - string; Transfer type: "in"</li><li><em>unlock_time</em> - unsigned int; Number of blocks until transfer is safely spendable.</li></ul></li><li><em>out</em> array of transfers (see above).</li><li><em>pending</em> array of transfers (see above).</li><li><em>failed</em> array of transfers (see above).</li><li><em>pool</em> array of transfers (see above).</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_transfers","params":{"in":true,"account_index":1}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_tx_notes><strong>get_tx_notes</strong><aclass=headerlinkhref=#get_tx_notestitle="Permanent link">¶</a></h3><p>Get string notes for transactions.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txids</em> - array of string; transaction ids</li></ul><p>Outputs:</p><ul><li><em>notes</em> - array of string; notes for the transactions</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_notes","params":{"txids":["3292e83ad28fc1cc7bc26dbd38862308f4588680fbf93eae3e803cddd1bd614f"]}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_tx_proof><strong>get_tx_proof</strong><aclass=headerlinkhref=#get_tx_prooftitle="Permanent link">¶</a></h3><p>Get transaction signature to prove it.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txid</em> - string; transaction id.</li><li><em>address</em> - string; destination public address of the transaction.</li><li><em>message</em> - string; (Optional) add a message to the signature to further authenticate the prooving process.</li></ul><p>Outputs:</p><ul><li><em>signature</em> - string; transaction signature.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_tx_proof","params":{"txid":"19d5089f9469db3d90aca9024dfcb17ce94b948300101c8345a5e9f7257353be","address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o","message":"this is my transaction"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=get_version><strong>get_version</strong><aclass=headerlinkhref=#get_versiontitle="Permanent link">¶</a></h3><p>Get RPC version Major & Minor integer-format, where Major is the first 16 bits and Minor the last 16 bits.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>version</em> - unsigned int; RPC version, formatted with <code>Major * 2^16 + Minor</code>(Major encoded over the first 16 bits, and Minor over the last 16 bits).</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_version"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=import_key_images><strong>import_key_images</strong><aclass=headerlinkhref=#import_key_imagestitle="Permanent link">¶</a></h3><p>Import signed key images list and verify their spent status.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>signed_key_images</em> - array of signed key images:<ul><li><em>key_image</em> - string;</li><li><em>signature</em> - string;</li></ul></li></ul><p>Outputs:</p><ul><li><em>height</em> - unsigned int;</li><li><em>spent</em> - unsigned int; Amount (in atomic units) spent from those key images.</li><li><em>unspent</em> - unsigned int; Amount (in atomic units) still available from those key images.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/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'
</code></pre></div><h3id=import_multisig_info><strong>import_multisig_info</strong><aclass=headerlinkhref=#import_multisig_infotitle="Permanent link">¶</a></h3><p>Import multisig info from other participants.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>info</em> - array of string; List of multisig info in hex format from other participants.</li></ul><p>Outputs:</p><ul><li><em>n_outputs</em> - unsigned int; Number of outputs signed with those multisig info.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"import_multisig_info","params":{"info":["...multisig_info..."]}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=incoming_transfers><strong>incoming_transfers</strong><aclass=headerlinkhref=#incoming_transferstitle="Permanent link">¶</a></h3><p>Return a list of incoming transfers to the wallet.</p><p>Inputs:</p><ul><li><em>transfer_type</em> - string; "all": all the transfers, "available": only transfers which are not yet spent, OR "unavailable": only transfers which are already spent.</li><li><em>account_index</em> - unsigned int; (Optional) Return transfers for this account. (defaults to 0)</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) Return transfers sent to these subaddresses.</li><li><em>verbose</em> - boolean; (Optional) Enable verbose output, return key image if true.</li></ul><p>Outputs:</p><ul><li><em>transfers</em> - list of:<ul><li><em>amount</em> - unsigned int; Amount of this transfer.</li><li><em>global_index</em> - unsigned int; Mostly internal use, can be ignored by most users.</li><li><em>key_image</em> - string; Key image for the incoming transfer's unspent output (empty unless verbose is true).</li><li><em>spent</em> - boolean; Indicates if this transfer has been spent.</li><li><em>subaddr_index</em> - unsigned int; Subaddress index for incoming transfer.</li><li><em>tx_hash</em> - string; Several incoming transfers may share the same hash if they were in the same transaction.</li><li><em>tx_size</em> - unsigned int; Size of transaction in bytes.</li></ul></li></ul><p>Example, get all transfers:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><p>Example, get available transfers:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><h3id=is_multisig><strong>is_multisig</strong><aclass=headerlinkhref=#is_multisigtitle="Permanent link">¶</a></h3><p>Check if a wallet is a multisig one.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>multisig</em> - boolean; States if the wallet is multisig</li><li><em>ready</em> - boolean;</li><li><em>threshold</em> - unsigned int; Amount of signature needed to sign a transfer.</li><li><em>total</em> - unsigned int; Total amount of signature in the multisig wallet.</li></ul><p>Example for a non-multisig wallet:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json'
</code></pre></div><p>Example for a multisig wallet:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"is_multisig"}' -H 'Content-Type: application/json' {
</code></pre></div><h3id=label_account><strong>label_account</strong><aclass=headerlinkhref=#label_accounttitle="Permanent link">¶</a></h3><p>Label an account.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>account_index</em> - unsigned int; Apply label to account at this index.</li><li><em>label</em> - string; Label for the account.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_account","params":{"account_index":0,"label":"Primary account"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=label_address><strong>label_address</strong><aclass=headerlinkhref=#label_addresstitle="Permanent link">¶</a></h3><p>Label an address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>index</em> - subaddress index; JSON Object containing the major & minor address index:<ul><li><em>major</em> - unsigned int; Account index for the subaddress.</li><li><em>minor</em> - unsigned int; Index of the subaddress in the account.</li></ul></li><li><em>label</em> - string; Label for the address.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"label_address","params":{"index":{"major":0,"minor":5},"label":"myLabel"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=make_integrated_address><strong>make_integrated_address</strong><aclass=headerlinkhref=#make_integrated_addresstitle="Permanent link">¶</a></h3><p>Make an integrated address from the wallet address and a payment id.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>standard_address</em> - string; (Optional, defaults to primary address) Destination public address.</li><li><em>payment_id</em> - string; (Optional, defaults to a random ID) 16 characters hex encoded.</li></ul><p>Outputs:</p><ul><li><em>integrated_address</em> - string</li><li><em>payment_id</em> - string; hex encoded;</li></ul><p>Example (Payment ID is empty, use a random ID):</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_integrated_address","params":{"standard_address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=make_multisig><strong>make_multisig</strong><aclass=headerlinkhref=#make_multisigtitle="Permanent link">¶</a></h3><p>Make a wallet multisig by importing peers multisig string.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>multisig_info</em> - array of string; List of multisig string from peers.</li><li><em>threshold</em> - unsigned int; Amount of signatures needed to sign a transfer. Must be less or equal than the amount of signature in <code>multisig_info</code>.</li><li><em>password</em> - string; Wallet password</li></ul><p>Outputs:</p><ul><li><em>address</em> - string; multisig wallet address.</li><li><em>multisig_info</em> - string; Multisig string to share with peers to create the multisig wallet (extra step for N-1/N wallets).</li></ul><p>Example for 2/2 Multisig Wallet:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_multisig","params":{"multisig_info":["MultisigV1K4tGGe8QirZdHgTYoBZMumSug97fdDyM3Z63M3ZY5VXvAdoZvx16HJzPCP4Rp2ABMKUqLD2a74ugMdBfrVpKt4BwD8qCL5aZLrsYWoHiA7JJwDESuhsC3eF8QC9UMvxLXEMsMVh16o98GnKRYz1HCKXrAEWfcrCHyz3bLW1Pdggyowop"],"threshold":2}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=make_uri><strong>make_uri</strong><aclass=headerlinkhref=#make_urititle="Permanent link">¶</a></h3><p>Create a payment URI using the official URI spec.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>address</em> - string; Wallet address</li><li><em>amount</em> - unsigned int; (optional) the integer amount to receive, in <strong>atomic</strong>units</li><li><em>payment_id</em> - string; (optional) 16 or 64 character hexadecimal payment id</li><li><em>recipient_name</em> - string; (optional) name of the payment recipient</li><li><em>tx_description</em> - string; (optional) Description of the reason for the tx</li></ul><p>Outputs:</p><ul><li><em>uri</em> - string; This contains all the payment input information as a properly formatted payment URI</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"make_uri","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","amount":10,"payment_id":"420fa29b2d9a49f5","tx_description":"Testing out the make_uri function.","recipient_name":"el00ruobuob Stagenet wallet"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=open_wallet><strong>open_wallet</strong><aclass=headerlinkhref=#open_wallettitle="Permanent link">¶</a></h3><p>Open a wallet. You need to have set the argument "–wallet-dir" when launching monero-wallet-rpc to make this work.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>filename</em> - string; wallet name stored in –wallet-dir.</li><li><em>password</em> - string; (Optional) only needed if the wallet has a password defined.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"open_wallet","params":{"filename":"mytestwallet","password":"mytestpassword"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=parse_uri><strong>parse_uri</strong><aclass=headerlinkhref=#parse_urititle="Permanent link">¶</a></h3><p>Parse a payment URI to get payment information.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>uri</em> - string; This contains all the payment input information as a properly formatted payment URI</li></ul><p>Outputs:</p><ul><li><em>uri</em> - JSON object containing payment information:<ul><li><em>address</em> - string; Wallet address</li><li><em>amount</em> - unsigned int; Decimal amount to receive, in <strong>coin</strong> units (0 if not provided)</li><li><em>payment_id</em> - string; 16 or 64 character hexadecimal payment id (empty if not provided)</li><li><em>recipient_name</em> - string; Name of the payment recipient (empty if not provided)</li><li><em>tx_description</em> - string; Description of the reason for the tx (empty if not provided)</li></ul></li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"parse_uri","params":{"uri":"monero:55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt?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'
</code></pre></div><h3id=prepare_multisig><strong>prepare_multisig</strong><aclass=headerlinkhref=#prepare_multisigtitle="Permanent link">¶</a></h3><p>Prepare a wallet for multisig by generating a multisig string to share with peers.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs:</p><ul><li><em>multisig_info</em> - string; Multisig string to share with peers to create the multisig wallet.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"prepare_multisig"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=query_key><strong>query_key</strong><aclass=headerlinkhref=#query_keytitle="Permanent link">¶</a></h3><p>Return the spend or view private key.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>key_type</em> - string; Which key to retrieve: "mnemonic" - the mnemonic seed (older wallets do not have one) OR "view_key" - the view key</li></ul><p>Outputs:</p><ul><li><em>key</em> - string; The view key will be hex encoded, while the mnemonic will be a string of words.</li></ul><p>Example (Query view key):</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"query_key","params":{"key_type":"view_key"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=refresh><strong>refresh</strong><aclass=headerlinkhref=#refreshtitle="Permanent link">¶</a></h3><p>Refresh a wallet after openning.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>start_height</em> - unsigned int; (Optional) The block height from which to start refreshing.</li></ul><p>Outputs:</p><ul><li><em>blocks_fetched</em> - unsigned int; Number of new blocks scanned.</li><li><em>received_money</em> - boolean; States if transactions to the wallet have been found in the blocks.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"refresh","params":{"start_height":100000}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=relay_tx><strong>relay_tx</strong><aclass=headerlinkhref=#relay_txtitle="Permanent link">¶</a></h3><p>Relay a transaction previously created with <code>"do_not_relay":true</code>.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>hex</em> - string; transaction metadata returned from a <code>transfer</code> method with <code>get_tx_metadata</code> set to <code>true</code>.</li></ul><p>Outputs:</p><ul><li><em>tx_hash</em> - String for the publically searchable transaction hash.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"relay_tx","params":{"hex":"...tx_metadata..."}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=rescan_blockchain><strong>rescan_blockchain</strong><aclass=headerlinkhref=#rescan_blockchaintitle="Permanent link">¶</a></h3><p>Rescan the blockchain from scratch, losing any information which can not be recovered from the blockchain itself.<br> This includes destination addresses, tx secret keys, tx notes, etc.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"rescan_blockchain"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=set_account_tag_description><strong>set_account_tag_description</strong><aclass=headerlinkhref=#set_account_tag_descriptiontitle="Permanent link">¶</a></h3><p>Set description for an account tag.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tag</em> - string; Set a description for this tag.</li><li><em>description</em> - string; Description for the tag.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_account_tag_description","params":{"tag":"myTag","description":"Test tag"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=set_tx_notes><strong>set_tx_notes</strong><aclass=headerlinkhref=#set_tx_notestitle="Permanent link">¶</a></h3><p>Set arbitrary string notes for transactions.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>txids</em> - array of string; transaction ids</li><li><em>notes</em> - array of string; notes for the transactions</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/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'
</code></pre></div><h3id=sign><strong>sign</strong><aclass=headerlinkhref=#signtitle="Permanent link">¶</a></h3><p>Sign a string.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>data</em> - string; Anything you need to sign.</li></ul><p>Outputs:</p><ul><li><em>signature</em> - string; Signature generated against the "data" and the account public address.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign","params":{"data":"This is sample data to be signed"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=sign_multisig><strong>sign_multisig</strong><aclass=headerlinkhref=#sign_multisigtitle="Permanent link">¶</a></h3><p>Sign a transaction in multisig.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tx_data_hex</em> - string; Multisig transaction in hex format, as returned by <code>transfer</code> under <code>multisig_txset</code>.</li></ul><p>Outputs:</p><ul><li><em>tx_data_hex</em> - string; Multisig transaction in hex format.</li><li><em>tx_hash_list</em> - array of string; List of transaction Hash.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sign_multisig","params":{"tx_data_hex":"...multisig_txset..."}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=sign_transfer><strong>sign_transfer</strong><aclass=headerlinkhref=#sign_transfertitle="Permanent link">¶</a></h3><p>Sign a transaction created on a read-only wallet (in cold-signing process)</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>unsigned_txset</em> - string. Set of unsigned tx returned by "transfer" or "transfer_split" methods.</li><li><em>export_raw</em> - boolean; (Optional) If true, return the raw transaction data. (Defaults to false)</li></ul><p>Outputs:</p><ul><li><em>signed_txset</em> - string. Set of signed tx to be used for submitting transfer.</li><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li><li><em>tx_raw_list</em> - array of: string. The tx raw data of every transaction.</li></ul><p>In the example below, we first generate an unsigned_txset on a read only wallet before signing it:</p><p>Generate unsigned_txset using the above "transfer" method on read-only wallet:</p><divclass=highlight><pre><span></span><code>curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":1000000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"do_not_relay":true,"get_tx_hex":true}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=split_integrated_address><strong>split_integrated_address</strong><aclass=headerlinkhref=#split_integrated_addresstitle="Permanent link">¶</a></h3><p>Retrieve the standard address and payment id corresponding to an integrated address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>integrated_address</em> - string</li></ul><p>Outputs:</p><ul><li><em>is_subaddress</em> - boolean; States if the address is a subaddress</li><li><em>payment</em> - string; hex encoded</li><li><em>standard_address</em> - string</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"split_integrated_address","params":{"integrated_address": "5F38Rw9HKeaLQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZXCkbHUXdPHyiUeRyokn"}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=start_mining><strong>start_mining</strong><aclass=headerlinkhref=#start_miningtitle="Permanent link">¶</a></h3><p>Start mining in the Monero daemon.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>threads_count</em> - unsigned int; Number of threads created for mining.</li><li><em>do_background_mining</em> - boolean; Allow to start the miner in <ahref=https://ww.getmonero.org/resources/moneropedia/smartmining.html>smart mining</a>mode.</li><li><em>ignore_battery</em> - boolean; Ignore battery status (for <ahref=https://ww.getmonero.org/resources/moneropedia/smartmining.html>smart mining</a> only)</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/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'
</code></pre></div><h3id=stop_wallet><strong>stop_wallet</strong><aclass=headerlinkhref=#stop_wallettitle="Permanent link">¶</a></h3><p>Stops the wallet, storing the current state.</p><p>Alias: <em>None</em>.</p><p>Inputs: <em>None</em>.</p><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"stop_wallet"}' -H 'Content-Type: application/json'
</code></pre></div><h3id=submit_multisig><strong>submit_multisig</strong><aclass=headerlinkhref=#submit_multisigtitle="Permanent link">¶</a></h3><p>Submit a signed multisig transaction.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tx_data_hex</em> - string; Multisig transaction in hex format, as returned by <code>sign_multisig</code> under <code>tx_data_hex</code>.</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of string; List of transaction Hash.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_multisig","params":{"tx_data_hex":"...tx_data_hex..."}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=submit_transfer><strong>submit_transfer</strong><aclass=headerlinkhref=#submit_transfertitle="Permanent link">¶</a></h3><p>Submit a previously signed transaction on a read-only wallet (in cold-signing process).</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tx_data_hex</em> - string; Set of signed tx returned by "sign_transfer"</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li></ul><p>In the example below, we submit the transfer using the signed_txset generated above:</p><divclass=highlight><pre><span></span><code>curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_transfer","params":{"tx_data_hex":...long_hex..."}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=sweep_all><strong>sweep_all</strong><aclass=headerlinkhref=#sweep_alltitle="Permanent link">¶</a></h3><p>Send all unlocked balance to an address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>address</em> - string; Destination public address.</li><li><em>account_index</em> - unsigned int; Sweep transactions from this account.</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) Sweep from this set of subaddresses in the account.</li><li><em>priority</em> - unsigned int; (Optional) Priority for sending the sweep transfer, partially determines fee.</li><li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li><li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li><li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li><li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li><li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li><li><em>below_amount</em> - unsigned int; (Optional) Include outputs below this amount.</li><li><em>do_not_relay</em> - boolean; (Optional) If true, do not relay this sweep transfer. (Defaults to false)</li><li><em>get_tx_hex</em> - boolean; (Optional) return the transactions as hex encoded string. (Defaults to false)</li><li><em>get_tx_metadata</em> - boolean; (Optional) return the transaction metadata as a string. (Defaults to false)</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li><li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li><li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li><li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li><li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li><li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li><li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li><li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_all","params":{"address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","subaddr_indices":[4],"ring_size":7,"unlock_time":0,"get_tx_keys":true}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=sweep_dust><strong>sweep_dust</strong><aclass=headerlinkhref=#sweep_dusttitle="Permanent link">¶</a></h3><p>Send all dust outputs back to the wallet's, to make them easier to spend (and mix).</p><p>Alias: <em>sweep_unmixable</em>.</p><p>Inputs:</p><ul><li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li><li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li><li><em>get_tx_hex</em> - boolean; (Optional) Return the transactions as hex string after sending. (Defaults to false)</li><li><em>get_tx_metadata</em> - boolean; (Optional) Return list of transaction metadata needed to relay the transfer later. (Defaults to false)</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li><li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li><li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li><li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li><li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li><li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li><li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li><li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li></ul><p>Example (In this example, <code>sweep_dust</code> returns nothing because there are no funds to sweep):</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sweep_dust","params":{"get_tx_keys":true}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=sweep_single><strong>sweep_single</strong><aclass=headerlinkhref=#sweep_singletitle="Permanent link">¶</a></h3><p>Send all of a specific unlocked output to an address.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>address</em> - string; Destination public address.</li><li><em>account_index</em> - unsigned int; Sweep transactions from this account.</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) Sweep from this set of subaddresses in the account.</li><li><em>priority</em> - unsigned int; (Optional) Priority for sending the sweep transfer, partially determines fee.</li><li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li><li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li><li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li><li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li><li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li><li><em>key_image</em> - string; Key image of specific output to sweep.</li><li><em>below_amount</em> - unsigned int; (Optional) Include outputs below this amount.</li><li><em>do_not_relay</em> - boolean; (Optional) If true, do not relay this sweep transfer. (Defaults to false)</li><li><em>get_tx_hex</em> - boolean; (Optional) return the transactions as hex encoded string. (Defaults to false)</li><li><em>get_tx_metadata</em> - boolean; (Optional) return the transaction metadata as a string. (Defaults to false)</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li><li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li><li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li><li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li><li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li><li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li><li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li><li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/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'
</code></pre></div><h3id=tag_accounts><strong>tag_accounts</strong><aclass=headerlinkhref=#tag_accountstitle="Permanent link">¶</a></h3><p>Apply a filtering tag to a list of accounts.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>tag</em> - string; Tag for the accounts.</li><li><em>accounts</em> - array of unsigned int; Tag this list of accounts.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"tag_accounts","params":{"tag":"myTag","accounts":[0,1]}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=transfer><strong>transfer</strong><aclass=headerlinkhref=#transfertitle="Permanent link">¶</a></h3><p>Send monero to a number of recipients.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>destinations</em> - array of destinations to receive XMR:<ul><li><em>amount</em> - unsigned int; Amount to send to each destination, in atomic units.</li><li><em>address</em> - string; Destination public address.</li></ul></li><li><em>account_index</em> - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)</li><li><em>priority</em> - unsigned int; Set a priority for the transaction. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.</li><li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li><li><em>ring_size</em> - unsigned int; Number of outputs to mix in the transaction (this output + N decoys from the blockchain).</li><li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li><li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li><li><em>get_tx_key</em> - boolean; (Optional) Return the transaction key after sending.</li><li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li><li><em>get_tx_hex</em> - boolean; Return the transaction as hex string after sending (Defaults to false)</li><li><em>get_tx_metadata</em> - boolean; Return the metadata needed to relay the transaction. (Defaults to false)</li></ul><p>Outputs:</p><ul><li><em>amount</em> - Amount transferred for the transaction.</li><li><em>fee</em> - Integer value of the fee charged for the txn.</li><li><em>multisig_txset</em> - Set of multisig transactions in the process of being signed (empty for non-multisig).</li><li><em>tx_blob</em> - Raw transaction represented as hex string, if get_tx_hex is true.</li><li><em>tx_hash</em> - String for the publically searchable transaction hash.</li><li><em>tx_key</em> - String for the transaction key if get_tx_key is true, otherwise, blank string.</li><li><em>tx_metadata</em> - Set of transaction metadata needed to relay this transfer later, if get_tx_metadata is true.</li><li><em>unsigned_txset</em> - String. Set of unsigned tx for cold-signing purposes.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer","params":{"destinations":[{"amount":100000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":200000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_key": true}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=transfer_split><strong>transfer_split</strong><aclass=headerlinkhref=#transfer_splittitle="Permanent link">¶</a></h3><p>Same as transfer, but can split into more than one tx if necessary.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>destinations</em> - array of destinations to receive XMR:<ul><li><em>amount</em> - unsigned int; Amount to send to each destination, in atomic units.</li><li><em>address</em> - string; Destination public address.</li></ul></li><li><em>account_index</em> - unsigned int; (Optional) Transfer from this account index. (Defaults to 0)</li><li><em>subaddr_indices</em> - array of unsigned int; (Optional) Transfer from this set of subaddresses. (Defaults to 0)</li><li><em>mixin</em> - unsigned int; Number of outputs from the blockchain to mix with (0 means no mixing).</li><li><em>ring_size</em> - unsigned int; Sets ringsize to n (mixin + 1).</li><li><em>unlock_time</em> - unsigned int; Number of blocks before the monero can be spent (0 to not add a lock).</li><li><em>payment_id</em> - string; (Optional) Random 32-byte/64-character hex string to identify a transaction.</li><li><em>get_tx_keys</em> - boolean; (Optional) Return the transaction keys after sending.</li><li><em>priority</em> - unsigned int; Set a priority for the transactions. Accepted Values are: 0-3 for: default, unimportant, normal, elevated, priority.</li><li><em>do_not_relay</em> - boolean; (Optional) If true, the newly created transaction will not be relayed to the monero network. (Defaults to false)</li><li><em>get_tx_hex</em> - boolean; Return the transactions as hex string after sending</li><li><em>new_algorithm</em> - boolean; True to use the new transaction construction algorithm, defaults to false.</li><li><em>get_tx_metadata</em> - boolean; Return list of transaction metadata needed to relay the transfer later.</li></ul><p>Outputs:</p><ul><li><em>tx_hash_list</em> - array of: string. The tx hashes of every transaction.</li><li><em>tx_key_list</em> - array of: string. The transaction keys for every transaction.</li><li><em>amount_list</em> - array of: integer. The amount transferred for every transaction.</li><li><em>fee_list</em> - array of: integer. The amount of fees paid for every transaction.</li><li><em>tx_blob_list</em> - array of: string. The tx as hex string for every transaction.</li><li><em>tx_metadata_list</em> - array of: string. List of transaction metadata needed to relay the transactions later.</li><li><em>multisig_txset</em> - string. The set of signing keys used in a multisig transaction (empty for non-multisig).</li><li><em>unsigned_txset</em> - string. Set of unsigned tx for cold-signing purposes.</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"transfer_split","params":{"destinations":[{"amount":1000000000000,"address":"7BnERTpvL5MbCLtj5n9No7J5oE5hHiB3tVCK5cjSvCsYWD2WRJLFuWeKTLiXo5QJqt2ZwUaLy2Vh1Ad51K7FNgqcHgjW85o"},{"amount":2000000000000,"address":"75sNpRwUtekcJGejMuLSGA71QFuK1qcCVLZnYRTfQLgFU5nJ7xiAHtR5ihioS53KMe8pBhH61moraZHyLoG4G7fMER8xkNv"}],"account_index":0,"subaddr_indices":[0],"priority":0,"ring_size":7,"get_tx_key": true}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=untag_accounts><strong>untag_accounts</strong><aclass=headerlinkhref=#untag_accountstitle="Permanent link">¶</a></h3><p>Remove filtering tag from a list of accounts.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>accounts</em> - array of unsigned int; Remove tag from this list of accounts.</li></ul><p>Outputs: <em>None</em>.</p><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://localhost:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"untag_accounts","params":{"accounts":[1]}}' -H 'Content-Type: application/json'
</code></pre></div><h3id=verify><strong>verify</strong><aclass=headerlinkhref=#verifytitle="Permanent link">¶</a></h3><p>Verify a signature on a string.</p><p>Alias: <em>None</em>.</p><p>Inputs:</p><ul><li><em>data</em> - string; What should have been signed.</li><li><em>address</em> - string; Public address of the wallet used to <code>sign</code> the data.</li><li><em>signature</em> - string; signature generated by <code>sign</code> method.</li></ul><p>Outputs:</p><ul><li><em>good</em> - boolean;</li></ul><p>Example:</p><divclass=highlight><pre><span></span><code>$ curl -X POST http://127.0.0.1:18082/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"verify","params":{"data":"This is sample data to be signed","address":"55LTR8KniP4LQGJSPtbYDacR7dz8RBFnsfAKMaMuwUNYX6aQbBcovzDPyrQF9KXF9tVU6Xk3K8no1BywnJX6GvZX8yJsXvt","signature":"SigV14K6G151gycjiGxjQ74tKX6A2LwwghvuHjcDeuRFQio5LS6Gb27BNxjYQY1dPuUvXkEbGQUkiHSVLPj4nJAHRrrw3"}}' -H 'Content-Type: application/json'
