Table of Contents
- Daemon RPC Reference
- Table of Contents
- Chain Information
- getinfo
- getheight
- getblockcount
- get_est_height_from_date
- get_current_core_tx_expiration_median
- get_votes
- search_by_id
- Block Queries
- getlastblockheader
- getblockheaderbyhash
- getblockheaderbyheight
- on_getblockhash
- get_blocks_details
- get_main_block_details
- getblocktemplate
- submitblock
- submitblock2
- getblocks.bin
- Alternative Blocks
- Transaction Queries
- get_tx_details
- gettransactions
- decrypt_tx_details
- find_outs_in_recent_blocks
- sendrawtransaction
- validate_signature
- get_out_info
- get_multisig_info
- check_keyimages.bin
- Pool Operations
- Alias Operations
- alias_lookup
- get_alias_details
- get_alias_by_address
- get_aliases
- get_all_alias_details
- get_alias_reward
- Asset Operations
- Marketplace Operations
- Integrated Addresses
- Gateway Operations
- Random Outputs (Decoys)
- getrandom_outs
- getrandom_outs.bin
- getrandom_outs1
- getrandom_outs1.bin
- getrandom_outs3
- getrandom_outs3.bin
- getrandom_outs4
- getrandom_outs4.bin
- Mining
- Maintenance
Daemon RPC Reference
Complete reference for the Lethean daemon (lethean-chain-node) RPC API. The daemon listens on port 36941 by default.
All amounts are in atomic units (1 LTHN = 10^12 atomic units).
Table of Contents
- Chain Information
- Block Queries
- Alternative Blocks
- Transaction Queries
- Pool Operations
- Alias Operations
- Asset Operations
- Marketplace Operations
- Integrated Addresses
- Gateway Operations
- Random Outputs (Decoys)
- Mining
- Maintenance
Chain Information
getinfo
Retrieves various information about the blockchain node. The user must specify their needs via a 'flags' field in the request by combining necessary flags using binary OR. Some values are always calculated and provided, others only if the corresponding flag is specified.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getinfo",
"params": {
"flags": 1048575
}
}
Parameters:
flags-- Combination of flags to request specific data elements that are computationally expensive to calculate.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"alias_count": 1653,
"alt_blocks_count": 99,
"block_reward": 1000000000000,
"current_blocks_median": 0,
"current_max_allowed_block_size": 250000,
"current_network_hashrate_350": 107939216153,
"current_network_hashrate_50": 109575236643,
"daemon_network_state": 2,
"default_fee": 10000000000,
"expiration_median_timestamp": 1719585827,
"grey_peerlist_size": 321,
"height": 2555000,
"incoming_connections_count": 0,
"is_hardfok_active": [true,true,true,true,true,false],
"last_block_hash": "153af86fd0d7d0a427526258e30505a4d21b8f77261f5276c7669e0a6c83efa0",
"last_block_size": 0,
"last_block_timestamp": 1719586493,
"last_block_total_reward": 0,
"last_pos_timestamp": 1719585105,
"last_pow_timestamp": 1719586493,
"max_net_seen_height": 2555743,
"mi": {
"build_no": 0,
"mode": 0,
"ver_major": 0,
"ver_minor": 0,
"ver_revision": 0
},
"minimum_fee": 10000000000,
"net_time_delta_median": 0,
"offers_count": 0,
"outgoing_connections_count": 8,
"outs_stat": {
"amount_0": 0,
"amount_0_001": 0,
"amount_0_01": 0,
"amount_0_1": 0,
"amount_1": 0,
"amount_10": 0,
"amount_100": 0,
"amount_1000": 0,
"amount_10000": 0,
"amount_100000": 0,
"amount_1000000": 0
},
"performance_data": {
"all_txs_insert_time_5": 0,
"block_processing_time_0": 0,
"block_processing_time_1": 0,
"etc_stuff_6": 0,
"insert_time_4": 0,
"longhash_calculating_time_3": 0,
"map_size": 0,
"raise_block_core_event": 0,
"target_calculating_calc": 0,
"target_calculating_enum_blocks": 0,
"target_calculating_time_2": 0,
"tx_add_one_tx_time": 0,
"tx_append_is_expired": 0,
"tx_append_rl_wait": 0,
"tx_append_time": 0,
"tx_check_exist": 0,
"tx_check_inputs_attachment_check": 0,
"tx_check_inputs_loop": 0,
"tx_check_inputs_loop_ch_in_val_sig": 0,
"tx_check_inputs_loop_kimage_check": 0,
"tx_check_inputs_loop_scan_outputkeys_get_item_size": 0,
"tx_check_inputs_loop_scan_outputkeys_loop": 0,
"tx_check_inputs_loop_scan_outputkeys_loop_find_tx": 0,
"tx_check_inputs_loop_scan_outputkeys_loop_get_subitem": 0,
"tx_check_inputs_loop_scan_outputkeys_loop_handle_output": 0,
"tx_check_inputs_loop_scan_outputkeys_relative_to_absolute": 0,
"tx_check_inputs_prefix_hash": 0,
"tx_check_inputs_time": 0,
"tx_count": 0,
"tx_mixin_count": 0,
"tx_prapare_append": 0,
"tx_print_log": 0,
"tx_process_attachment": 0,
"tx_process_extra": 0,
"tx_process_inputs": 0,
"tx_push_global_index": 0,
"tx_store_db": 0,
"writer_tx_count": 0
},
"pos_allowed": true,
"pos_block_ts_shift_vs_actual": -1387,
"pos_diff_total_coins_rate": 0,
"pos_difficulty": "1848455949616658404658",
"pos_sequence_factor": 0,
"pow_difficulty": 12777323347117,
"pow_sequence_factor": 1,
"pre_hf_tx_freeze_period_active": false,
"seconds_for_10_blocks": 476,
"seconds_for_30_blocks": 1264,
"status": "OK",
"synchronization_start_height": 2555000,
"synchronized_connections_count": 8,
"total_coins": "14308874719144585856",
"transactions_cnt_per_day": 1325,
"transactions_volume_per_day": 6615220203700000,
"tx_count": 767742,
"tx_count_in_last_block": 0,
"tx_pool_performance_data": {
"begin_tx_time": 0,
"check_inputs_time": 0,
"check_inputs_types_supported_time": 0,
"check_keyimages_ws_ms_time": 0,
"db_commit_time": 0,
"expiration_validate_time": 0,
"tx_processing_time": 0,
"update_db_time": 0,
"validate_alias_time": 0,
"validate_amount_time": 0
},
"tx_pool_size": 0,
"white_peerlist_size": 12
}
}
Response fields:
alias_count-- The total number of unique aliases registered on the blockchain. Aliases are alternate, human-readable names associated with addresses.alt_blocks_count-- Number of alternative blocks on the blockchain.block_reward-- The base block reward that is effective for the next block. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.current_max_allowed_block_size-- Current maximum allowed cummulative block size in bytes.current_network_hashrate_350-- The PoW hash rate calculated over the last 350 blocks of any type. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_CURRENT_NETWORK_HASHRATE_350 flag is set.current_network_hashrate_50-- The PoW hash rate calculated over the last 50 blocks of any type. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_CURRENT_NETWORK_HASHRATE_50 flag is set.daemon_network_state-- Current network state of the daemon, which could be connecting, synchronizing, online, loading core, internal error, unloading core, or downloading database.default_fee-- Default fee for transactions.expiration_median_timestamp-- Median of timestamps of the last N blocks, used to determine the expiration status of transactions. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_EXPIRATIONS_MEDIAN flag is set.grey_peerlist_size-- Size of the grey peer list, which includes addresses of nodes with less consistent availability.height-- The current size of the blockchain, equal to the height of the top block plus one.incoming_connections_count-- Number of incoming P2P connections established by other nodes.is_hardfok_active-- A list of boolean values indicating whether each corresponding hardfork is active. For example, a list 'true, true, false' indicates that the first hardfork is activated, while the second is not. Hardfork #0 is always active as it is a stub.last_block_hash-- Hash of the last block. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.last_block_size-- The size of the last block in bytes. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_LAST_BLOCK_SIZE flag is set.last_block_timestamp-- Timestamp of the last block. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.last_block_total_reward-- Reward for the last block, including base reward and transaction fees. Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.last_pos_timestamp-- The timestamp of the most recent PoS block. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_LAST_POS_TIMESTAMP flag is set.last_pow_timestamp-- The timestamp of the most recent PoW block. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_LAST_POW_TIMESTAMP flag is set.max_net_seen_height-- Maximum blockchain height observed in the network by this node.mi-- The most recent mainterner's info.minimum_fee-- Minimum fee for transactions.net_time_delta_median-- A value of 0 indicates no time synchronization issues, while a value of 1 indicates the presence of time sync issues. Only available if the COMMAND_RPC_GET_INFO_FLAG_NET_TIME_DELTA_MEDIAN flag is set.offers_count-- Current number of offers in the offers service. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_PERFORMANCE flag is set.outgoing_connections_count-- Number of outgoing P2P connections to other nodes.outs_stat-- Statistics for the number of outputs that have a specific amount. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_OUTS_STAT flag is set.performance_data-- Detailed technical performance data intended for developers. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_PERFORMANCE flag is set.pos_allowed-- Boolean value indicating whether PoS mining is currently allowed based on network rules and state.pos_block_ts_shift_vs_actual-- The difference between the timestamp used in the last PoS block for mining purposes and its actual timestamp as stored in the miner's transaction extra data. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_POS_BLOCK_TS_SHIFT_VS_ACTUAL flag is set.pos_diff_total_coins_rate-- PoS difficulty divided by the total amount of all coins in the system minus a premined amount (17,517,203). Calculated only if either COMMAND_RPC_GET_INFO_FLAG_POS_DIFFICULTY or COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.pos_difficulty-- Current difficulty for Proof of Stake mining.pos_sequence_factor-- The current PoS sequence factor, representing the number of consecutive PoS blocks. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_POS_SEQUENCE_FACTOR flag is set.pow_difficulty-- Current difficulty for Proof of Work mining.pow_sequence_factor-- The current PoW sequence factor, representing the number of consecutive PoW blocks. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_POW_SEQUENCE_FACTOR flag is set.pre_hf_tx_freeze_period_active-- Boolean value indicating whether tx sending is temporarly stopped because a hardfork is coming.seconds_for_10_blocks-- The time period in seconds between the most recent block and the 10th block older. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_SECONDS_FOR_10_BLOCKS flag is set.seconds_for_30_blocks-- The time period in seconds between the most recent block and the 30th block older. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_SECONDS_FOR_30_BLOCKS flag is set.status-- Status of the call.synchronization_start_height-- Blockchain height at which the current synchronization process started. Indicates the starting point for catching up to the network's latest state.synchronized_connections_count-- Number of P2P connections to nodes that have a fully synchronized blockchain.total_coins-- The total amount of all emitted coins in the system. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_TOTAL_COINS flag is set.transactions_cnt_per_day-- The number of non-mining transactions recorded over the last 24 hours. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_TRANSACTIONS_DAILY_STAT flag is set.transactions_volume_per_day-- The total sum of input amounts from all non-mining transactions over the last 24 hours. Only old bare inputs with explicit amounts are considered. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_TRANSACTIONS_DAILY_STAT flag is set.tx_count-- Total number of transactions in the blockchain.tx_count_in_last_block-- The number of non-mining transactions in the last block. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_TX_COUNT_IN_LAST_BLOCK flag is set.tx_pool_performance_data-- Detailed technical performance data intended for developers. This information is only provided if the COMMAND_RPC_GET_INFO_FLAG_PERFORMANCE flag is set.tx_pool_size-- Number of transactions currently in the pool.white_peerlist_size-- Size of the white peer list, which includes addresses of reliable nodes.
getheight
Return current blockchain height
URL: http:://127.0.0.1:36941/getheight
Request:
{
}
Response:
{
"height": 11111,
"status": "OK"
}
Response fields:
height-- Height of the blockchain (equals to top block's height + 1).status-- Status of the call.
getblockcount
Returns the total number of blocks in the blockchain (the height of the top block plus one).
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getblockcount",
"params": {
}
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"count": 2697388,
"status": "OK"
}
}
Response fields:
count-- The total number of blocks in the blockchain, equivalent to the top block's height plus one.status-- Status of the call.
get_est_height_from_date
Give an estimation of block height by the given date.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_est_height_from_date",
"params": {
"timestamp": 1711021795
}
}
Parameters:
timestamp-- Linux timestamp for the required date.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"h": 2555000,
"status": "OK"
}
}
Response fields:
h-- Estimated height of a block.status-- Status of the call.
get_current_core_tx_expiration_median
Retrieves the current core transaction expiration median.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_current_core_tx_expiration_median",
"params": {
}
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"expiration_median": 1719591540,
"status": "OK"
}
}
Response fields:
expiration_median-- The median timestamp from the last N blocks, used to determine if transactions are expired based on their timestamp.status-- Status of the call.
get_votes
Get votes' results from the given block range.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_votes",
"params": {
"h_end": 40000,
"h_start": 0
}
}
Parameters:
h_end-- End of the block range to serach in (excluding).h_start-- Start of the block range to search in (including).
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"error_code": "",
"status": "OK",
"votes": {
"total_pos_blocks": 87482,
"votes": [{
"no": 37,
"proposal_id": "ZAP999",
"yes": 42
},{
"no": 37,
"proposal_id": "ZAP999",
"yes": 42
}]
}
}
}
Response fields:
error_code-- Error code, if any.status-- Status of the call.votes-- Found votes in the given range.total_pos_blocks-- Number of blocks in a given range.votes-- Result of votes in a given range.no-- Number of negative votes.proposal_id-- ID of the proposal.yes-- Nubmer of positve votes.no-- Number of negative votes.proposal_id-- ID of the proposal.yes-- Nubmer of positve votes.
search_by_id
Searches for a given ID across various entity types such as blocks, transactions, key images, multisig outputs, and alternative blocks, useful when the entity type is unknown or unspecified.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "search_by_id",
"params": {
"id": "729811f9340537e8d5641949e6cc58261f91f109687a706f39bae9514757e819"
}
}
Parameters:
id-- The identifier used to search across various types of entities.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK",
"types_found": ["key_image"]
}
}
Response fields:
status-- Status of the call.types_found-- List of entity types where the identifier was found.
Block Queries
getlastblockheader
Returns the block header information of the most recent block.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getlastblockheader",
"params": [""]
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_header": {
"depth": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 1719588270
},
"status": "OK"
}
}
Response fields:
block_header-- Detailed header information of the block.depth-- Depth of the block in the blockchain. Depth 0 indicates the most recent block.difficulty-- Network difficulty target that the block met.hash-- Hash of the block.height-- Height of the block in the blockchain.major_version-- Major version of the block.minor_version-- Minor version of the block.nonce-- Nonce used for generating the block to meet the network difficulty.orphan_status-- Indicates if the block is an orphan (true) or a normal block (false).prev_hash-- Hash of the previous block in the chain.reward-- Total mining reward of the block including transaction fees (if applicable).timestamp-- Timestamp of the block creation.status-- Status of the call.
getblockheaderbyhash
Retrieves the block header information for a given block hash.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getblockheaderbyhash",
"params": {
"hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f"
}
}
Parameters:
hash-- The hash of the block for which the header information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_header": {
"depth": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 1719588270
},
"status": "OK"
}
}
Response fields:
block_header-- Detailed header information of the block.depth-- Depth of the block in the blockchain. Depth 0 indicates the most recent block.difficulty-- Network difficulty target that the block met.hash-- Hash of the block.height-- Height of the block in the blockchain.major_version-- Major version of the block.minor_version-- Minor version of the block.nonce-- Nonce used for generating the block to meet the network difficulty.orphan_status-- Indicates if the block is an orphan (true) or a normal block (false).prev_hash-- Hash of the previous block in the chain.reward-- Total mining reward of the block including transaction fees (if applicable).timestamp-- Timestamp of the block creation.status-- Status of the call.
getblockheaderbyheight
Retrieves the block header information for a given block height.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getblockheaderbyheight",
"params": {
"height": 2555000
}
}
Parameters:
height-- The height of the block for which the header information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_header": {
"depth": 0,
"difficulty": "1849593878843995770114",
"hash": "f5df39c4b1590394976aa6e72f04df7836e22dbdfc1e6f61f6cc1b624d83cd94",
"height": 2697404,
"major_version": 3,
"minor_version": 0,
"nonce": 0,
"orphan_status": false,
"prev_hash": "a1b4359c02985720b0cf542678e08f0d4075e518fbd0cd54bd280269545e0e6f",
"reward": 0,
"timestamp": 1719588270
},
"status": "OK"
}
}
Response fields:
block_header-- Detailed header information of the block.depth-- Depth of the block in the blockchain. Depth 0 indicates the most recent block.difficulty-- Network difficulty target that the block met.hash-- Hash of the block.height-- Height of the block in the blockchain.major_version-- Major version of the block.minor_version-- Minor version of the block.nonce-- Nonce used for generating the block to meet the network difficulty.orphan_status-- Indicates if the block is an orphan (true) or a normal block (false).prev_hash-- Hash of the previous block in the chain.reward-- Total mining reward of the block including transaction fees (if applicable).timestamp-- Timestamp of the block creation.status-- Status of the call.
on_getblockhash
Returns block hash by the given height.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "on_getblockhash",
"params": [0]
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": ""
}
get_blocks_details
Retrieves detailed information about a sequence of blocks starting from a specific height.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_blocks_details",
"params": {
"count": 1,
"height_start": 51,
"ignore_transactions": false
}
}
Parameters:
count-- The number of blocks to retrieve from the starting height.height_start-- The starting block height from which block details are retrieved.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"blocks": [{
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
}],
"status": "OK"
}
}
Response fields:
blocks-- List of blocks with detailed information, starting from the specified height.actual_timestamp-- Actual timestamp encoded in the block's extra data for PoS blocks.already_generated_coins-- Total amount of coins generated in the blockchain up to this block.base_reward-- Base mining reward for the block.blob-- Serialized form of the block.block_cumulative_size-- Cumulative size of the block including all transactions.cumulative_diff_adjusted-- Adjusted cumulative difficulty of the blockchain up to this block.cumulative_diff_precise-- Precise cumulative difficulty of the blockchain up to this block.difficulty-- Mining difficulty of the block.height-- Height of the block in the blockchain.id-- Unique identifier of the block.is_orphan-- Indicates whether the block is an orphan.miner_text_info-- Additional textual information provided by the miner of the block.object_in_json-- Serialized representation of the block in JSON format.penalty-- Penalty applied to the reward if the block is larger than median but not large enough to be rejected.prev_id-- Hash of the previous block in the chain.summary_reward-- Total reward for the block, including base reward and transaction fees (legacy).this_block_fee_median-- Median transaction fee of the transactions within this block.timestamp-- Timestamp when the block was created, in PoS blocks used for mining.total_fee-- Total transaction fees included in the block.total_txs_size-- Total size of all transactions included in the block.transactions_details-- Detailed information about each transaction included in the block.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.type-- Type of the block.status-- Status of the call.
get_main_block_details
Retrieves detailed information about a specific block identified by its hash.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_main_block_details",
"params": {
"id": "4cf2c7c7e16d1a2a0771cd552c696dd94e7db4e1031982ed88eff99d5006ee4a"
}
}
Parameters:
id-- The hash ID of the block for which detailed information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_details": {
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
},
"status": "OK"
}
}
Response fields:
block_details-- Detailed information about the block retrieved based on the provided hash ID.actual_timestamp-- Actual timestamp encoded in the block's extra data for PoS blocks.already_generated_coins-- Total amount of coins generated in the blockchain up to this block.base_reward-- Base mining reward for the block.blob-- Serialized form of the block.block_cumulative_size-- Cumulative size of the block including all transactions.cumulative_diff_adjusted-- Adjusted cumulative difficulty of the blockchain up to this block.cumulative_diff_precise-- Precise cumulative difficulty of the blockchain up to this block.difficulty-- Mining difficulty of the block.height-- Height of the block in the blockchain.id-- Unique identifier of the block.is_orphan-- Indicates whether the block is an orphan.miner_text_info-- Additional textual information provided by the miner of the block.object_in_json-- Serialized representation of the block in JSON format.penalty-- Penalty applied to the reward if the block is larger than median but not large enough to be rejected.prev_id-- Hash of the previous block in the chain.summary_reward-- Total reward for the block, including base reward and transaction fees (legacy).this_block_fee_median-- Median transaction fee of the transactions within this block.timestamp-- Timestamp when the block was created, in PoS blocks used for mining.total_fee-- Total transaction fees included in the block.total_txs_size-- Total size of all transactions included in the block.transactions_details-- Detailed information about each transaction included in the block.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.type-- Type of the block.status-- Status of the call.
getblocktemplate
Generates a block template for mining, intended for both PoW and PoS types of blocks based on the provided parameters.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getblocktemplate",
"params": {
"explicit_transaction": "5fa8eaaf231a305053260ff91d69c6ef1ecbd0f5",
"extra_text": "OMG, you can't just ask people why they're PoW-maxi",
"pe": {
"amount": 0,
"block_timestamp": 0,
"g_index": 0,
"keyimage": "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
"stake_unlock_time": 0,
"tx_id": "0000000000000000000000000000000000000000000000000000000000000000",
"tx_out_index": 0
},
"pos_block": false,
"stakeholder_address": "",
"wallet_address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"
}
}
Parameters:
explicit_transaction-- A transaction blob that must be explicitly included in the block.extra_text-- Arbitrary data added to the extra field of the miner transaction.pe-- PoS entry details, relevant only for PoS block generation.pos_block-- Flag indicating whether the block is a PoS block.stakeholder_address-- Address where the stake is returned for PoS blocks (usually the same as 'wallet_address').wallet_address-- Address where mining rewards will be deposited.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_reward": 1000000000000,
"block_reward_without_fee": 1000000000000,
"blocktemplate_blob": "030000000000000000ae73338b792......6258a2b5ee340700",
"difficulty": "12936195379842",
"height": 2555002,
"miner_tx_tgc": {
"amount_blinding_masks": "",
"amount_blinding_masks_sum": "0000000000000000000000000000000000000000000000000000000000000000",
"amount_commitments": "",
"amount_commitments_sum": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"amounts": "",
"ao_amount_blinding_mask": "0000000000000000000000000000000000000000000000000000000000000000",
"ao_amount_commitment": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"ao_asset_id": "0000000000000000000000000000000000000000000000000000000000000000",
"ao_asset_id_pt": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"ao_commitment_in_outputs": "00",
"asset_id_blinding_mask_x_amount_sum": "0000000000000000000000000000000000000000000000000000000000000000",
"asset_id_blinding_masks": "",
"asset_ids": "",
"blinded_asset_ids": "",
"pseudo_out_amount_blinding_masks_sum": "0000000000000000000000000000000000000000000000000000000000000000",
"pseudo_out_amount_commitments_sum": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"pseudo_outs_blinded_asset_ids": "",
"pseudo_outs_plus_real_out_blinding_masks": "",
"real_in_asset_id_blinding_mask_x_amount_sum": "0000000000000000000000000000000000000000000000000000000000000000",
"real_zc_ins_asset_ids": "",
"tx_key": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"tx_outs_attr": 0,
"tx_pub_key_p": "00000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
},
"prev_hash": "ae73338b7927df71b6ed477937625c230172219306750ba97995fb5109dda703",
"seed": "0518e1373ff88ccabb28493cac10cb0731313135d880dae0d846be6016ab9acf",
"status": "OK",
"txs_fee": 0
}
}
Response fields:
block_reward-- Total block reward, including transaction fees if they are given to the miner (legacy), or the base reward if fees are burnt (current state).block_reward_without_fee-- Base block reward excluding any transaction fees.blocktemplate_blob-- Serialized block template blob.difficulty-- The mining difficulty targeted by the block template.height-- The height of the block template in the blockchain.miner_tx_tgc-- Miner transaction generation context. Intended for PoS blocks and Zarcanum.prev_hash-- Hash of the previous block in the chain.seed-- Seed value for the ProgPoWZ mining algorithm's epoch.status-- Status of the call.txs_fee-- Total fees from transactions included in the block.
submitblock
Adds new block to the blockchain. Request should contain one string with hex-encoded block blob.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "submitblock",
"params": [""]
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
}
}
Response fields:
status-- Status of the call.
submitblock2
Adds new block to the blockchain.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "submitblock2",
"params": {
"b": "030000000000000000ae73338b7926258a2b5ee340700",
"explicit_txs": [{
"blob": "36323538613262356565376139633230"
},{
"blob": "38653066306132636565333430373030"
}]
}
}
Parameters:
b-- Hex-encoded serialized block.explicit_txs-- List of hex-encoded transactions to be explicitly included in the block.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
}
}
Response fields:
status-- Status of the call.
getblocks.bin
URL: http:://127.0.0.1:36941/getblocks.bin
Request:
{
"minimum_height": 0
}
Parameters:
minimum_height-- The minimum height of the returning buch of blocks.
Response:
{
"blocks": [{
"block": ""
}],
"current_hardfork": 4,
"current_height": 2555000,
"start_height": 2000000,
"status": "OK"
}
Response fields:
blocks-- Bunch of blockscurrent_hardfork-- Current hardfork, used for wallet <-> version verificationcurrent_height-- Current height of the blockchain.start_height-- Starting height of the resulting bunch of blocks.status-- Status of the call.
Alternative Blocks
get_alt_block_details
Retrieves detailed information about a specific block identified by its hash.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_alt_block_details",
"params": {
"id": "4cf2c7c7e16d1a2a0771cd552c696dd94e7db4e1031982ed88eff99d5006ee4a"
}
}
Parameters:
id-- The hash ID of the block for which detailed information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"block_details": {
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
},
"status": "OK"
}
}
Response fields:
block_details-- Detailed information about the block retrieved based on the provided hash ID.actual_timestamp-- Actual timestamp encoded in the block's extra data for PoS blocks.already_generated_coins-- Total amount of coins generated in the blockchain up to this block.base_reward-- Base mining reward for the block.blob-- Serialized form of the block.block_cumulative_size-- Cumulative size of the block including all transactions.cumulative_diff_adjusted-- Adjusted cumulative difficulty of the blockchain up to this block.cumulative_diff_precise-- Precise cumulative difficulty of the blockchain up to this block.difficulty-- Mining difficulty of the block.height-- Height of the block in the blockchain.id-- Unique identifier of the block.is_orphan-- Indicates whether the block is an orphan.miner_text_info-- Additional textual information provided by the miner of the block.object_in_json-- Serialized representation of the block in JSON format.penalty-- Penalty applied to the reward if the block is larger than median but not large enough to be rejected.prev_id-- Hash of the previous block in the chain.summary_reward-- Total reward for the block, including base reward and transaction fees (legacy).this_block_fee_median-- Median transaction fee of the transactions within this block.timestamp-- Timestamp when the block was created, in PoS blocks used for mining.total_fee-- Total transaction fees included in the block.total_txs_size-- Total size of all transactions included in the block.transactions_details-- Detailed information about each transaction included in the block.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.type-- Type of the block.status-- Status of the call.
get_alt_blocks_details
Retrieves details of alternative blocks in the blockchain, allowing for pagination through large datasets.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_alt_blocks_details",
"params": {
"count": 1,
"offset": 0
}
}
Parameters:
count-- The number of alternative blocks to retrieve from the specified offset.offset-- The offset in the list of alternative blocks from which to start retrieval.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"blocks": [{
"actual_timestamp": 1557345925,
"already_generated_coins": "17517253670000000000",
"base_reward": 1000000000000,
"blob": "",
"block_cumulative_size": 6794,
"block_tself_size": 0,
"cumulative_diff_adjusted": "42413051198",
"cumulative_diff_precise": "28881828324942",
"difficulty": "951296929031",
"effective_fee_median": 0,
"height": 51,
"id": "af05b814c75e10872afc0345108e830884bc4c32091db783505abe3dac9929cf",
"is_orphan": false,
"miner_text_info": "",
"object_in_json": "",
"penalty": 0,
"pow_seed": "",
"prev_id": "37fe382c755bb8869e4f5255f2aed6a8fb503e195bb4180b65b8e1450b84cafe",
"summary_reward": 1001000000000,
"this_block_fee_median": 1000000000,
"timestamp": 1557345925,
"total_fee": 1000000000,
"total_txs_size": 6794,
"transactions_details": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}],
"type": 1
}],
"status": "OK"
}
}
Response fields:
blocks-- List of alternative blocks with detailed information, retrieved based on the specified parameters.actual_timestamp-- Actual timestamp encoded in the block's extra data for PoS blocks.already_generated_coins-- Total amount of coins generated in the blockchain up to this block.base_reward-- Base mining reward for the block.blob-- Serialized form of the block.block_cumulative_size-- Cumulative size of the block including all transactions.cumulative_diff_adjusted-- Adjusted cumulative difficulty of the blockchain up to this block.cumulative_diff_precise-- Precise cumulative difficulty of the blockchain up to this block.difficulty-- Mining difficulty of the block.height-- Height of the block in the blockchain.id-- Unique identifier of the block.is_orphan-- Indicates whether the block is an orphan.miner_text_info-- Additional textual information provided by the miner of the block.object_in_json-- Serialized representation of the block in JSON format.penalty-- Penalty applied to the reward if the block is larger than median but not large enough to be rejected.prev_id-- Hash of the previous block in the chain.summary_reward-- Total reward for the block, including base reward and transaction fees (legacy).this_block_fee_median-- Median transaction fee of the transactions within this block.timestamp-- Timestamp when the block was created, in PoS blocks used for mining.total_fee-- Total transaction fees included in the block.total_txs_size-- Total size of all transactions included in the block.transactions_details-- Detailed information about each transaction included in the block.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.type-- Type of the block.status-- Status of the call.
Transaction Queries
get_tx_details
Retrieves detailed information about a specific transaction.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_tx_details",
"params": {
"tx_hash": "d46c415c3aa3f3e17bd0bf85ffb813cacf4d9595d2d5392f42dacbaffcffdc70"
}
}
Parameters:
tx_hash-- The hash of the transaction for which detailed information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK",
"tx_info": {
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}
}
}
Response fields:
status-- Status of the call.tx_info-- Detailed information about the transaction.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.
gettransactions
Retreive transactions by their IDs.
URL: http:://127.0.0.1:36941/gettransactions
Request:
{
"txs_hashes": ["146791c4f5ca94bcf423557e5eb859a3a69991bd33960d52f709d88bf5d1ac6d","ec4d913a40a9ac1fbd9d33b71ef507b5c85d1f503b89096618a18b08991b5171"]
}
Parameters:
txs_hashes-- List of transactions' IDs.
Response:
{
"missed_tx": ["ec4d913a40a9ac1fbd9d33b71ef507b5c85d1f503b89096618a18b08991b5171"],
"status": "OK",
"txs_as_hex": ["7d914497d91442f8f3c2268397d914497d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc2f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"]
}
Response fields:
missed_tx-- Missed transactions hashesstatus-- Status of the call.txs_as_hex-- Transactions stored as blobs
decrypt_tx_details
Decrypts transaction private information. Should be used only with your own local daemon for security reasons.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "decrypt_tx_details",
"params": {
"outputs_addresses": ["iTHNQGNCbu8BH7FhQuzsv5CVsE3veDX1CFCxk9jsqRfA4tFcUPNwQa4DWLFvyaKvs3HGb8xfGDGQq871c9P4iRpt8SFusoqSzJ","iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
"tx_blob": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC",
"tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"tx_secret_key": "2e0b840e70dba386effd64c5d988622dea8c064040566e6bf035034cbb54a5c08"
}
}
Parameters:
outputs_addresses-- Address of each of tx's output. Order is important and should correspond to order of tx's outputs. Empty strings are ignored.tx_blob-- [or] base64-encoded or hex-encoded tx blob. Can be ommited if tx_id is provided.tx_id-- [either] ID for a transaction if it is already in the blockchain. Can be ommited if tx_blob is provided.tx_secret_key-- Hex-encoded transaction secret key.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"decoded_outputs": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"amount": 10000000000000,
"asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
"out_index": 1,
"payment_id": 0
}],
"status": "OK",
"tx_in_json": "ewogICJ2ZXJzaW9uIjogMSwgC....iAgInZpbiI6IFsgewogICAgIC",
"verified_tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
Response fields:
decoded_outputs-- Transaction's decoded outputsaddress-- Destination address.amount-- Amount begin transferred.asset_id-- Asset id.out_index-- Index of the corresponding output in the transaction.payment_id-- [optional] Intrinsic per-output 8 byte long payment idstatus-- Status code of operation, OK if successtx_in_json-- Serialized transaction represented in JSON, encoded in Base64.verified_tx_id-- (Re)calculated transaction id. Can be used in third-party proof generation.
find_outs_in_recent_blocks
Retrieves information about outputs in recent blocks that are targeted for the given address with the corresponding secret view key.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "find_outs_in_recent_blocks",
"params": {
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"blocks_limit": 1711021795,
"viewkey": "5fa8eaaf231a305053260ff91d69c6ef1ecbd0f5"
}
}
Parameters:
address-- Target address for which outputs are being searchedblocks_limit-- Block count limit. If 0, only the transaction pool will be searched. Maximum and default is 5.viewkey-- Secret view key corresponding to the given address.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"blockchain_top_block_height": 2555000,
"blocks_limit": 5,
"outputs": [{
"amount": 1000000000000,
"asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
"output_tx_index": 2,
"payment_id": 0,
"tx_block_height": 2555000,
"tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}],
"status": "OK"
}
}
Response fields:
blockchain_top_block_height-- Height of the most recent block in the blockchain.blocks_limit-- Used limit for block count.outputs-- List of found outputs.amount-- The amount of the output.asset_id-- Asset ID of the output.output_tx_index-- Index of the output in the transaction.payment_id-- [optional] 8-bytes long intrinsic payment idtx_block_height-- Block height where the transaction is present.tx_id-- Transaction ID where the output is present, if found.status-- Status of the call.
sendrawtransaction
Broadcasts a raw transaction encoded in hexadecimal format to the network.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "sendrawtransaction",
"params": {
"tx_as_base64": "AwElEBr7PxIAAAAAABr......cQAAAAAAABqBJAAAAAAAABo6BQ",
"tx_as_hex": "00018ed1535b8b4862e.....368cdc5a86"
}
}
Parameters:
tx_as_base64-- The transaction data as a base64 string, ready for network broadcast. Used only if tx_as_hex is emptytx_as_hex-- The transaction data as a hexadecimal string, ready for network broadcast.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
}
}
Response fields:
status-- Status of the call.
validate_signature
Validates a Schnorr signature for arbitrary data. The public key for verification is provided directly or retrieved using an associated alias.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "validate_signature",
"params": {
"alias": "sowle",
"buff": "SSBkaWRuJ3QgZXhwZWN0IGFueW9uZSB0byBkZWNyeXB0IHRoaXMgZGF0YSwgc2luY2UgaXQncyBqdXN0IGFuIGV4YW1wbGUuIEJ1dCB5b3UgZGVjcnlwdGVkIGl0ISBJJ20gYW1hemVkLg==",
"pkey": "",
"sig": "5c202d4bf82c2dd3c6354e2f02826ca72c797950dbe8db5bc5e3b2e60290a407ac2ef85bfc905ace8fe3b3819217084c00faf7237fee3ad2f6a7f662636cd20f"
}
}
Parameters:
alias-- Alias to retrieve the associated public spend key if no explicit public key is provided for verification.buff-- Base64 encoded data for which the signature is to be validated.pkey-- Public key used for signature verification, encoded as a hexadecimal string. If null or not set, the public key is retrieved using the provided alias.sig-- Schnorr signature to validate, encoded as a hexadecimal string.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK"
}
}
Response fields:
status-- Status of the call.
get_out_info
Returns transaction ID and local output index for a given output amount and its global index.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_out_info",
"params": {
"amount": 3000000000000,
"i": 0
}
}
Parameters:
amount-- The specific amount of output to query.i-- The global index of the output amount to be queried.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"out_no": 7,
"status": "OK",
"tx_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
Response fields:
out_no-- Local output index within the transaction.status-- Status of the call.tx_id-- Transaction ID where the queried output is present, if found.
get_multisig_info
Retrieve basic information about a multisig output using its unique identifier (hash).
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_multisig_info",
"params": {
"ms_id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
Parameters:
ms_id-- The multisig output's unique identifier (hash).
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"out_no": 11,
"status": "OK",
"tx_id": "a88541e38d64f87c41b9153412d1d7667f6e4337fe429ed1374722355fa7b423"
}
}
Response fields:
out_no-- Local output index within the transaction.status-- Status of the call.tx_id-- Transaction ID where the multisig output is present, if found.
check_keyimages.bin
Check spent status of given key images.
URL: http:://127.0.0.1:36941/check_keyimages.bin
Request:
{
}
Response:
{
"images_stat": [0],
"status": "OK"
}
Response fields:
images_stat-- List of spent states, where 1 means unspent and 0 means spent.status-- Status of the call.
Pool Operations
get_pool_info
Obtain basic information about the transaction pool.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_pool_info",
"params": {
}
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases_que": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"error_code": "",
"status": "OK"
}
}
Response fields:
aliases_que-- List of aliases from txs that are currently in the tx pool.address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).error_code-- Error code, if there's any error (optional).status-- Status code, OK if succeeded.
get_pool_txs_brief_details
Retrieves brief details about specific transactions in the transaction pool, identified by their IDs.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_pool_txs_brief_details",
"params": {
"ids": ["bd9a89f95c9115d29540c6778dab9d9798eb251143dcd4b8960fcd9730a1471c","1c938f04c935d976310c4338fc570ea20777951471609f3edecb341ea4932b0a"]
}
}
Parameters:
ids-- List of transaction IDs.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK",
"txs": [{
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"sz": 6142,
"total_amount": 9000000000
}]
}
}
Response fields:
status-- Status of the call.txs-- List of transactions with detailed information.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.sz-- Size of the transaction in bytes.total_amount-- Total amount transferred in the transaction (legacy, for pre-Zarcanum txs).
get_pool_txs_details
Retrieves detailed information about specific transactions in the transaction pool, identified by their IDs.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_pool_txs_details",
"params": {
"ids": ["bd9a89f95c9115d29540c6778dab9d9798eb251143dcd4b8960fcd9730a1471c","1c938f04c935d976310c4338fc570ea20777951471609f3edecb341ea4932b0a"]
}
}
Parameters:
ids-- List of transaction IDs.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK",
"txs": [{
"amount": 18999000000000,
"attachments": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"blob": "ARMBgKCUpY0dBBoAAAAAAAAAABoCAAAAAAAAABoKAAAAAAAAABoPAAAAAAAAACVA4FRLH",
"blob_size": 6794,
"extra": [{
"details_view": "",
"short_view": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"type": "pub_key"
}],
"fee": 1000000000,
"id": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8",
"ins": [{
"amount": 1000000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_indexes": [0,2,12,27],
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"kimage_or_ms_id": "2540e0544b1fed3b104976f803dbd83681335c427f9d601d9d5aecf86ef276d2",
"multisig_count": 0
}],
"keeper_block": 51,
"object_in_json": "ewogICJ2ZXJzaW9uIjogMSwgCiAgInZpbiI6IFsgewogICAgIC",
"outs": [{
"amount": 9000000000,
"asset_id": "7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323",
"global_index": 0,
"gw_addr": "gwZ5sqZkre33rxhoo9ht5xcmzy5khvr2hFSfvk7TeXeMXxby7acC3fs1D",
"is_spent": false,
"minimum_sigs": 0,
"payment_id": 0,
"pub_keys": ["7d0c755e7e24a241847176c9a3cf4c970bcd6377018068abe6fe4535b23f5323"]
}],
"pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"timestamp": 1557345925
}]
}
}
Response fields:
status-- Status of the call.txs-- List of transactions with detailed information.amount-- Total output amount of the transaction (legacy, for pre-Zarcanum txs).attachments-- Additional attachments to the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.blob-- Serialized form of the transaction, encoded in Base64.blob_size-- Size of the serialized transaction in bytes.extra-- Extra data associated with the transaction.details_view-- A detailed representation of the extra entry.short_view-- A concise representation of the extra entry.type-- Type of the extra entry in the transaction.fee-- Transaction fee in the smallest currency unit.id-- Hash of the transaction.ins-- Inputs of the transaction.amount-- The amount of coins being transacted.asset_id-- [optional] Asset ID (for txin_gateway only)global_indexes-- List of global indexes indicating the outputs referenced by this input, where only one is actually being spent (only for txin_zc_input).gw_addr-- [optional] Gateway source address (for txin_gateway only)kimage_or_ms_id-- Contains either the key image for the input or the multisig output ID, or gateway address, depending on the input type.multisig_count-- Number of multisig signatures used, relevant only for multisig outputs.keeper_block-- Block height where the transaction is confirmed, or -1 if it is unconfirmed.object_in_json-- Serialized transaction represented in JSON, encoded in Base64.outs-- Outputs of the transaction.amount-- The output's amount, 0 for ZC outputs.asset_id-- [optional] Asset ID (for tx_out_gateway only)global_index-- Global index of the output for this specific amount.gw_addr-- [optional] Gateway destination address (for tx_out_gateway only)is_spent-- Indicates whether the output has been spent.minimum_sigs-- Minimum number of signatures required to spend the output, for multisig outputs only.payment_id-- [optional] Intrinsic per-output 8 byte long payment idpub_keys-- List of public keys associated with the output.pub_key-- Public key associated with the transaction.timestamp-- Timestamp when the transaction was created.
get_all_pool_tx_list
Retrieves a list of all transaction IDs currently in the transaction pool.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_all_pool_tx_list",
"params": {
}
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"ids": [""],
"status": "OK"
}
}
Response fields:
ids-- List of all transaction IDs currently in the transaction pool.status-- Status of the call.
get_tx_pool.bin
Retreives transactions from tx pool (and other information).
URL: http:://127.0.0.1:36941/get_tx_pool.bin
Request:
{
}
Response:
{
"status": "OK",
"tx_expiration_ts_median": 1711021795,
"txs": ["7d914497d91442f8f3c2268397d914497d91442f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc2f8f3c22683585eaa60b53757d49bf046a96269cef45c1bc9ff7300cc"]
}
Response fields:
status-- Status of the call.tx_expiration_ts_median-- Timestamp median value of last TX_EXPIRATION_TIMESTAMP_CHECK_WINDOW blocks.txs-- Transactions as blobs.
Alias Operations
alias_lookup
Give an estimation of block height by the given date.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "alias_lookup",
"params": {
"alias_first_leters": "al",
"n_of_items_to_return": 10
}
}
Parameters:
alias_first_leters-- Prefix by which the search will be performed.n_of_items_to_return-- Maximum number of elements returned (not bigger then 10)
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"error_code": "",
"status": "OK"
}
}
Response fields:
aliases-- List of alias_rpc_details objects, each containing detailed information about each alias registered to the specified address.address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).error_code-- Error code, if any.status-- Status of the call.
get_alias_details
Retrieves information about a specific address alias.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_alias_details",
"params": {
"alias": "gigabyted"
}
}
Parameters:
alias-- The alias name for which details are being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"alias_details": {
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
},
"status": "OK"
}
}
Response fields:
alias_details-- Contains the detailed information about the specified alias, including the associated wallet address, tracking key, comment etc..address-- Address of the alias.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).status-- Status of the call.
get_alias_by_address
Retrieves all aliases registered for a given address.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_alias_by_address",
"params": ""
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"alias_info_list": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
Response fields:
alias_info_list-- List of alias_rpc_details objects, each containing detailed information about each alias registered to the specified address.address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).status-- Status of the call.
get_aliases
Retrieves a specified portion of all registered aliases, allowing pagination through large sets of aliases.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_aliases",
"params": {
"count": 2,
"offset": 0
}
}
Parameters:
count-- The number of aliases to retrieve from the specified offset.offset-- The offset in the list of all aliases from which to start retrieving.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
},{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
Response fields:
aliases-- List of alias_rpc_details objects, each containing information about an individual alias retrieved based on the request parameters.address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).status-- Status of the call.
get_all_alias_details
Retrieves all registered aliases along with associated information.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_all_alias_details",
"params": {
}
}
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"aliases": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
},{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"alias": "zxdya6q6whzwqjkmtcsjpc3ku",
"comment": "Society is never gonna make any progress until we all learn to pretend to like each other.",
"tracking_key": "18bb94f69ed61b47b6556f3871b89dff8f9a6f4f798f706fd199b05ccf8ef20c"
}],
"status": "OK"
}
}
Response fields:
aliases-- List of alias_rpc_details objects, each containing information about an individual alias.address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).address-- Address of the alias.alias-- Alias itself, a brief shortcut for an address.comment-- Arbitrary comment (optional).tracking_key-- View secret key of the corresponding address (optional).status-- Status of the call.
get_alias_reward
Retrieves the cost of registering an alias on the blockchain.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_alias_reward",
"params": {
"alias": "zxdya6q6whzwqjkmtcsjpc3ku"
}
}
Parameters:
alias-- The alias name for which the registration cost is being queried.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"reward": 100000000000,
"status": "OK"
}
}
Response fields:
reward-- The registration cost for the specified alias.status-- Status of the call.
Asset Operations
get_asset_info
Obtain information for the given asset by its ID.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_asset_info",
"params": {
"asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6"
}
}
Parameters:
asset_id-- ID of an asset.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"asset_descriptor": {
"current_supply": 500000000000000000,
"decimal_point": 12,
"full_name": "Lethean wrapped ABC",
"hidden_supply": false,
"meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
"total_max_supply": 1000000000000000000
},
"status": "OK"
}
}
Response fields:
asset_descriptor-- Descriptor of the given asset.current_supply-- Currently emitted supply for the given asset (ignored for REGISTER operation).decimal_point-- Decimal point.full_name-- Full name of the asset.hidden_supply-- This field is reserved for future use and will be documented later.meta_info-- Any other information associated with the asset, by default in a json format.owner-- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.owner_eth_pub_key-- [Optional] Owner's key in the case when ETH signature is used.ticker-- Ticker associated with the asset.total_max_supply-- Maximum possible supply for a given asset, cannot be changed after deployment.status-- Status of the call.
get_assets_list
Return list of assets registered in Lethean blockchain
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_assets_list",
"params": {
"count": 100,
"offset": 0
}
}
Parameters:
count-- Number of items to recieveoffset-- Offset for the item to start copying
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"assets": [{
"asset_id": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"current_supply": 500000000000000000,
"decimal_point": 12,
"full_name": "Lethean wrapped ABC",
"hidden_supply": false,
"meta_info": "{ \"some_arbitrary_field_name\": \"some arbitrary value\"}",
"owner": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"owner_eth_pub_key": "",
"ticker": "ZABC",
"total_max_supply": 1000000000000000000
}],
"status": "OK"
}
}
Response fields:
assets-- List of assets registered in Lethean blockchainasset_id-- Asset IDcurrent_supply-- Currently emitted supply for the given asset (ignored for REGISTER operation).decimal_point-- Decimal point.full_name-- Full name of the asset.hidden_supply-- This field is reserved for future use and will be documented later.meta_info-- Any other information associated with the asset, by default in a json format.owner-- Owner's key, used only for EMIT and UPDATE validation, can be changed by transferring asset ownership.owner_eth_pub_key-- [Optional] Owner's key in the case when ETH signature is used.ticker-- Ticker associated with the asset.total_max_supply-- Maximum possible supply for a given asset, cannot be changed after deployment.status-- Status code of operation, OK if success
Marketplace Operations
marketplace_global_get_offers_ex
Fetch from daemon offers listed in the marketplace with given filters
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "marketplace_global_get_offers_ex",
"params": {
"filter": {
"amount_low_limit": 0,
"amount_up_limit": 0,
"bonus": false,
"category": "",
"keyword": "tubes",
"limit": 100,
"location_city": "",
"location_country": "",
"offer_type_mask": 0,
"offset": 0,
"order_by": 0,
"primary": "",
"rate_low_limit": "0.1",
"rate_up_limit": "0.1",
"reverse": false,
"target": "",
"timestamp_start": 0,
"timestamp_stop": 0
}
}
}
Parameters:
filter-- Filter options.amount_low_limit-- Lower limit for the amount of offersamount_up_limit-- Upper limit for the amount of offersbonus-- Bonus associated with the offerscategory-- Category of the offerskeyword-- Keyword for searching offerslimit-- Maximum number of results to returnlocation_city-- City of the location for the offerslocation_country-- Country of the location for the offersoffer_type_mask-- Mask representing the types of offers to include in the results, conbination of this: OFFER_TYPE_MASK_PRIMARY_TO_TARGET 0x00000001, OFFER_TYPE_MASK_TARGET_TO_PRIMARY 0x00000002, OFFER_TYPE_MASK_GOODS_TO_PRIMARY 0x00000004, OFFER_TYPE_MASK_PRIMARY_TO_GOODS 0x00000008offset-- Offset for paginationorder_by-- Field to order the results by one on this: ORDER_BY_TIMESTAMP=0,ORDER_BY_AMOUNT_PRIMARY=1,ORDER_BY_AMOUNT_TARGET=2,ORDER_BY_AMOUNT_RATE=3,ORDER_BY_PAYMENT_TYPES=4,ORDER_BY_CONTACTS=5,ORDER_BY_LOCATION=6,ORDER_BY_NAME=7primary-- Primary field for the offersrate_low_limit-- Lower limit for the raterate_up_limit-- Upper limit for the ratereverse-- Flag to indicate whether the results should be sorted in reverse ordertarget-- Target entity of the offerstimestamp_start-- Start timestamp for filtering resultstimestamp_stop-- Stop timestamp for filtering results
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"offers": [{
"ap": "100000",
"at": "10000000",
"b": "",
"cat": "",
"cnt": "Ranko +38211111111",
"com": "Dobr dan",
"do": "full amount, by parts",
"et": 0,
"fee": 10000000000,
"index_in_tx": 0,
"lci": "Kolasin",
"lco": "Montenegro",
"ot": 0,
"p": "LTHN",
"pt": "lethean",
"security": "40fa6db923728b38962718c61b4dc3af1acaa1967479c73703e260dc3609c58d",
"t": "USDT",
"timestamp": 1712683857,
"tx_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
"tx_original_hash": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
"url": ""
}],
"status": "OK",
"total_offers": 1
}
}
Response fields:
offers-- List of offers related to the operation.ap-- Amount of the currencyat-- Smount of other currency or goodsb-- Bonus associated with the offercat-- Category of the offercnt-- Contacts related to the offercom-- Comment associated with the offerdo-- Deal option for the offeret-- Expiration time of the offerfee-- Fee associated with the transactionindex_in_tx-- Index of the tx_service_attachment entrie in transactionlci-- City of the offer locationlco-- Country of the offer locationot-- Type of the offer: OFFER_TYPE_PRIMARY_TO_TARGET(SELL ORDER) - 0, OFFER_TYPE_TARGET_TO_PRIMARY(BUY ORDER) - 1 etc.p-- Currency for goodspt-- Types of payment accepted for the offersecurity-- Onwer's public key for access controlt-- Target: currency / goodstimestamp-- Timestamp of the transactiontx_hash-- Transaction hash represented as a hexadecimal stringtx_original_hash-- Origin transaction hash represented as a hexadecimal string(if offer updated)url-- URL for previewing the offerstatus-- Status of the operation.total_offers-- Total number of offers.
Integrated Addresses
get_integrated_address
Make integrated address from regular address
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "get_integrated_address",
"params": {
"payment_id": "1dfe5a88ff9effb3",
"regular_address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"
}
}
Parameters:
payment_id-- Hex-encoded Payment ID to be associated with the this address. If empty then wallet would generate new payment id using system random libraryregular_address-- Lethean wallet address to be used as a base for integrated address
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"integrated_address": "iZ2EMyPD7g28hgBfboZeCENaYrHBYZ1bLFi5cgWvn4WJLaxfgs4kqG6cJi9ai2zrXWSCpsvRXit14gKjeijx6YPCLJEv6Fx4rVm1hdAGQFis",
"payment_id": "1dfe5a88ff9effb3",
"status": "OK"
}
}
Response fields:
integrated_address-- Integrated address combining a standard address and payment ID, if applicable.payment_id-- Payment ID associated with the this address.status-- Status
Gateway Operations
gateway_create_transfer
Initiates a transfer from gateway address. Create tx that need to be signed.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "gateway_create_transfer",
"params": {
"comment": "Some comment",
"destinations": [{
"address": "iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY",
"amount": 10000000000000,
"asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
"payment_id": 1020394
}],
"fee": 100000000,
"origin_gateway_id": "gateway1qxyz...",
"service_entries": [{
"body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
"flags": 0,
"instruction": "K",
"security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
"service_id": "C"
}],
"service_entries_permanent": false
}
}
Parameters:
comment-- Comment for the gateway transfer.destinations-- Details of the gateway transfer destinations.address-- Destination addressamount-- Amount to transfer to destinationasset_id-- Asset id to transferpayment_id-- [optional] Intrinsic 8-byte payment id for this destination. Incompatible with integrated addresses.fee-- Transaction fee for the gateway transfer.origin_gateway_id-- Origin gateway ID for the transfer.service_entries-- Service entries for the gateway transfer.body-- Hex-encoded body of the attachmentflags-- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )instruction-- Instruction that make sence for this particular servicesecurity-- Hex-encoded public key of the owner, optionalservice_id-- Service ID, identificator that diferent one service from anotherservice_entries_permanent-- Whether the service entries are permanent.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"status": "OK",
"tx_blob": "0100000001...",
"tx_hash_to_sign": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
Response fields:
status-- Status of the call.tx_blob-- Hex representation of the transaction blob.tx_hash_to_sign-- Hash of the transaction created for the gateway transfer.
gateway_get_address_history
Retrieves the transaction history for a specific gateway address.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "gateway_get_address_history",
"params": {
"count": 10,
"gateway_address": "gateway1qxyz...",
"gateway_view_secret_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"offset": 0
}
}
Parameters:
count-- The number of transactions to retrieve from the specified offset.gateway_address-- The gateway address for which transaction history is being requested.gateway_view_secret_key-- View secret key to decrypt attachments and payment idoffset-- The offset in the transaction history from which to start retrieval.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"balances": [{
"amount": 100000000,
"asset_id": "729811f9340537e8d5641949e6cc58261f91f109687a706f39bae9514757e819"
}],
"status": "OK",
"total_transactions": 100,
"transactions": [{
"ado": {
"operation_type": 1,
"opt_amount_commitment": "5688b56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"opt_asset_id": "cc4e69455e63f4a581257382191de6856c2156630b3fba0db4bdd73ffcfb36b6",
"version": 2
},
"comment": "Comment here",
"contract": [{
"cancel_expiration_time": 0,
"contract_id": "0000000000000000000000000000000000000000000000000000000000000000",
"expiration_time": 0,
"height": 0,
"is_a": false,
"payment_id": "",
"private_detailes": {
"a_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"a_pledge": 0,
"b_addr": "iTHN11111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111",
"b_pledge": 0,
"c": "",
"t": "",
"to_pay": 0
},
"state": 0,
"timestamp": 0
}],
"employed_entries": {
},
"fee": 10000000000,
"height": 0,
"is_mining": false,
"is_mixing": false,
"is_service": false,
"remote_addresses": ["iTHNUNiuu3VP1yy8xH2y5iQaABKXurdjqZmzFiBiyR4dKG3j6534e9jMriY6SM7PH8NibVwVWW1DWJfQEWnSjS8n3Wgx86pQpY"],
"remote_aliases": ["roger"],
"service_entries": [{
"body": "dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85dcfd7e055a6a3043ea3541a571a57a63e25dcc64e4a270f14fa9a58ac5dbec85",
"flags": 0,
"instruction": "K",
"security": "d8f6e37f28a632c06b0b3466db1b9d2d1b36a580ee35edfd971dc1423bc412a5",
"service_id": "C"
}],
"show_sender": false,
"subtransfers_by_pid": [{
"payment_id": "a1a2a3a4a5a6a7a8",
"subtransfers": [{
"amount": 1000000000000,
"asset_id": "cc608f59f8080e2fbfe3c8c80eb6e6a953d47cf2d6aebd345bada3a1cab99852",
"is_income": false
}]
}],
"timestamp": 1712590951,
"transfer_internal_index": 12,
"tx_blob_size": 0,
"tx_hash": "5509650e12c8f901e6731a2bfaf3abfd64409e3e1366d3d94cd11db8beddb0c3",
"tx_type": 0,
"unlock_time": 0
}]
}
}
Response fields:
balances-- List of balances for different asset_id associated with the gateway address at the time of the request.amount-- The amount of the specified currency in the gateway balance entry.asset_id-- The asset ID for the gateway balance entry.status-- Status of the call.total_transactions-- Total number of transactions associated with the specified gateway address.transactions-- List of transactions associated with the specified gateway address, retrieved based on the provided parameters.ado-- "Asset Descriptor Operation" if it was present in transactionoperation_type-- Asset operation type identifieropt_amount_commitment-- (optional) Asset operation amount commitment (register/emit/burn).opt_asset_id-- (optional) ID of an asset (emit/burn/update).version-- Asset operation type struct versioncomment-- Some human-readable commentcontract-- Escrow contract if it's part of transactionemployed_entries-- Mark entries from transaction that was connected to this walletfee-- Transaction feeheight-- Height of the block that included transaction(0 i transaction is unconfirmed)is_mining-- Tells if this transaction is coinbase transaction(ie generated by PoW mining or by PoS staking)is_mixing-- Tells if this transaction using mixins or not(auditble wallets normally don't use mixins)is_service-- Tells if this transaction is used as utility by one of Lethean services(contracts, ionic swaps, etc)remote_addresses-- Remote addresses of this transfer(destination if it's outgoing transfer or sender if it's incoming transaction)remote_aliases-- Aliases for remot addresses, of discoveredservice_entries-- Additional entries that might be stored in transaction but not part of it's consensusbody-- Hex-encoded body of the attachmentflags-- Flags that help wallet to automatically process some properties of the attachment(combination of TX_SERVICE_ATTACHMENT_ENCRYPT_BODY=1, TX_SERVICE_ATTACHMENT_DEFLATE_BODY=2, TX_SERVICE_ATTACHMENT_ENCRYPT_BODY_ISOLATE_AUDITABLE=4,TX_SERVICE_ATTACHMENT_ENCRYPT_ADD_PROOF=8 )instruction-- Instruction that make sence for this particular servicesecurity-- Hex-encoded public key of the owner, optionalservice_id-- Service ID, identificator that diferent one service from anothershow_sender-- If sender is included in txsubtransfers_by_pid-- Essential part of transfer entry: amounts that been transfered in this transaction grouped by payment ID and then by asset IDpayment_id-- HEX-encoded payment id, or empty string if not presentsubtransfers-- Amounts that been transfered in this transaction with corresponding payment ID grouped by asset IDamount-- Amount of asset the had been transferedasset_id-- Asset idis_income-- Indicates if transfer was income our outgoingtimestamp-- Timestamp of the block that included transaction in blockchain, 0 for unconfirmedtransfer_internal_index-- Index of this entry in the wallet's array of transaction's historytx_blob_size-- Size of transaction in bytestx_hash-- Transaction ID(hash)tx_type-- Could be one of this: GUI_TX_TYPE_NORMAL=0, GUI_TX_TYPE_PUSH_OFFER=1, GUI_TX_TYPE_UPDATE_OFFER=2, GUI_TX_TYPE_CANCEL_OFFER=3, GUI_TX_TYPE_NEW_ALIAS=4,GUI_TX_TYPE_UPDATE_ALIAS=5,GUI_TX_TYPE_COIN_BASE=6,GUI_TX_TYPE_ESCROW_PROPOSAL=7,GUI_TX_TYPE_ESCROW_TRANSFER=8,GUI_TX_TYPE_ESCROW_RELEASE_NORMAL=9,GUI_TX_TYPE_ESCROW_RELEASE_BURN=10,GUI_TX_TYPE_ESCROW_CANCEL_PROPOSAL=11,GUI_TX_TYPE_ESCROW_RELEASE_CANCEL=12unlock_time-- Unlock time of this transfer (if present)
gateway_get_address_info
Retrieves information about a gateway address.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "gateway_get_address_info",
"params": {
"gateway_address": "gateway1qxyz..."
}
}
Parameters:
gateway_address-- The gateway address for which information is being requested.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"balances": [{
"amount": 100000000,
"asset_id": "729811f9340537e8d5641949e6cc58261f91f109687a706f39bae9514757e819"
}],
"descriptor_info": {
"meta_info": "Some metadata",
"opt_owner_custom_schnorr_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8",
"opt_owner_ecdsa_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8e2",
"opt_owner_eddsa_pub_key": "f74bb56a5b4fa562e679ccaadd697463498a66de4f1760b2cd40f11c3a00a7a8"
},
"gateway_view_pub_key": "0feef5e2ea0e88b592c0a0e6639ce73e12ea9b3136d89464748fcb60bb6f18f5",
"payment_id": "4cf2c7c7e16d1a2a",
"status": "OK"
}
}
Response fields:
balances-- List of balances for different asset_id associated with the gateway address.amount-- The amount of the specified currency in the gateway balance entry.asset_id-- The asset ID for the gateway balance entry.descriptor_info-- Information about the specified gateway address.meta_info-- Additional metadata about the gatewayopt_owner_custom_schnorr_pub_key-- owner's custom Schnorr signature public keyopt_owner_ecdsa_pub_key-- owner's Ethereum public keyopt_owner_eddsa_pub_key-- owner's EdDSA public keygateway_view_pub_key-- Gateway view public key associated with the gateway address.payment_id-- Payment ID associated with the gateway address.status-- Status of the call.
gateway_sign_transfer
Signs a transfer from gateway address.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "gateway_sign_transfer",
"params": {
"opt_custom_schnorr_signature": "b1c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef01",
"opt_ecdsa_signature": "b1c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123",
"opt_eddsa_signature": "b1c3d4e5f60718293a4b5c6d7e8f90123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef01",
"tx_blob": "0100000001...",
"tx_hash_to_sign": "a6e8da986858e6825fce7a192097e6afae4e889cabe853a9c29b964985b23da8"
}
}
Parameters:
opt_custom_schnorr_signature-- Custom Schnorr signature for signing the transaction.opt_ecdsa_signature-- Ethereum signature for signing the transaction.opt_eddsa_signature-- EdDSA signature for signing the transaction.tx_blob-- Hex representation of the transaction blob to sign.tx_hash_to_sign-- Hash of the transaction to sign.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"signed_tx_blob": "0100000001...",
"status": "OK"
}
}
Response fields:
signed_tx_blob-- Hex representation of the signed transaction blob.status-- Status of the call.
Random Outputs (Decoys)
getrandom_outs
Retrieve random decoy outputs for specified amounts (legacy format).
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getrandom_outs",
"params": {
"amounts": [0,10000000000],
"outs_count": 2,
"use_forced_mix_outs": false
}
}
Parameters:
amounts-- List of amounts for which decoy outputs are requested.outs_count-- Number of decoy outputs requested for each amount.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs.bin
Retrieve random decoy outputs for specified amounts (legacy format).
URL: http:://127.0.0.1:36941/getrandom_outs.bin
Request:
{
"amounts": [0,10000000000],
"outs_count": 2,
"use_forced_mix_outs": false
}
Parameters:
amounts-- List of amounts for which decoy outputs are requested.outs_count-- Number of decoy outputs requested for each amount.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs1
Retrieve random decoy outputs for specified amounts, to be used for mixing in transactions.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getrandom_outs1",
"params": {
"amounts": [0,10000000000,5000000000000],
"decoys_count": 10,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
}
Parameters:
amounts-- List of amounts for which decoy outputs are requested.decoys_count-- Number of decoy outputs required for each amount specified.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs1.bin
Retrieve random decoy outputs for specified amounts, to be used for mixing in transactions.
URL: http:://127.0.0.1:36941/getrandom_outs1.bin
Request:
{
"amounts": [0,10000000000,5000000000000],
"decoys_count": 10,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
Parameters:
amounts-- List of amounts for which decoy outputs are requested.decoys_count-- Number of decoy outputs required for each amount specified.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs3
Version 3 of the command to retrieve random decoy outputs for specified amounts, focusing on either pre-zarcanum or post-zarcanum zones based on the amount value.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getrandom_outs3",
"params": {
"amounts": [{
"amount": 0,
"global_offsets": [1,3,5928,2811]
}],
"coinbase_percents": 15,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
}
Parameters:
amounts-- List of amount distributions specifying where to look for decoys, based on old bare outputs or ZC outputs.amount-- If set to 0, only ZC outputs are considered. If nonzero, only old bare outputs are considered.global_offsets-- List of global indices for picking decoys. Each index corresponds to a potential decoy output.coinbase_percents-- Specifies the estimated percentage of coinbase outputs to be included in the decoy sets, ranging from 0 to 100.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs3.bin
Version 3 of the command to retrieve random decoy outputs for specified amounts, focusing on either pre-zarcanum or post-zarcanum zones based on the amount value.
URL: http:://127.0.0.1:36941/getrandom_outs3.bin
Request:
{
"amounts": [{
"amount": 0,
"global_offsets": [1,3,5928,2811]
}],
"coinbase_percents": 15,
"height_upper_limit": 2555000,
"use_forced_mix_outs": false
}
Parameters:
amounts-- List of amount distributions specifying where to look for decoys, based on old bare outputs or ZC outputs.amount-- If set to 0, only ZC outputs are considered. If nonzero, only old bare outputs are considered.global_offsets-- List of global indices for picking decoys. Each index corresponds to a potential decoy output.coinbase_percents-- Specifies the estimated percentage of coinbase outputs to be included in the decoy sets, ranging from 0 to 100.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.use_forced_mix_outs-- If true, only outputs with a 'mix_attr' greater than 0 are used as decoys.
Response:
{
"outs": [{
"amount": 10000000000
}],
"status": "OK"
}
Response fields:
outs-- List of 'outs_for_amount' structures, each containing decoys for a specific amount.amount-- The amount for which decoys are returned.status-- Status of the call.
getrandom_outs4
Version 4 of the command to retrieve random decoy outputs for specified amounts, focusing on either pre-zarcanum or post-zarcanum zones based on the amount value.
URL: http:://127.0.0.1:36941/json_rpc
Request:
{
"id": 0,
"jsonrpc": "2.0",
"method": "getrandom_outs4",
"params": {
"batches": [{
"heights": [0],
"input_amount": 1000000
}],
"height_upper_limit": 2555000,
"look_up_strategy": "LOOK_UP_STRATEGY_REGULAR_TX"
}
}
Parameters:
batches-- List of request batches, each containing an amount and corresponding heights to be processed.heights-- Array of heights to be processed in the batch.input_amount-- Amount to be processed in the batch.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.look_up_strategy-- LOOK_UP_STRATEGY_REGULAR_TX or LOOK_UP_STRATEGY_POS_COINBASE
Response:
{
"id": 0,
"jsonrpc": "2.0",
"result": {
"blocks_batches": [{
}],
"status": "OK"
}
}
Response fields:
blocks_batches-- Blocks collected by nodestatus-- Status of the call.
getrandom_outs4.bin
Version 4 of the command to retrieve random decoy outputs for specified amounts, focusing on either pre-zarcanum or post-zarcanum zones based on the amount value.
URL: http:://127.0.0.1:36941/getrandom_outs4.bin
Request:
{
"batches": [{
"heights": [0],
"input_amount": 1000000
}],
"height_upper_limit": 2555000,
"look_up_strategy": "LOOK_UP_STRATEGY_REGULAR_TX"
}
Parameters:
batches-- List of request batches, each containing an amount and corresponding heights to be processed.heights-- Array of heights to be processed in the batch.input_amount-- Amount to be processed in the batch.height_upper_limit-- Maximum blockchain height from which decoys can be taken. If nonzero, decoys must be at this height or older.look_up_strategy-- LOOK_UP_STRATEGY_REGULAR_TX or LOOK_UP_STRATEGY_POS_COINBASE
Response:
{
"blocks_batches": [{
}],
"status": "OK"
}
Response fields:
blocks_batches-- Blocks collected by nodestatus-- Status of the call.
Mining
get_pos_details.bin
Retrieves basic information regarding PoS mining, including current PoS conditions and constraints.
URL: http:://127.0.0.1:36941/get_pos_details.bin
Request:
{
}
Response:
{
"last_block_hash": "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
"pos_basic_difficulty": "",
"pos_mining_allowed": false,
"pos_sequence_factor_is_good": false,
"sm": "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
"starter_timestamp": 0,
"status": "OK"
}
Response fields:
pos_basic_difficulty-- Current PoS difficulty.pos_mining_allowed-- Indicates whether PoS mining is currently allowed, which may be restricted under certain blockchain conditions or in testnets.pos_sequence_factor_is_good-- Indicates whether the PoS sequence factor is at a level that allows for continued PoS mining, requiring a PoW block to reset if too high.starter_timestamp-- Timestamp from which timestamps are evaluated for meeting PoS win condition.status-- Status of the call.
get_o_indexes.bin
Obtain global outputs' indexes for the given txs.
URL: http:://127.0.0.1:36941/get_o_indexes.bin
Request:
{
}
Response:
{
"status": "OK"
}
Response fields:
status-- Status of the call.
Maintenance
force_relay
URL: http:://127.0.0.1:36941/force_relay
Request:
{
"txs_as_hex": ["000535b8b2e.....3685a86","00087368b2e.....349b77f"]
}
Parameters:
txs_as_hex-- List of transactions as a hexadecimal strings.
Response:
{
"status": "OK"
}
Response fields:
status-- Status of the call.
set_maintainers_info.bin
URL: http:://127.0.0.1:36941/set_maintainers_info.bin
Request:
{
"maintainers_info_buff": "",
"sign": "\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000"
}
Response:
{
"status": "OK"
}
Response fields:
status-- Status of the call.