docs.html

<!DOCTYPE html>
<html>
<head></head>
<body>

<h2>Introduction</h2>

<p>This is a list of the lokid daemon RPC calls, their inputs and outputs, and examples of each.

Many RPC calls use the daemon's JSON RPC interface while others use their own interfaces, as demonstrated below.

Note: "atomic units" refer to the smallest fraction of 1 LOKI according to the lokid implementation. 1 LOKI = 1e12 atomic units.</p>

<h3>RPC Methods</h3>

<ul>
  <li>COMMAND_RPC_GET_HEIGHT</li>
  <li>COMMAND_RPC_GET_BLOCKS_FAST</li>
  <li>COMMAND_RPC_GET_BLOCKS_BY_HEIGHT</li>
  <li>COMMAND_RPC_GET_ALT_BLOCKS_HASHES</li>
  <li>COMMAND_RPC_GET_HASHES_FAST</li>
  <li>COMMAND_RPC_GET_ADDRESS_TXS</li>
  <li>COMMAND_RPC_GET_ADDRESS_INFO</li>
  <li>COMMAND_RPC_GET_UNSPENT_OUTS</li>
  <li>COMMAND_RPC_GET_RANDOM_OUTS</li>
  <li>COMMAND_RPC_SUBMIT_RAW_TX</li>
  <li>COMMAND_RPC_LOGIN</li>
  <li>COMMAND_RPC_IMPORT_WALLET_REQUEST</li>
  <li>COMMAND_RPC_GET_TRANSACTIONS</li>
  <li>COMMAND_RPC_IS_KEY_IMAGE_SPENT</li>
  <li>COMMAND_RPC_GET_TX_GLOBAL_OUTPUTS_INDEXES</li>
  <li>COMMAND_RPC_GET_OUTPUTS_BIN</li>
  <li>COMMAND_RPC_GET_OUTPUTS</li>
  <li>COMMAND_RPC_SEND_RAW_TX</li>
  <li>COMMAND_RPC_START_MINING</li>
  <li>COMMAND_RPC_GET_INFO</li>
  <li>COMMAND_RPC_GET_ALL_SERVICE_NODES_KEYS</li>
  <li>COMMAND_RPC_STOP_MINING</li>
  <li>COMMAND_RPC_MINING_STATUS</li>
  <li>COMMAND_RPC_SAVE_BC</li>
  <li>COMMAND_RPC_GETBLOCKCOUNT</li>
  <li>COMMAND_RPC_GETBLOCKHASH</li>
  <li>COMMAND_RPC_GETBLOCKTEMPLATE</li>
  <li>COMMAND_RPC_SUBMITBLOCK</li>
  <li>COMMAND_RPC_GENERATEBLOCKS</li>
  <li>COMMAND_RPC_GET_LAST_BLOCK_HEADER</li>
  <li>COMMAND_RPC_GET_BLOCK_HEADER_BY_HASH</li>
  <li>COMMAND_RPC_GET_BLOCK_HEADER_BY_HEIGHT</li>
  <li>COMMAND_RPC_GET_BLOCK</li>
  <li>COMMAND_RPC_GET_PEER_LIST</li>
  <li>COMMAND_RPC_SET_LOG_HASH_RATE</li>
  <li>COMMAND_RPC_SET_LOG_LEVEL</li>
  <li>COMMAND_RPC_SET_LOG_CATEGORIES</li>
  <li>COMMAND_RPC_GET_TRANSACTION_POOL</li>
  <li>COMMAND_RPC_GET_TRANSACTION_POOL_HASHES_BIN</li>
  <li>COMMAND_RPC_GET_TRANSACTION_POOL_HASHES</li>
  <li>COMMAND_RPC_GET_TRANSACTION_POOL_BACKLOG</li>
  <li>COMMAND_RPC_GET_TRANSACTION_POOL_STATS</li>
  <li>COMMAND_RPC_GET_CONNECTIONS</li>
  <li>COMMAND_RPC_GET_BLOCK_HEADERS_RANGE</li>
  <li>COMMAND_RPC_STOP_DAEMON</li>
  <li>COMMAND_RPC_FAST_EXIT</li>
  <li>COMMAND_RPC_GET_LIMIT</li>
  <li>COMMAND_RPC_SET_LIMIT</li>
  <li>COMMAND_RPC_OUT_PEERS</li>
  <li>COMMAND_RPC_IN_PEERS</li>
  <li>COMMAND_RPC_START_SAVE_GRAPH</li>
  <li>COMMAND_RPC_STOP_SAVE_GRAPH</li>
  <li>COMMAND_RPC_HARD_FORK_INFO</li>
  <li>COMMAND_RPC_GETBANS</li>
  <li>COMMAND_RPC_SETBANS</li>
  <li>COMMAND_RPC_FLUSH_TRANSACTION_POOL</li>
  <li>COMMAND_RPC_GET_OUTPUT_HISTOGRAM</li>
  <li>COMMAND_RPC_GET_VERSION</li>
  <li>COMMAND_RPC_GET_COINBASE_TX_SUM</li>
  <li>COMMAND_RPC_GET_BASE_FEE_ESTIMATE</li>
  <li>COMMAND_RPC_GET_ALTERNATE_CHAINS</li>
  <li>COMMAND_RPC_UPDATE</li>
  <li>COMMAND_RPC_RELAY_TX</li>
  <li>COMMAND_RPC_SYNC_INFO</li>
  <li>COMMAND_RPC_GET_OUTPUT_DISTRIBUTION</li>
  <li>COMMAND_RPC_POP_BLOCKS</li>
  <li>COMMAND_RPC_PRUNE_BLOCKCHAIN</li>
  <li>COMMAND_RPC_GET_QUORUM_STATE</li>
  <li>COMMAND_RPC_GET_QUORUM_STATE_BATCHED</li>
  <li>COMMAND_RPC_GET_SERVICE_NODE_REGISTRATION_CMD_RAW</li>
  <li>COMMAND_RPC_GET_SERVICE_NODE_REGISTRATION_CMD</li>
  <li>COMMAND_RPC_GET_SERVICE_NODE_KEY</li>
  <li>COMMAND_RPC_GET_SERVICE_NODES</li>
  <li>COMMAND_RPC_GET_STAKING_REQUIREMENT</li>
  <li>COMMAND_RPC_GET_SERVICE_NODE_BLACKLISTED_KEY_IMAGES</li>
  <li>COMMAND_RPC_GET_OUTPUT_BLACKLIST</li>
