### Import Key Images Example Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Imports a set of signed key images into the wallet. The example shows the expected return structure. ```json { // TODO example height: , spent: , unspent: } ``` -------------------------------- ### Start Monero Daemon on Testnet Source: https://github.com/monero-integrations/monerophp/blob/master/README.md Command to start the Monero daemon in testnet mode. Ensure monerod is installed and accessible in your PATH. ```bash monerod --testnet --detach ``` -------------------------------- ### Start Monero Wallet RPC on Testnet Source: https://github.com/monero-integrations/monerophp/blob/master/README.md Command to start the Monero wallet RPC interface on testnet. Customize the RPC port and wallet directory as needed. ```bash monero-wallet-rpc --testnet --rpc-bind-port 28083 --disable-rpc-login --wallet-dir /path/to/wallet/directory ``` -------------------------------- ### start_mining Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Starts mining Monero on the wallet. ```APIDOC ## start_mining ### Description Start mining Monero. ### Parameters * `$threads_count` (number) - The number of threads to use for mining. * `$do_background_mining` (boolean) - Whether to mine in the background. * `$ignore_battery` (boolean) - Whether to ignore battery status while mining. ``` -------------------------------- ### Get Transfers Example Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves a list of transfers, including pool transactions. This example shows a 'pool' type transfer. ```json { "pool": [ { "amount": 500000000000, "fee": 0, "height": 0, "note": "", "payment_id": "758d9b225fda7b7f", "timestamp": 1488312467, "txid": "da7301d5423efa09fabacb720002e978d114ff2db6a1546f8b820644a1b96208", "type": "pool" } ] } ``` -------------------------------- ### finalize_multisig Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Finalizes the multisig setup. ```APIDOC ## finalize_multisig ### Description Finalizes the multisig setup. ### Method POST ### Endpoint /json_rpc ### Parameters None ### Response #### Success Response (200) - **result** (object) - Contains the final multisig status. - **multisig_key** (string) - The multisig key. ### Request Example { "jsonrpc": "2.0", "id": "0", "method": "finalize_multisig" } ### Response Example { "jsonrpc": "2.0", "id": "0", "result": { "multisig_key": "..." } } ``` -------------------------------- ### Get Transfer by TxID Example Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves a specific transaction's details using its transaction ID. This example shows an incoming transfer. ```json { "transfer": { "amount": 10000000000000, "fee": 0, "height": 1316388, "note": "", "payment_id": "0000000000000000", "timestamp": 1495539310, "txid": "f2d33ba969a09941c6671e6dfe7e9456e5f686eca72c1a94a3e63ac6d7f27baf", "type": "in" } } ``` -------------------------------- ### Prepare Multisig Wallet Information Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Generates the necessary information to create a multisignature wallet. This output should be shared with other participants in the multisig setup. ```json { "multisig_info": "MultisigV1WBnkPKszceUBriuPZ6zoDsU6RYJuzQTiwUqE5gYSAD1yGTz85vqZGetawVvioa" } ``` -------------------------------- ### Get Reserve Proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Generates a signature (proof) of reserves for specified accounts. Requires a comma-separated list of account indices. ```json { "signature": "ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE111111111111AjsVgKzau88VxXVGA } ``` -------------------------------- ### Get Spend Proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a signature (proof) to demonstrate a spend from a transaction. Requires the transaction ID. ```json { "signature": "SpendProofV1RnP6ywcDQHuQTBzXEMiHKbe5ErzRAjpUB1h4RUMfGPNv4bbR6V7EFyiYkCrURwbb } ``` -------------------------------- ### Get Node Connections Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Fetches a list of all incoming and outgoing network connections to the Monero node. Useful for monitoring network activity. ```json { "connections": [{ "avg_download": 0, "avg_upload": 0, "current_download": 0, "current_upload": 0, "incoming": false, "ip": "76.173.170.133", "live_time": 1865, "local_ip": false, "localhost": false, "peer_id": "3bfe29d6b1aa7c4c", "port": "18080", "recv_count": 116396, "recv_idle_time": 23, "send_count": 176893, "send_idle_time": 1457726610, "state": "state_normal" },{ .. }], "status": "OK" } ``` -------------------------------- ### Get wallet balance Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves the current balance and unlocked balance for a specified account. The balance is returned in atomic units (piconero). ```json { "balance": 140000000000, "unlocked_balance": 50000000000 } ``` -------------------------------- ### Get Block Template Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Constructs a block template suitable for mining. Requires a wallet address for coinbase transactions and an optional reserve size. ```json { "blocktemplate_blob": "01029af88cb70568b84a11dc9406ace9e635918ca03b008f7728b9726b327c1b482a98d81ed83000000000018bd03c01ffcfcf3c0493d7cec7020278dfc296544f139394e5e045fcda1ba2cca5b69b39c9ddc90b7e0de859fdebdc80e8eda1ba01029c5d518ce3cc4de26364059eadc8220a3f52edabdaf025a9bff4eec8b6b50e3d8080dd9da417021e642d07a8c33fbe497054cfea9c760ab4068d31532ff0fbb543a7856a9b78ee80c0f9decfae01023ef3a7182cb0c260732e7828606052a0645d3686d7a03ce3da091dbb2b75e5955f01ad2af83bce0d823bf3dbbed01ab219250eb36098c62cbb6aa2976936848bae53023c00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001f12d7c87346d6b84e17680082d9b4a1d84e36dd01bd2c7f3b3893478a8d88fb3", "difficulty": 982540729, "height": 993231, "prev_hash": "68b84a11dc9406ace9e635918ca03b008f7728b9726b327c1b482a98d81ed830", "reserved_offset": 246, "status": "OK" } ``` -------------------------------- ### Get Node Information Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves general status information about the Monero node, including network height, connection counts, and difficulty. ```json { "alt_blocks_count": 5, "difficulty": 972165250, "grey_peerlist_size": 2280, "height": 993145, "incoming_connections_count": 0, "outgoing_connections_count": 8, "status": "OK", "target": 60, "target_height": 993137, "testnet": false, "top_block_hash": "", "tx_count": 564287, "tx_pool_size": 45, "white_peerlist_size": 529 } ``` -------------------------------- ### Get Hard Fork Information Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Provides details on the current hard fork status, including voting readiness, block size limits, and network statistics. ```json { "alt_blocks_count": 0, "block_size_limit": 600000, "block_size_median": 85, "bootstrap_daemon_address": ?, "cumulative_difficulty": 40859323048, "difficulty": 57406, "free_space": 888592449536, "grey_peerlist_size": 526, "height": 1066107, "height_without_bootstrap": 1066107, "incoming_connections_count": 1, "offline": ?, "outgoing_connections_count": 1, "rpc_connections_count": 1, "start_time": 1519963719, "status": OK, "target": 120, "target_height": 1066073, "testnet": 1, "top_block_hash": e438aae56de8e5e5c8e0d230167fcb58bc8dde09e369ff7689a4af146040a20e, "tx_count": 52632, "tx_pool_size": 0, "untrusted": ?, "was_bootstrap_ever_used: ?, "white_peerlist_size": 5 } ``` -------------------------------- ### Initialize walletRPC with parameters Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Instantiate the walletRPC class by passing connection details as an associative array. Parameters can be in any order when provided this way. ```php $walletRPC = new walletRPC(['host' => '127.0.0.1', 'port' => 28083]) ``` -------------------------------- ### Initialize daemonRPC with Host and Port Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Instantiate the daemonRPC class with specific host and port configurations. Parameters can be provided in any order when using an associative array. ```php $daemonRPC = new daemonRPC(['host' => '127.0.0.1', 'port' => 28081]) ``` -------------------------------- ### create_wallet Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a new Monero wallet file. ```APIDOC ## create_wallet ### Description Create a new wallet. ### Parameters * `$filename` (String) - The filename for the new wallet. * `$password` (String) - The password for the new wallet. * `$language` (String) - The language to use for the wallet seed. ``` -------------------------------- ### get_bulk_payments Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves incoming payments for a list of payment IDs starting from a specified block height. ```APIDOC ## get_bulk_payments ### Description Retrieves incoming payments for a list of payment IDs starting from a specified block height. ### Parameters #### Path Parameters - **payment_ids** (Array) - Required - Array of payment IDs to look up - **min_block_height** (String) - Required - Height to begin search ### Response #### Success Response (200) - **payments** (Array) - An array of payment objects. - **amount** (number) - The amount of the payment. - **block_height** (number) - The block height at which the payment was received. - **payment_id** (string) - The payment ID. - **tx_hash** (string) - The transaction hash. - **unlock_time** (number) - The unlock time of the payment. ### Response Example ```json { "payments": [{ "amount": 10350000000000, "block_height": 994327, "payment_id": "4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030", "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1", "unlock_time": 0 }] } ``` ``` -------------------------------- ### open_wallet Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Opens an existing Monero wallet file. ```APIDOC ## open_wallet ### Description Open a wallet. ### Parameters * `$filename` (String) - The filename of the wallet to open. * `$password` (String) - The password for the wallet. ``` -------------------------------- ### Get Current Blockchain Height Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves the current height of the longest blockchain known to the wallet. ```json { "height": 994310 } ``` -------------------------------- ### import_key_images Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Imports key images into the wallet. ```APIDOC ## import_key_images ### Description Imports key images into the wallet. ### Method POST ### Endpoint /json_rpc ### Parameters #### Request Body - **filename** (string) - Required - The filename containing the key images to import. ### Response #### Success Response (200) - **result** (object) - Contains the import status. - **height** (integer) - The height at which the key images were imported. - **spent_heights** (array) - An array of heights where key images were spent. ### Request Example { "jsonrpc": "2.0", "id": "0", "method": "import_key_images", "params": { "filename": "key_images.txt" } } ### Response Example { "jsonrpc": "2.0", "id": "0", "result": { "height": 1000000, "spent_heights": [1000001, 1000002] } } ``` -------------------------------- ### prepare_multisig Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Generates the necessary information to create a multisignature wallet. ```APIDOC ## prepare_multisig ### Description Create information needed to create a multisignature wallet. ### Return * Object - An object containing the multisig information string. ``` -------------------------------- ### Get Wallet Spend Key Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves the wallet's spend key. This is a specific type of key lookup. ```json { "key": "2ab810..." } ``` -------------------------------- ### make_uri Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a Monero payment URI using the official URI specification. ```APIDOC ## make_uri ### Description Creates a Monero payment URI using the official URI specification. ### Parameters #### Path Parameters - **address** (String) - Required - Address to receive funds - **amount** (String) - Required - Amount of monero to request - **payment_id** (String) - Optional - Payment ID - **recipient_name** (String) - Optional - Name of recipient - **tx_description** (String) - Optional - Payment description ### Response #### Success Response (200) - **uri** (String) - The generated Monero payment URI. ### Response Example ```json { "uri": "monero:44affm5f1c35972447c37775a4387c71573036737333131353433333333333333?tx_description=Payment%20for%20invoice%20123" } ``` ``` -------------------------------- ### Get Banned IPs Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves a list of all IP addresses currently banned by the Monero node, along with the duration of their ban. ```json { "bans": [{ "ip": 838969536, "seconds": 1457748792 }], "status": "OK" } ``` -------------------------------- ### create_account Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a new account within the wallet and assigns a label to it. ```APIDOC ## create_account ### Description Creates a new account within the wallet and assigns a label to it. ### Parameters #### Path Parameters - `$label` (String) - Label to apply to new account ``` -------------------------------- ### import_key_images Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Imports a signed set of key images into the wallet. ```APIDOC ## import_key_images ### Description Imports a signed set of key images into the wallet. ### Parameters #### Path Parameters - **signed_key_images** (Array) - Required - Array of signed key images ### Response #### Success Response (200) - **height** (number) - The height at which key images were imported. - **spent** (number) - The number of spent key images imported. - **unspent** (number) - The number of unspent key images imported. ### Response Example ```json { "height": 1234567, "spent": 5, "unspent": 10 } ``` ``` -------------------------------- ### Get Last Block Header Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves the header information for the most recent block in the longest chain. This method does not require any parameters. ```json { "block_header": { "depth": 0, "difficulty": 746963928, "hash": "ac0f1e226268d45c99a16202fdcb730d8f7b36ea5e5b4a565b1ba1a8fc252eb0", "height": 990793, "major_version": 1, "minor_version": 1, "nonce": 1550, "orphan_status": false, "prev_hash": "386575e3b0b004ed8d458dbd31bff0fe37b280339937f971e06df33f8589b75c", "reward": 6856609225169, "timestamp": 1457589942 }, "status": "OK" } ``` -------------------------------- ### make_multisig Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a multisignature wallet using provided information. ```APIDOC ## make_multisig ### Description Create a multisignature wallet. ### Parameters * `$multisig_info` (String) - The multisignature information string (e.g., from `prepare_multisig`). * `$threshold` (String) - The threshold required to spend from the multisignature wallet. * `$password` (String) - The passphrase for the multisignature wallet. ``` -------------------------------- ### Get Transaction Key Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves the transaction key for a given transaction ID. Used to look up a transaction's private key. ```json { "tx_key": "e8e97866b1606bd87178eada8f995bf96d2af3fec5db0bc570a451ab1d589b0f" } ``` -------------------------------- ### Get Account Tags Information Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves information about account tags, including which accounts are associated with each tag and the tag's description. ```json { "account_tags": { "0": { "accounts": { "0": 0, "1": 1 }, "label": "", "tag": "Example tag" } } } ``` -------------------------------- ### get_info Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Fetches general information about the Monero node's current state, including network status, height, difficulty, and peer counts. ```APIDOC ## get_info ### Description Look up general information about the state of your node and the network. ### Parameters *No parameters* ### Response #### Success Response (200) - **alt_blocks_count** (Number) - Count of alternative blocks. - **difficulty** (Number) - Current network difficulty. - **grey_peerlist_size** (Number) - Size of the grey peer list. - **height** (Number) - Current blockchain height. - **incoming_connections_count** (Number) - Number of incoming connections. - **outgoing_connections_count** (Number) - Number of outgoing connections. - **status** (String) - Indicates the status of the RPC call, expected to be "OK". - **target** (Number) - Current block target. - **target_height** (Number) - Height of the current target. - **testnet** (Boolean) - Indicates if the node is running on testnet. - **top_block_hash** (String) - Hash of the top block. - **tx_count** (Number) - Total transaction count. - **tx_pool_size** (Number) - Size of the transaction pool. - **white_peerlist_size** (Number) - Size of the white peer list. ### Response Example ```json { "alt_blocks_count": 5, "difficulty": 972165250, "grey_peerlist_size": 2280, "height": 993145, "incoming_connections_count": 0, "outgoing_connections_count": 8, "status": "OK", "target": 60, "target_height": 993137, "testnet": false, "top_block_hash": "", "tx_count": 564287, "tx_pool_size": 45, "white_peerlist_size": 529 } ``` ``` -------------------------------- ### Get Wallet Accounts Information Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Retrieves detailed information about all subaddress accounts within the wallet, including balances and base addresses. ```json { "subaddress_accounts": { "0": { "account_index": 0, "balance": 2808597352948771, "base_address": "A2XE6ArhRkVZqepY2DQ5QpW8p8P2dhDQLhPJ9scSkW6q9aYUHhrhXVvE8sjg7vHRx2HnR", "label": "Primary account", "tag": "", "unlocked_balance": 2717153096298162 }, "1": { "account_index": 1, "balance": 0, "base_address": "BcXKsfrvffKYVoNGN4HUFfaruAMRdk5DrLZDmJBnYgXrTFrXyudn81xMj7rsmU5P9dX56", "label": "Secondary account", "tag": "", "unlocked_balance": 0 }, "total_balance": 2808597352948771, "total_unlocked_balance": 2717153096298162 } } ``` -------------------------------- ### get_spend_proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a proof of a spend. ```APIDOC ## get_spend_proof ### Description Creates a proof of a spend. ### Parameters #### Path Parameters - **txid** (String) - Required - Transaction ID ### Response #### Success Response (200) - **signature** (String) - The spend proof signature. ### Response Example ```json { "signature": "SpendProofV1RnP6ywcDQHuQTBzXEMiHKbe5ErzRAjpUB1h4RUMfGPNv4bbR6V7EFyiYkCrURwbb" } ``` ``` -------------------------------- ### walletRPC::transfer_split Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Initiates a Monero transfer, splitting the output into multiple destinations. ```APIDOC ## walletRPC::transfer_split ### Description Initiates a Monero transfer where the total amount can be split among multiple destinations. This is useful for sending funds to several recipients in a single transaction. ### Method POST ### Endpoint /json_rpc ### Parameters #### Query Parameters - **jsonrpc** (string) - Required - The JSON-RPC protocol version. - **id** (integer) - Required - The request ID. - **method** (string) - Required - The method name, should be "transfer_split". - **params** (object) - Required - Parameters for the transfer_split method. - **destinations** (array) - Required - An array of destination objects. - **amount** (string) - Required - The amount to send in atomic units (piconero). - **address** (string) - Required - The Monero address of the recipient. - **account_index** (integer) - Optional - The index of the account to send from. Defaults to 0. - **subaddr_indices** (array) - Optional - An array of subaddress indices to use for the transfer. If not specified, the primary address of the account is used. - **priority** (string) - Optional - The priority of the transaction (e.g., 'low', 'medium', 'high', 'default'). Defaults to 'default'. - **ring_size** (integer) - Optional - The number of mixin outputs to use for the transaction. Defaults to the wallet's configured ring size. - **unlock_time** (integer) - Optional - The unlock time for the transaction. Defaults to 0. - **get_tx_key** (boolean) - Optional - If true, the transaction key will be returned. Defaults to false. ### Request Example ```json { "jsonrpc": "2.0", "id": 1, "method": "transfer_split", "params": { "destinations": [ { "amount": "500000000000", "address": "4...Recipient1" }, { "amount": "500000000000", "address": "4...Recipient2" } ], "account_index": 0, "priority": "medium", "get_tx_key": true } } ``` ### Response #### Success Response (200) - **result** (object) - The result of the transfer_split request. - **tx_hash** (string) - The hash of the created transaction. - **tx_key** (string) - The transaction key (if get_tx_key is true). - **fee** (string) - The transaction fee in atomic units. - **height** (integer) - The block height at which the transaction was included (if already confirmed). - **jsonrpc** (string) - The JSON-RPC protocol version. - **id** (integer) - The request ID. #### Response Example ```json { "jsonrpc": "2.0", "id": 1, "result": { "tx_hash": "...", "tx_key": "...", "fee": "2000000", "height": 2000000 } } ``` ``` -------------------------------- ### get_reserve_proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a proof of reserves for specified accounts. ```APIDOC ## get_reserve_proof ### Description Creates a proof of reserves for specified accounts. ### Parameters #### Path Parameters - **account_index** (String) - Required - Comma-separated list of account indices of which to prove ### Response #### Success Response (200) - **signature** (String) - The reserve proof signature. ### Response Example ```json { "signature": "ReserveProofV11BZ23sBt9sZJeGccf84mzyAmNCP3KzYbE111111111111AjsVgKzau88VxXVGA" } ``` ``` -------------------------------- ### Get Block Count Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves the total number of blocks in the longest chain known to the Monero node. This method requires no parameters. ```json { "count": 993163, "status": "OK" } ``` -------------------------------- ### walletRPC::get_tx_proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Generates a proof for a given transaction. ```APIDOC ## walletRPC::get_tx_proof ### Description Generates a cryptographic proof for a Monero transaction, which can be used to demonstrate that a specific amount was sent to a specific address without revealing sensitive details. ### Method POST ### Endpoint /json_rpc ### Parameters #### Query Parameters - **jsonrpc** (string) - Required - The JSON-RPC protocol version. - **id** (integer) - Required - The request ID. - **method** (string) - Required - The method name, should be "get_tx_proof". - **params** (object) - Required - Parameters for the get_tx_proof method. - **txid** (string) - Required - The transaction hash (ID) for which to generate the proof. - **address** (string) - Required - The Monero address to which the funds were sent. - **message** (string) - Required - A message to include in the proof. ### Request Example ```json { "jsonrpc": "2.0", "id": 1, "method": "get_tx_proof", "params": { "txid": "...transaction_hash...", "address": "4...recipient_address...", "message": "Proof of payment for invoice #123" } } ``` ### Response #### Success Response (200) - **result** (object) - The result of the get_tx_proof request. - **proof** (string) - The generated transaction proof. - **jsonrpc** (string) - The JSON-RPC protocol version. - **id** (integer) - The request ID. #### Response Example ```json { "jsonrpc": "2.0", "id": 1, "result": { "proof": "...generated_proof_string..." } } ``` ``` -------------------------------- ### Get Transaction Proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Generates a signature (proof) for a transaction, proving that funds were spent from a specific address. Requires the address and transaction ID. ```json { "signature": "InProofV1Lq4nejMXxMnAdnLeZhHe3FGCmFdnSvzVM1AiGcXjngTRi4hfHPcDL9D4th7KUuvF9ZH } ``` -------------------------------- ### _transform Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Converts amounts from moneroj to tacoshi (piconero). Accepts an optional amount in monero. ```APIDOC ## _transform ### Description Convert from moneroj to tacoshi (piconero) ### Parameters #### Path Parameters - **method** (number) - Optional - Amount (in monero) to transform to tacoshi (piconero) ### Return - **Number** ``` -------------------------------- ### get_info Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves general information about the Monero daemon and the blockchain. This method requires no parameters. ```APIDOC ## get_info ### Description Get general information about the Monero daemon and the blockchain. ### Method GET (assumed, as no parameters are taken and data is retrieved) ### Endpoint /json_rpc ### Parameters *No parameters* ### Response #### Success Response (200) - Returns an object containing various details about the daemon and blockchain status, such as version, height, network type, etc. - **status** (String) - The status of the request, expected to be "OK". *Note: The specific fields returned by this method are not detailed in the source, but it is implied to be comprehensive.* ``` -------------------------------- ### store Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Saves the current state of the wallet. ```APIDOC ## store ### Description Saves the current state of the wallet. ### Method POST ### Endpoint /json_rpc ### Parameters None ### Response #### Success Response (200) Indicates the wallet was successfully saved. ``` -------------------------------- ### Get Block by Height Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Retrieves block information using its numerical height. This method also returns the block's blob and JSON representation. ```json { "blob": "...", "block_header": { "depth": 80694, "difficulty": 815625611, "hash": "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6", "height": 912345, "major_version": 1, "minor_version": 2, "nonce": 1646, "orphan_status": false, "prev_hash": "b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78", "reward": 7388968946286, "timestamp": 1452793716 }, "json": "...", "status": "OK" } ``` -------------------------------- ### get_tx_proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Creates a proof (signature) of a transaction. ```APIDOC ## get_tx_proof ### Description Creates a proof (signature) of a transaction. ### Parameters #### Path Parameters - **address** (String) - Required - Address that spent funds - **txid** (String) - Required - Transaction ID ### Response #### Success Response (200) - **signature** (String) - The transaction proof signature. ### Response Example ```json { "signature": "InProofV1Lq4nejMXxMnAdnLeZhHe3FGCmFdnSvzVM1AiGcXjngTRi4hfHPcDL9D4th7KUuvF9ZH" } ``` ``` -------------------------------- ### Get Block Header by Hash Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Fetches the block header for a specific block using its hash. Requires the block's hash as a string parameter. ```json { "block_header": { "depth": 78376, "difficulty": 815625611, "hash": "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6", "height": 912345, "major_version": 1, "minor_version": 2, "nonce": 1646, "orphan_status": false, "prev_hash": "b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78", "reward": 7388968946286, "timestamp": 1452793716 }, "status": "OK" } ``` -------------------------------- ### walletRPC::create_account Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Creates a new account within the wallet. ```APIDOC ## walletRPC::create_account ### Description Creates a new, separate account within the Monero wallet. Each account can have its own set of addresses and transactions, providing better organization. ### Method POST ### Endpoint /json_rpc ### Parameters #### Query Parameters - **jsonrpc** (string) - Required - The JSON-RPC protocol version. - **id** (integer) - Required - The request ID. - **method** (string) - Required - The method name, should be "create_account". - **params** (object) - Required - Parameters for the create_account method. - **label** (string) - Required - A label for the new account. ### Request Example ```json { "jsonrpc": "2.0", "id": 1, "method": "create_account", "params": { "label": "Savings Account" } } ``` ### Response #### Success Response (200) - **result** (object) - The result of the create_account request. - **account_index** (integer) - The index of the newly created account. - **address** (string) - The primary address of the new account. - **jsonrpc** (string) - The JSON-RPC protocol version. - **id** (integer) - The request ID. #### Response Example ```json { "jsonrpc": "2.0", "id": 1, "result": { "account_index": 1, "address": "4..." } } ``` ``` -------------------------------- ### Get Incoming Transfers Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Looks up incoming transfers of a specified type ('all', 'available', or 'unavailable'). Optional parameters include account index and subaddress indices. ```json { "transfers": [{ "amount": 10000000000000, "global_index": 711506, "spent": false, "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1", "tx_size": 5870 },{ "amount": 300000000000, "global_index": 794232, "spent": false, "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1", "tx_size": 5870 },{ "amount": 50000000000, "global_index": 213659, "spent": false, "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1", "tx_size": 5870 }] } ``` -------------------------------- ### sweep_all Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Sends all unlocked Monero outputs from a specified account to a given address. Supports various optional parameters for customization. ```APIDOC ## sweep_all ### Description Sends all unlocked Monero outputs from a specified account to a given address. Supports various optional parameters for customization. ### Parameters #### Path Parameters - `$address` (String) - Address to receive funds. - `$subaddr_indices` (String) - Comma-separated list of subaddress indices to sweep (optional). - `$account_index` (number) - Index of the account to sweep (optional). - `$payment_id` (String) - Payment ID (optional). - `$mixin` (number) - Mixin number (ringsize - 1) (optional). - `$priority` (number) - Transaction priority (optional). - `$below_amount` (number) - Only send outputs below this amount (optional). - `$unlock_time` (number) - UNIX timestamp or block height to unlock output (optional). - `$do_not_relay` (boolean) - Do not relay transaction (optional). *Alternatively, parameters can be passed as a single object:* - `$params` (Object) - An object containing any of the above options. `address` is required. ### Response #### Success Response (200) - `amount` (string) - The total amount swept. - `fee` (string) - The transaction fee. - `tx_hash` (string) - The transaction hash. - `tx_key` (string) - The transaction key. ``` -------------------------------- ### Get Block Hash by Height Source: https://github.com/monero-integrations/monerophp/blob/master/docs/daemonRPC.md Looks up a block's hash using its height in the Monero blockchain. Requires a single numeric parameter for the block height. ```json "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6" ``` -------------------------------- ### import_multisig_info Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Imports multisignature information into the current wallet. ```APIDOC ## import_multisig_info ### Description Import multisignature information. ### Parameters * `$info` (String) - The multisignature information string to import. ``` -------------------------------- ### Get wallet address details Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Fetches the primary wallet address and a list of all associated addresses, including their index, label, and usage status. This method can be aliased as `getaddress`. ```json { "address": "A2XE6ArhRkVZqepY2DQ5QpW8p8P2dhDQLhPJ9scSkW6q9aYUHhrhXVvE8sjg7vHRx2HnRv53zLQH4ATS", "addresses": [ { "address": "A2XE6ArhRkVZqepY2DQ5QpW8p8P2dhDQLhPJ9scSkW6q9aYUHhrhXVvE8sjg7vHRx2HnRv53zLQH", "address_index": 0, "label": "Primary account", "used": true }, { "address": "Bh3ttLbjGFnVGCeGJF1HgVh4DfCaBNpDt7PQAgsC2GFug7WKskgfbTmB6e7UupyiijiHDQPmDC7w", "address_index": 1, "label": "", "used": true } ] } ``` -------------------------------- ### Get Incoming Payments Source: https://github.com/monero-integrations/monerophp/blob/master/docs/walletRPC.md Looks up incoming payments by a specific payment ID. Returns a list of payments with amount, block height, payment ID, transaction hash, and unlock time. ```json { "payments": [{ "amount": 10350000000000, "block_height": 994327, "payment_id": "4279257e0a20608e25dba8744949c9e1caff4fcdafc7d5362ecf14225f3d9030", "tx_hash": "c391089f5b1b02067acc15294e3629a463412af1f1ed0f354113dd4467e4f6c1", "unlock_time": 0 }] } ``` -------------------------------- ### walletRPC::get_account_tags Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Retrieves all account tags and their associated descriptions. ```APIDOC ## walletRPC::get_account_tags ### Description Retrieves all account tags that have been set, along with their corresponding descriptions. Tags can be used to categorize accounts. ### Method POST ### Endpoint /json_rpc ### Parameters #### Query Parameters - **jsonrpc** (string) - Required - The JSON-RPC protocol version. - **id** (integer) - Required - The request ID. - **method** (string) - Required - The method name, should be "get_account_tags". ### Request Example ```json { "jsonrpc": "2.0", "id": 1, "method": "get_account_tags" } ``` ### Response #### Success Response (200) - **result** (object) - The result of the get_account_tags request. - **account_tags** (array) - An array of tag objects. - **tag** (string) - The tag identifier. - **description** (string) - The description associated with the tag. - **accounts** (array) - An array of account indices associated with this tag. - **jsonrpc** (string) - The JSON-RPC protocol version. - **id** (integer) - The request ID. #### Response Example ```json { "jsonrpc": "2.0", "id": 1, "result": { "account_tags": [ { "tag": "important", "description": "Important accounts", "accounts": [0, 2] } ] } } ``` ``` -------------------------------- ### get_reserve_proof Source: https://github.com/monero-integrations/monerophp/blob/master/docs/README.md Retrieves a reserve proof for a given amount. ```APIDOC ## get_reserve_proof ### Description Retrieves a reserve proof for a given amount. ### Method POST ### Endpoint /json_rpc ### Parameters #### Request Body - **amount** (string) - Required - The amount for which to generate the reserve proof. - **message** (string) - Optional - A message to include in the reserve proof. ### Response #### Success Response (200) - **result** (object) - Contains the reserve proof details. - **proof** (string) - The generated reserve proof. - **total** (string) - The total amount. - **untrimmed_total** (string) - The untrimmed total amount. ### Request Example { "jsonrpc": "2.0", "id": "0", "method": "get_reserve_proof", "params": { "amount": "1000000000000", "message": "My reserve proof" } } ### Response Example { "jsonrpc": "2.0", "id": "0", "result": { "proof": "...", "total": "1000000000000", "untrimmed_total": "1000000000000" } } ```