</ul>

<h3>COMMAND_RPC_GET_HEIGHT</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>height - uint64_t; Current length of longest chain known to daemon. </li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. </li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false). </li>
</ul>

<h3>COMMAND_RPC_GET_BLOCKS_FAST</h3>

<p>Inputs: </p>
<ul>
  <li>block_ids - std::list<crypto::hash>; first 10 blocks id goes sequential, next goes in pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block</li>
  <li>start_height - uint64_t;</li>
  <li>prune - bool;</li>
  <li>no_miner_tx - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>blocks - std::vector<block_complete_entry>;</li>
  <li>start_height - uint64_t;</li>
  <li>current_height - uint64_t;</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>output_indices - std::vector<block_output_indices>;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_BLOCKS_BY_HEIGHT</h3>

<p>Inputs: </p>
<ul>
  <li>heights - std::vector<uint64_t>; list of block heights</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>blocks - std::vector<block_complete_entry>;</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_ALT_BLOCKS_HASHES</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>blks_hashes - std::vector<std::string>; list of alternative blocks hashes to main chain</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_HASHES_FAST</h3>

<p>Inputs: </p>
<ul>
  <li>block_ids - std::list<crypto::hash>; first 10 blocks id goes sequential, next goes in pow(2,n) offset, like 2, 4, 8, 16, 32, 64 and so on, and the last one is always genesis block</li>
  <li>start_height - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>m_block_ids - std::vector<crypto::hash>; see block_ids above.</li>
  <li>start_height - uint64_t;</li>
  <li>current_height - uint64_t;</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_ADDRESS_TXS</h3>

<p>Inputs: </p>
<ul>
  <li>address - std::string;</li>
  <li>view_key - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>total_received - uint64_t;</li>
  <li>total_received_unlocked - uint64_t; OpenMonero only</li>
  <li>scanned_height - uint64_t;</li>
  <li>transactions - std::vector<transaction>;</li>
  <li>blockchain_height - uint64_t;</li>
  <li>scanned_block_height - uint64_t;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_ADDRESS_INFO</h3>

<p>Inputs: </p>
<ul>
  <li>address - std::string;</li>
  <li>view_key - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>locked_funds - uint64_t;</li>
  <li>total_received - uint64_t;</li>
  <li>total_sent - uint64_t;</li>
  <li>scanned_height - uint64_t;</li>
  <li>scanned_block_height - uint64_t;</li>
  <li>start_height - uint64_t;</li>
  <li>transaction_height - uint64_t;</li>
  <li>blockchain_height - uint64_t;</li>
  <li>spent_outputs - std::list<spent_output>;</li>
</ul>

<h3>COMMAND_RPC_GET_UNSPENT_OUTS</h3>

<p>Inputs: </p>
<ul>
  <li>amount - std::string;</li>
  <li>address - std::string;</li>
  <li>view_key - std::string; OpenMonero specific</li>
  <li>mixin - uint64_t;</li>
  <li>use_dust - bool;</li>
  <li>dust_threshold - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>amount - uint64_t;</li>
  <li>outputs - std::list<output>;</li>
  <li>per_kb_fee - uint64_t;</li>
  <li>status - std::string;</li>
  <li>reason - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_RANDOM_OUTS</h3>

<p>Inputs: </p>
<ul>
  <li>amounts - std::vector<std::string>;</li>
  <li>count - uint32_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>amount_outs - std::vector<amount_out>;</li>
  <li>Error - std::string;</li>
</ul>

<h3>COMMAND_RPC_SUBMIT_RAW_TX</h3>

<p>Inputs: </p>
<ul>
  <li>address - std::string;</li>
  <li>view_key - std::string;</li>
  <li>tx - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>error - std::string;</li>
</ul>

<h3>COMMAND_RPC_LOGIN</h3>

<p>Inputs: </p>
<ul>
  <li>address - std::string;</li>
  <li>view_key - std::string;</li>
  <li>create_account - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>reason - std::string;</li>
  <li>new_address - bool;</li>
</ul>

<h3>COMMAND_RPC_IMPORT_WALLET_REQUEST</h3>

<p>Inputs: </p>
<ul>
  <li>address - std::string;</li>
  <li>view_key - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>payment_id - std::string;</li>
  <li>import_fee - uint64_t;</li>
  <li>new_request - bool;</li>
  <li>request_fulfilled - bool;</li>
  <li>payment_address - std::string;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_TRANSACTIONS</h3>

<p>Inputs: </p>
<ul>
  <li>txs_hashes - std::vector<std::string>; List of transaction hashes to look up.</li>
  <li>decode_as_json - bool; Optional (false by default). If set true, the returned transaction information will be decoded rather than binary.</li>
  <li>prune - bool; Optional (false by default).</li>
  <li>split - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>txs_as_hex - std::vector<std::string>; transactions blobs as hex (old compat)</li>
  <li>txs_as_json - std::vector<std::string>; transactions decoded as json (old compat)</li>
  <li>missed_tx - std::vector<std::string>; (Optional - returned if not empty) Transaction hashes that could not be found.</li>
  <li>txs - std::vector<entry>;</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_IS_KEY_IMAGE_SPENT</h3>

<p>Inputs: </p>
<ul>
  <li>key_images - std::vector<std::string>; List of key image hex strings to check.</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>spent_status - std::vector<int>spent_status; List of statuses for each image checked. Statuses are follows: 0 = unspent, 1 = spent in blockchain, 2 = spent in transaction pool</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_TX_GLOBAL_OUTPUTS_INDEXES</h3>

<p>Inputs: </p>
<ul>
  <li>txid - crypto::hash;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>o_indexes - std::vector<uint64_t>; List of output indexes</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>get_outputs_out</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_OUTPUTS_BIN</h3>

<p>Inputs: </p>
<ul>
  <li>outputs - std::vector<get_outputs_out>;</li>
  <li>get_txid - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>outs - std::vector<outkey>;</li>
  <li>status - std::string;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>COMMAND_RPC_GET_OUTPUTS</h3>

<p>Inputs: </p>
<ul>
  <li>outputs - std::vector<get_outputs_out>;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>outs - std::vector<outkey>;</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_SEND_RAW_TX</h3>

<p>Inputs: </p>
<ul>
  <li>tx_as_hex - std::string; Full transaction information as hexidecimal string.</li>
  <li>do_not_relay - bool; Stop relaying transaction to other nodes (default is false).</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
  <li>reason - std::string; Additional information. Currently empty or "Not relayed" if transaction was accepted but not relayed.</li>
  <li>not_relayed - bool; Transaction was not relayed (true) or relayed (false).</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
  <li>tvc - tx_verification_context;</li>
</ul>

<h3>COMMAND_RPC_START_MINING</h3>

<p>Inputs: </p>
<ul>
  <li>miner_address - std::string; Account address to mine to.</li>
  <li>threads_count - uint64_t; Number of mining thread to run.</li>
  <li>do_background_mining - bool; States if the mining should run in background (true) or foreground (false).</li>
  <li>ignore_battery - bool; States if battery state (on laptop) should be ignored (true) or not (false).</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
</ul>

<h3>COMMAND_RPC_GET_INFO</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>height - uint64_t; Current length of longest chain known to daemon.  <li>height - uint64_t</li>
  <li>target_height - uint64_t; The height of the next block in the chain.</li>
  <li>difficulty - uint64_t; Network difficulty (analogous to the strength of the network)</li>
  <li>target - uint64_t; Current target for next proof of work.</li>
  <li>tx_count - uint64_t; Total number of non-coinbase transaction in the chain.</li>
  <li>tx_pool_size - uint64_t; Number of transactions that have been broadcast but not included in a block.</li>
  <li>alt_blocks_countNumber of alternative blocks to main chain. - uint64_t; Number of alternative blocks to main chain.</li>
  <li>outgoing_connections_count - uint64_t; Number of peers that you are connected to and getting information from.</li>
  <li>incoming_connections_count - uint64_t; Number of peers connected to and pulling from your node.</li>
  <li>rpc_connections_count - uint64_t; Number of RPC client connected to the daemon (Including this RPC request).</li>
  <li>white_peerlist_size - uint64_t; White Peerlist Size</li>
  <li>grey_peerlist_size - uint64_t; Grey Peerlist Size</li>
  <li>mainnet - bool; States if the node is on the mainnet (true) or not (false).</li>
  <li>testnet - bool; States if the node is on the testnet (true) or not (false).</li>
  <li>stagenet - bool; States if the node is on the stagenet (true) or not (false).</li>
  <li>nettype - std::string; Network type</li>
  <li>top_block_hash - std::string; Hash of the highest block in the chain.</li>
  <li>cumulative_difficulty - uint64_t; Cumulative difficulty of all blocks in the blockchain.</li>
  <li>block_size_limitMaximum allowed block size - uint64_t; Maximum allowed block size</li>
  <li>block_weight_limit - uint64_t; Maximum allowed weight</li>
  <li>block_size_median - uint64_t; Median block size of latest 100 blocks</li>
  <li>block_weight_median - uint64_t; Median weight of latest 100 blocks</li>
  <li>start_time - uint64_t; Start time of the daemon, as UNIX time.</li>
  <li>free_space - uint64_t; Available disk space on the node.</li>
  <li>offline - bool; States if the node is offline (true) or online (false).</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
  <li>bootstrap_daemon_address - std::string; bootstrap node to give immediate usability to wallets while syncing by proxying RPC to it. (Note: the replies may be untrustworthy).</li>
  <li>height_without_bootstrap - uint64_t; Current length of the local chain of the daemon.  <li>height_without_bootstrap - uint64_t</li>
  <li>was_bootstrap_ever_used - bool; States if a bootstrap node has ever been used since the daemon started.</li>
  <li>database_size - uint64_t; Size of database  <li>database_size - uint64_t</li>
  <li>update_availableSize of database - bool;</li>
  <li>version - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_ALL_SERVICE_NODES_KEYS</h3>

<p>Inputs: </p>
<ul>
  <li>fully_funded_nodes_only - bool; Return keys for service nodes if they are funded and working on the network</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>keys - std::vector<std::string>; NOTE: Returns as base32z of the hex key, for Lokinet internal usage</li>
</ul>

<h3>COMMAND_RPC_STOP_MINING</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_MINING_STATUS</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>active - bool; States if mining is enabled (true) or disabled (false).</li>
  <li>speed - uint64_t; Mining power in hashes per seconds.</li>
  <li>threads_count - uint32_t; Number of running mining threads.</li>
  <li>address - std::string; Account address daemon is mining to. Empty if not mining.</li>
  <li>is_background_mining_enabled - bool; States if the mining is running in background (true) or foreground (false).</li>
</ul>

<h3>COMMAND_RPC_SAVE_BC</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_GETBLOCKCOUNT</h3>

<p>Inputs: </p>
<ul>
  <li>count - uint64_t; Number of blocks  <li>count - uint64_t</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_GETBLOCKHASH</h3>

<p>Inputs: <h3>COMMAND_RPC_GETBLOCKTEMPLATE</h3>

<p>Inputs: </p>
<ul>
  <li>reserve_size - uint64_t; Reserve size.</li>
  <li>wallet_address - std::string; Address of wallet to receive coinbase transactions if block is successfully mined.</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>difficulty - uint64_t; Difficulty of next block.</li>
  <li>height - uint64_t; Height on which to mine.</li>
  <li>reserved_offset - uint64_t; Reserved offset.  <li>reserved_offset - uint64_t</li>
  <li>expected_reward - uint64_t; Coinbase reward expected to be received if block is successfully mined.</li>
  <li>prev_hash - std::string; Hash of the most recent block on which to mine the next block.</li>
  <li>blocktemplate_blob - blobdata; Blob on which to try to mine a new block.</li>
  <li>blockhashing_blob - blobdata; Blob on which to try to find a valid nonce.</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_SUBMITBLOCK</h3>

<p>Inputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_GENERATEBLOCKS</h3>

<p>Inputs: </p>
<ul>
  <li>amount_of_blocksGeneral RPC error code. "OK" means everything looks good. - uint64_t;</li>
  <li>wallet_address - std::string;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>height - uint64_t;</li>
  <li>status - std::string;</li>
</ul>

<h3>block_header_response</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_LAST_BLOCK_HEADER</h3>

<p>Inputs: </p>
<ul>
  <li>fill_pow_hash - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>block_header - block_header_response;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_BLOCK_HEADER_BY_HASH</h3>

<p>Inputs: </p>
<ul>
  <li>hash - std::string; The block's sha256 hash.</li>
  <li>fill_pow_hash - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>block_header - block_header_response; A structure containing block header information. See get_last_block_header.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_BLOCK_HEADER_BY_HEIGHT</h3>

<p>Inputs: </p>
<ul>
  <li>height - uint64_t; The block's height.</li>
  <li>fill_pow_hash - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>block_header - block_header_response;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_BLOCK</h3>

<p>Inputs: </p>
<ul>
  <li>hash - std::string; The block's hash.</li>
  <li>height - uint64_t; The block's height.</li>
  <li>fill_pow_hash - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>block_header - block_header_response;</li>
  <li>miner_tx_hash - std::string;</li>
  <li>tx_hashes - std::vector<std::string>; List of hashes of non-coinbase transactions in the block. If there are no other transactions, this will be an empty list.</li>
  <li>blob - std::string; Hexadecimal blob of block information.</li>
  <li>json - std::string; JSON formatted block details</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>peer</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_PEER_LIST</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
  <li>white_list - std::vector<peer>; online</li>
  <li>gray_list - std::vector<peer>; offline</li>
</ul>

<h3>COMMAND_RPC_SET_LOG_HASH_RATE</h3>

<p>Inputs: </p>
<ul>
  <li>visible - bool; States if hash rate logs should be visible (true) or hidden (false)</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
</ul>

<h3>COMMAND_RPC_SET_LOG_LEVEL</h3>

<p>Inputs: </p>
<ul>
  <li>level - int8_t; daemon log level to set from 0 (less verbose) to 4 (most verbose)</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
</ul>

<h3>COMMAND_RPC_SET_LOG_CATEGORIES</h3>

<p>Inputs: </p>
<ul>
  <li>categories - std::string; Optional, daemon log categories to enable</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good. Any other value means that something went wrong.</li>
  <li>categories - std::string; daemon log enabled categories</li>
</ul>

<h3>tx_info</h3>

<p>Inputs: <h3>spent_key_image_info</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_TRANSACTION_POOL</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>transactions - std::vector<tx_info>; List of transactions in the mempool are not in a block on the main chain at the moment</li>
  <li>spent_key_imagesList of transactions in the mempool are not in a block on the main chain at the moment - std::vector<spent_key_image_info>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>COMMAND_RPC_GET_TRANSACTION_POOL_HASHES_BIN</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>tx_hashes - std::vector<crypto::hash>;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_TRANSACTION_POOL_HASHES</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>tx_hashes - std::vector<std::string>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>tx_backlog_entry</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_TRANSACTION_POOL_BACKLOG</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>backlog - std::vector<tx_backlog_entry>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>txpool_histo</h3>

<p>Inputs: <h3>txpool_stats</h3>

<p>Inputs: <h3>COMMAND_RPC_GET_TRANSACTION_POOL_STATS</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>pool_stats - txpool_stats;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_CONNECTIONS</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>connections - std::list<connection_info>; All connections and their information.</li>
</ul>

<h3>COMMAND_RPC_GET_BLOCK_HEADERS_RANGE</h3>

<p>Inputs: </p>
<ul>
  <li>start_height - uint64_t; The starting block's height.</li>
  <li>end_height - uint64_t; The ending block's height.</li>
  <li>fill_pow_hash - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>headers - std::vector<block_header_response>;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_STOP_DAEMON</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_FAST_EXIT</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_GET_LIMIT</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>limit_up - uint64_t; Upload limit in kBytes per second</li>
  <li>limit_down - uint64_t; Download limit in kBytes per second</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_SET_LIMIT</h3>

<p>Inputs: </p>
<ul>
  <li>limit_down - int64_t; Download limit in kBytes per second (-1 reset to default, 0 don't change the current limit)</li>
  <li>limit_up - int64_t; Upload limit in kBytes per second (-1 reset to default, 0 don't change the current limit)</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>limit_up - int64_t; unsigned int; Upload limit in kBytes per second</li>
  <li>limit_down - int64_t; unsigned int; Download limit in kBytes per second</li>
</ul>

<h3>COMMAND_RPC_OUT_PEERS</h3>

<p>Inputs: </p>
<ul>
  <li>out_peers - uint64_t; Max number of outgoing peers</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_IN_PEERS</h3>

<p>Inputs: </p>
<ul>
  <li>in_peers - uint64_t; Max number of incoming peers</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_START_SAVE_GRAPH</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_STOP_SAVE_GRAPH</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_HARD_FORK_INFO</h3>

<p>Inputs: </p>
<ul>
  <li>version - uint8_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>version - uint8_t; The major block version for the fork.</li>
  <li>enabled - bool; Tells if hard fork is enforced.</li>
  <li>window - uint32_t; Number of blocks over which current votes are cast. Default is 10080 blocks.</li>
  <li>votes - uint32_t; Number of votes towards hard fork.</li>
  <li>threshold - uint32_t; Minimum percent of votes to trigger hard fork. Default is 80.</li>
  <li>voting - uint8_t; Hard fork voting status.</li>
  <li>state - uint32_t; Current hard fork state: 0 (There is likely a hard fork), 1 (An update is needed to fork properly), or 2 (Everything looks good).</li>
  <li>earliest_height - uint64_t; Block height at which hard fork would be enabled if voted in.</li>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GETBANS</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>bans - std::vector<ban>bans;</li>
</ul>

<h3>COMMAND_RPC_SETBANS</h3>

<p>Inputs: </p>
<ul>
  <li>bans - std::vector<ban>bans; Nodes to ban</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_FLUSH_TRANSACTION_POOL</h3>

<p>Inputs: </p>
<ul>
  <li>txids - std::vector<std::string>; Optional, list of transactions IDs to flush from pool (all tx ids flushed if empty).</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_GET_OUTPUT_HISTOGRAM</h3>

<p>Inputs: </p>
<ul>
  <li>amounts - std::vector<uint64_t>;</li>
  <li>min_count - uint64_t;</li>
  <li>max_count - uint64_t;</li>
  <li>unlocked - bool;</li>
  <li>recent_cutoff - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>histogram - std::vector<entry>; list of histogram entries</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_VERSION</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>version - uint32_t;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_COINBASE_TX_SUM</h3>

<p>Inputs: </p>
<ul>
  <li>height - uint64_t; Block height from which getting the amounts</li>
  <li>count - uint64_t; number of blocks to include in the sum</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>emission_amount - uint64_t; amount of coinbase reward in atomic units</li>
  <li>fee_amount - uint64_t; amount of fees in atomic units</li>
</ul>

<h3>COMMAND_RPC_GET_BASE_FEE_ESTIMATE</h3>

<p>Inputs: </p>
<ul>
  <li>grace_blocks - uint64_t; Optional</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>fee - uint64_t; Amount of fees estimated per kB in atomic units</li>
  <li>quantization_mask - uint64_t;</li>
  <li>untrusted - bool; States if the result is obtained using the bootstrap mode, and is therefore not trusted (true), or when the daemon is fully synced (false).</li>
</ul>

<h3>COMMAND_RPC_GET_ALTERNATE_CHAINS</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>chains - std::list<chain_info>;</li>
</ul>

<h3>COMMAND_RPC_UPDATE</h3>

<p>Inputs: </p>
<ul>
  <li>command - std::string; command to use, either check or download</li>
  <li>path - std::string; Optional, path where to download the update.</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>update - bool; States if an update is available to download (true) or not (false)</li>
  <li>version - std::string; Version available for download.</li>
  <li>user_uri - std::string;</li>
  <li>auto_uri - std::string;</li>
  <li>hash - std::string;</li>
  <li>path - std::string; path to download the update</li>
</ul>

<h3>COMMAND_RPC_RELAY_TX</h3>

<p>Inputs: </p>
<ul>
  <li>txids - std::vector<std::string>; list of transaction IDs to relay  <li>txids - std::vector<std::string></li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
</ul>

<h3>COMMAND_RPC_SYNC_INFO</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>height - uint64_t;</li>
  <li>target_height - uint64_t; target height the node is syncing from (optional, absent if node is fully synced)</li>
  <li>next_needed_pruning_seed - uint32_t;</li>
  <li>peers - std::list<peer>;</li>
  <li>spans - std::list<span>;</li>
  <li>overview - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_OUTPUT_DISTRIBUTION</h3>

<p>Inputs: </p>
<ul>
  <li>amounts - std::vector<uint64_t>; amounts to look for</li>
  <li>from_height - uint64_t; (optional, default is 0) starting height to check from</li>
  <li>to_height - uint64_t; (optional, default is 0) ending height to check up to</li>
  <li>cumulative - bool; (optional, default is false) States if the result should be cumulative (true) or not (false)</li>
  <li>binary - bool;</li>
  <li>compress - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string; General RPC error code. "OK" means everything looks good.</li>
  <li>distributions - std::vector<distribution>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>COMMAND_RPC_POP_BLOCKS</h3>

<p>Inputs: </p>
<ul>
  <li>nblocks - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>height - uint64_t;</li>
</ul>

<h3>COMMAND_RPC_PRUNE_BLOCKCHAIN</h3>

<p>Inputs: </p>
<ul>
  <li>check - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>pruning_seed - uint32_t;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_QUORUM_STATE</h3>

<p>Inputs: </p>
<ul>
  <li>height - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>quorum_nodes - std::vector<std::string>;</li>
  <li>nodes_to_test - std::vector<std::string>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>COMMAND_RPC_GET_QUORUM_STATE_BATCHED</h3>

<p>Inputs: </p>
<ul>
  <li>height_begin - uint64_t;</li>
  <li>height_end - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>quorum_entries - std::vector<response_entry>;</li>
  <li>untrusted - bool;</li>
</ul>

<h3>COMMAND_RPC_GET_SERVICE_NODE_REGISTRATION_CMD_RAW</h3>

<p>Inputs: </p>
<ul>
  <li>args - std::vector<std::string>;</li>
  <li>make_friendly - bool; Provide information about how to use the command in the result</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>registration_cmdProvide information about how to use the command in the result - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_SERVICE_NODE_REGISTRATION_CMD</h3>

<p>Inputs: </p>
<ul>
  <li>operator_cut - std::string;</li>
  <li>contributions - std::vector<contribution_t>;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>status - std::string;</li>
  <li>registration_cmdProvide information about how to use the command in the result - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_SERVICE_NODE_KEY</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>service_node_pubkey - std::string;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_SERVICE_NODES</h3>

<p>Inputs: </p>
<ul>
  <li>service_node_pubkeys - std::vector<std::string>; pass empty vector to get all the service nodes</li>
  <li>include_json - bool;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>service_node_states - std::vector<entry>;</li>
  <li>status - std::string;</li>
  <li>as_json - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_STAKING_REQUIREMENT</h3>

<p>Inputs: </p>
<ul>
  <li>height - uint64_t;</li>
</ul>

<p>Outputs: </p>
<ul>
  <li>staking_requirement - uint64_t;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_SERVICE_NODE_BLACKLISTED_KEY_IMAGES</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>blacklist - std::vector<entry>;</li>
  <li>status - std::string;</li>
</ul>

<h3>COMMAND_RPC_GET_OUTPUT_BLACKLIST</h3>

<p>Inputs: None.</p>

<p>Outputs: </p>
<ul>
  <li>blacklist - std::vector<uint64_t>;</li>
  <li>status - std::string;</li>
  <li>untrusted - bool;</li>
</ul>

</body>
</html>