Daemon RPC Documentation

This is a list of the xolentumd daemon RPC calls, their inputs and outputs, and examples of each.

Many RPC calls use the daemon's JSON RPC endpoints while others use their own endpoints, as shown below.

Note: atomic-units refer to the smallest fraction of 1 XOL according to the xolentumd implementation. 1 XOL = 1e12 atomic-units.


JSON RPC Calls

The majority of xolentumd RPC calls use the daemon's json_rpc interface to request various bits of information. These methods all follow a similar structure, for example:

IP=127.0.0.1
                                PORT=13580
                                METHOD='get_block_header_by_height'
                                ALIAS='getblockheaderbyheight'
                                PARAMS='{"height":912345}'
                                curl \
                                    http://$IP:$PORT/json_rpc \
                                    -d '{"jsonrpc":"2.0","id":"0","method":"'$METHOD'","params":'$PARAMS'}' \
                                    -H 'Content-Type: application/json'
                            

Some methods include parameters, while others do not. Examples of each JSON RPC method follow.

get_block_count

Look up how many blocks are in the longest chain known to the node.

Alias: getblockcount.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_count"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "count": 993163,
                                    "status": "OK"
                                  }
                                }
                                

on_get_block_hash

Look up a block's hash by its height.

Alias: on_getblockhash.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"on_get_block_hash","params":[912345]}' -H 'Content-Type: application/json'

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

get_block_template

Get a block template on which mining a new block.

Alias: getblocktemplate.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_template","params":{"wallet_address":"44GBHzv6ZyQdJkjqZje6KLZ3xSyN1hBSFAnLP6EAqJtCRVzMzZmeXTC2AHKDS9aEDTRKmo6a6o9r9j86pYfhCWDkKjbtcns","reserve_size":60}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "blockhashing_blob": "070786a498d705f8dc58791266179087907a2ff4cd883615216749b97d2f12173171c725a6f84a00000000fc751ea4a94c2f840751eaa36138eee66dda15ef554e7d6594395827994e31da10",
                                    "blocktemplate_blob": "070786a498d705f8dc58791266179087907a2ff4cd883615216749b97d2f12173171c725a6f84a0000000002aeab5f01fff2aa5f01e0a9d0f2f08a01028fdb3d5b5a2c363d36ea17a4add99a23a3ec7935b4c3e1e0364fcc4295c7a2ef5f01f912b15f5d17c1539d4722f79d8856d8654c5af87f54cfb3a4ff7f6b512b2a08023c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f1755090c809421d69873c161e7969b8bf33cee3b451dd4859bfc244a705f0b4900498f804b6023e13fa023a0fb759e8b7c9a39506a21442bc47077beeedc6b78d34c4ebdae91bd96097ccc9a882bc5056568b0d2f1f06559368fea4acba8e745444e883e53156d5083c1fd260edf05292934c8b40c098b81fe4e261720bdd272b209e317247a1d2c55dc4718891af0d16273c5a610f36f382a3bf50f54808aaa6a508e51d4601dd0d8fbf8b3b1685066ce121666a1409e8ac7a4d673c1cc36d10b825f764af647441f53230518e4d2efbcf8791c6060912c76e90db4982a66d51bbd96290bbb34db8080b216c2940cec407260bf5e2c3a5ee280835f15298f0801e9d98c4d414792282fbc2c28c3e20bc0fcb1829b5c3ad8f8d20847be8fdb2a949fd96f0205fbd6d271c880c5d8c83e9813606cd803a44d377fdeae45bfa67112132af601e9b3b0613ba7dff2ec3d4b935c447b47bfe39f7b950981b2f4c66c0d853e2218f1f69229a9b608c3d98be09b6d4d640a9f6ff0e920dbacf7e58b59554c0b398b1ae4b1d497104b4e4e745d850eed7eddb8aa93437427bf442ae5beb22cbf10a8fa738ea38cfa5d86dfd30675d4be11a38016e36936fd5601e52643e8b8bc433702ea7ae6149309c95b898cc854850e73fe0b95c5b8879b7325ecd4",
                                    "difficulty": 61043624293,
                                    "expected_reward": 4771949057248,
                                    "height": 1561970,
                                    "prev_hash": "f8dc58791266179087907a2ff4cd883615216749b97d2f12173171c725a6f84a",
                                    "reserved_offset": 129,
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

submit_block

Submit a mined block to the network.

Alias: submitblock.

Inputs:

Outputs:

In this example, a block blob which has not been mined is submitted:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"submit_block","params":["0707e6bdfedc053771512f1bc27c62731ae9e8f2443db64ce742f4e57f5cf8d393de28551e441a0000000002fb830a01ffbf830a018cfe88bee283060274c0aae2ef5730e680308d9c00b6da59187ad0352efe3c71d36eeeb28782f29f2501bd56b952c3ddc3e350c2631d3a5086cac172c56893831228b17de296ff4669de020200000000"]' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "error": {
                                    "code": -7,
                                    "message": "Block not accepted"
                                  }
                                }
                                

get_last_block_header

Block header information for the most recent block is easily retrieved with this method. No inputs are needed.

Alias: getlastblockheader.

Inputs: None.

Outputs:

In this example, the most recent block (1562023 at the time) is returned:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_last_block_header"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "block_header": {
                                      "block_size": 62774,
                                      "depth": 0,
                                      "difficulty": 60097900840,
                                      "hash": "3a289b8fa88b10e2163826c230b45d79f2be37d14fa3153ee58ff8a427782d14",
                                      "height": 1562023,
                                      "major_version": 7,
                                      "minor_version": 7,
                                      "nonce": 3789681204,
                                      "num_txes": 5,
                                      "orphan_status": false,
                                      "prev_hash": "743e5d0a26849efe27b96086f2c4ecc39a0bc744bf21473dad6710221aff6ac3",
                                      "reward": 4724029079703,
                                      "timestamp": 1525029411
                                    },
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_block_header_by_hash

Block header information can be retrieved using either a block's hash or height. This method includes a block's hash as an input parameter to retrieve basic information about the block.

Alias: getblockheaderbyhash.

Inputs:

Outputs:

In this example, block 912345 is looked up by its hash:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_header_by_hash","params":{"hash":"e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6"}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "block_header": {
                                      "block_size": 210,
                                      "depth": 649717,
                                      "difficulty": 815625611,
                                      "hash": "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6",
                                      "height": 912345,
                                      "major_version": 1,
                                      "minor_version": 2,
                                      "nonce": 1646,
                                      "num_txes": 0,
                                      "orphan_status": false,
                                      "prev_hash": "b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78",
                                      "reward": 7388968946286,
                                      "timestamp": 1452793716
                                    },
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_block_header_by_height

Similar to get_block_header_by_hash above, this method includes a block's height as an input parameter to retrieve basic information about the block.

Alias: getblockheaderbyheight.

Inputs:

Outputs:

In this example, block 912345 is looked up by its height (notice that the returned information is the same as in the previous example):

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_header_by_height","params":{"height":912345}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "block_header": {
                                      "block_size": 210,
                                      "depth": 649721,
                                      "difficulty": 815625611,
                                      "hash": "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6",
                                      "height": 912345,
                                      "major_version": 1,
                                      "minor_version": 2,
                                      "nonce": 1646,
                                      "num_txes": 0,
                                      "orphan_status": false,
                                      "prev_hash": "b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78",
                                      "reward": 7388968946286,
                                      "timestamp": 1452793716
                                    },
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_block_headers_range

Similar to get_block_header_by_height above, but for a range of blocks. This method includes a starting block height and an ending block height as parameters to retrieve basic information about the range of blocks.

Alias: getblockheadersrange.

Inputs:

Outputs:

In this example, blocks range from height 1545999 to 1546000 is looked up (notice that the returned informations are ascending order and that it is at the April 2018 network upgrade time):

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block_headers_range","params":{"start_height":1545999,"end_height":1546000}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "headers": [{
                                      "block_size": 301413,
                                      "depth": 16085,
                                      "difficulty": 134636057921,
                                      "hash": "86d1d20a40cefcf3dd410ff6967e0491613b77bf73ea8f1bf2e335cf9cf7d57a",
                                      "height": 1545999,
                                      "major_version": 6,
                                      "minor_version": 6,
                                      "nonce": 3246403956,
                                      "num_txes": 20,
                                      "orphan_status": false,
                                      "prev_hash": "0ef6e948f77b8f8806621003f5de24b1bcbea150bc0e376835aea099674a5db5",
                                      "reward": 5025593029981,
                                      "timestamp": 1523002893
                                    },{
                                      "block_size": 13322,
                                      "depth": 16084,
                                      "difficulty": 134716086238,
                                      "hash": "b408bf4cfcd7de13e7e370c84b8314c85b24f0ba4093ca1d6eeb30b35e34e91a",
                                      "height": 1546000,
                                      "major_version": 7,
                                      "minor_version": 7,
                                      "nonce": 3737164176,
                                      "num_txes": 1,
                                      "orphan_status": false,
                                      "prev_hash": "86d1d20a40cefcf3dd410ff6967e0491613b77bf73ea8f1bf2e335cf9cf7d57a",
                                      "reward": 4851952181070,
                                      "timestamp": 1523002931
                                    }],
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_block

Full block information can be retrieved by either block height or hash, like with the above block header calls. For full block information, both lookups use the same method, but with different input parameters.

Alias: getblock.

Inputs (pick one of the following):

Outputs:

Look up by height:

In the following example, block 912345 is looked up by its height. Note that block 912345 does not have any non-coinbase transactions. (See the next example for a block with extra transactions):

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block","params":{"height":912345}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "blob": "0102f4bedfb405b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff786e0600000195d83701ffd9d73704ee84ddb42102378b043c1724c92c69d923d266fe86477d3a5ddd21145062e148c64c5767700880c0fc82aa020273733cbd6e6218bda671596462a4b062f95cfe5e1dbb5b990dacb30e827d02f280f092cbdd080247a5dab669770da69a860acde21616a119818e1a489bb3c4b1b6b3c50547bc0c80e08d84ddcb01021f7e4762b8b755e3e3c72b8610cc87b9bc25d1f0a87c0c816ebb952e4f8aff3d2b01fd0a778957f4f3103a838afda488c3cdadf2697b3d34ad71234282b2fad9100e02080000000bdfc2c16c00",
                                    "block_header": {
                                      "block_size": 210,
                                      "depth": 649772,
                                      "difficulty": 815625611,
                                      "hash": "e22cf75f39ae720e8b71b3d120a5ac03f0db50bba6379e2850975b4859190bc6",
                                      "height": 912345,
                                      "major_version": 1,
                                      "minor_version": 2,
                                      "nonce": 1646,
                                      "num_txes": 0,
                                      "orphan_status": false,
                                      "prev_hash": "b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78",
                                      "reward": 7388968946286,
                                      "timestamp": 1452793716
                                    },
                                    "json": "{\n  \"major_version\": 1, \n  \"minor_version\": 2, \n  \"timestamp\": 1452793716, \n  \"prev_id\": \"b61c58b2e0be53fad5ef9d9731a55e8a81d972b8d90ed07c04fd37ca6403ff78\", \n  \"nonce\": 1646, \n  \"miner_tx\": {\n    \"version\": 1, \n    \"unlock_time\": 912405, \n    \"vin\": [ {\n        \"gen\": {\n          \"height\": 912345\n        }\n      }\n    ], \n    \"vout\": [ {\n        \"amount\": 8968946286, \n        \"target\": {\n          \"key\": \"378b043c1724c92c69d923d266fe86477d3a5ddd21145062e148c64c57677008\"\n        }\n      }, {\n        \"amount\": 80000000000, \n        \"target\": {\n          \"key\": \"73733cbd6e6218bda671596462a4b062f95cfe5e1dbb5b990dacb30e827d02f2\"\n        }\n      }, {\n        \"amount\": 300000000000, \n        \"target\": {\n          \"key\": \"47a5dab669770da69a860acde21616a119818e1a489bb3c4b1b6b3c50547bc0c\"\n        }\n      }, {\n        \"amount\": 7000000000000, \n        \"target\": {\n          \"key\": \"1f7e4762b8b755e3e3c72b8610cc87b9bc25d1f0a87c0c816ebb952e4f8aff3d\"\n        }\n      }\n    ], \n    \"extra\": [ 1, 253, 10, 119, 137, 87, 244, 243, 16, 58, 131, 138, 253, 164, 136, 195, 205, 173, 242, 105, 123, 61, 52, 173, 113, 35, 66, 130, 178, 250, 217, 16, 14, 2, 8, 0, 0, 0, 11, 223, 194, 193, 108\n    ], \n    \"signatures\": [ ]\n  }, \n  \"tx_hashes\": [ ]\n}",
                                    "miner_tx_hash": "c7da3965f25c19b8eb7dd8db48dcd4e7c885e2491db77e289f0609bf8e08ec30",
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

Look up by hash:

In the following example, block 993056 is looked up by its hash. Note that block 993056 has 3 non-coinbase transactions:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_block","params":{"hash":"510ee3c4e14330a7b96e883c323a60ebd1b5556ac1262d0bc03c24a3b785516f"}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "blob": "0102a3978cb7050ea4af6547c05c965afc8df6d31509ff3105dc7ae6b10172521d77e09711fd6df407000001dcce3c01ffa0ce3c049da8bece070259e9d685b3484886bc7b47c133e6099ecdf212d5eaa16ce19cd58e8c3c1e590a80d88ee16f024c5e2f542d25513c46b9e3b7d40140a22d0ae5314bfcae492ad9f56fff8185f080d0b8e1981a0213dd8ffdac9e6a2f71e327dad65328198dc879a492d145eae72677c0703a351580c0f9decfae010262bda00341681dccbc066757862da593734395745bdfe1fdc89b5948c86a5d4c2b01b691851cf057b9c302a3dbca879e1cba4cc45061ca55aaa6e03cdc67ab9e455002080000000c617fdf160379c6b9f00db027bde151705aafe85c495883aae2597d5cb8e1adb2e0f3ae1d07d715db73331abc3ec588ef07c7bb195786a4724b08dff431b51ffa32a4ce899bb197066426c0ed89f0b431fe171f7fd62bc95dd29943daa7cf3585cf1fdfc99d",
                                    "block_header": {
                                      "block_size": 3981,
                                      "depth": 569068,
                                      "difficulty": 964985344,
                                      "hash": "510ee3c4e14330a7b96e883c323a60ebd1b5556ac1262d0bc03c24a3b785516f",
                                      "height": 993056,
                                      "major_version": 1,
                                      "minor_version": 2,
                                      "nonce": 2036,
                                      "num_txes": 3,
                                      "orphan_status": false,
                                      "prev_hash": "0ea4af6547c05c965afc8df6d31509ff3105dc7ae6b10172521d77e09711fd6d",
                                      "reward": 6932043647005,
                                      "timestamp": 1457720227
                                    },
                                    "json": "{\n  \"major_version\": 1, \n  \"minor_version\": 2, \n  \"timestamp\": 1457720227, \n  \"prev_id\": \"0ea4af6547c05c965afc8df6d31509ff3105dc7ae6b10172521d77e09711fd6d\", \n  \"nonce\": 2036, \n  \"miner_tx\": {\n    \"version\": 1, \n    \"unlock_time\": 993116, \n    \"vin\": [ {\n        \"gen\": {\n          \"height\": 993056\n        }\n      }\n    ], \n    \"vout\": [ {\n        \"amount\": 2043647005, \n        \"target\": {\n          \"key\": \"59e9d685b3484886bc7b47c133e6099ecdf212d5eaa16ce19cd58e8c3c1e590a\"\n        }\n      }, {\n        \"amount\": 30000000000, \n        \"target\": {\n          \"key\": \"4c5e2f542d25513c46b9e3b7d40140a22d0ae5314bfcae492ad9f56fff8185f0\"\n        }\n      }, {\n        \"amount\": 900000000000, \n        \"target\": {\n          \"key\": \"13dd8ffdac9e6a2f71e327dad65328198dc879a492d145eae72677c0703a3515\"\n        }\n      }, {\n        \"amount\": 6000000000000, \n        \"target\": {\n          \"key\": \"62bda00341681dccbc066757862da593734395745bdfe1fdc89b5948c86a5d4c\"\n        }\n      }\n    ], \n    \"extra\": [ 1, 182, 145, 133, 28, 240, 87, 185, 195, 2, 163, 219, 202, 135, 158, 28, 186, 76, 196, 80, 97, 202, 85, 170, 166, 224, 60, 220, 103, 171, 158, 69, 80, 2, 8, 0, 0, 0, 12, 97, 127, 223, 22\n    ], \n    \"signatures\": [ ]\n  }, \n  \"tx_hashes\": [ \"79c6b9f00db027bde151705aafe85c495883aae2597d5cb8e1adb2e0f3ae1d07\", \"d715db73331abc3ec588ef07c7bb195786a4724b08dff431b51ffa32a4ce899b\", \"b197066426c0ed89f0b431fe171f7fd62bc95dd29943daa7cf3585cf1fdfc99d\"\n  ]\n}",
                                    "miner_tx_hash": "372395aeac5e5ad2c40b4c546b0bad00c4242fb2bd88e2e25f4e43231876f81e",
                                    "status": "OK",
                                    "tx_hashes": ["79c6b9f00db027bde151705aafe85c495883aae2597d5cb8e1adb2e0f3ae1d07","d715db73331abc3ec588ef07c7bb195786a4724b08dff431b51ffa32a4ce899b","b197066426c0ed89f0b431fe171f7fd62bc95dd29943daa7cf3585cf1fdfc99d"],
                                    "untrusted": false
                                  }
                                }
                                

get_connections

Retrieve information about incoming and outgoing connections to your node.

Alias: None.

Inputs: None.

Outputs:

Following is an example of get_connections and it's return:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_connections"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "connections": [{
                                      "address": "173.90.69.136:62950",
                                      "avg_download": 0,
                                      "avg_upload": 2,
                                      "connection_id": "083c301a3030329a487adb12ad981d2c",
                                      "current_download": 0,
                                      "current_upload": 2,
                                      "height": 1562127,
                                      "host": "173.90.69.136",
                                      "incoming": true,
                                      "ip": "173.90.69.136",
                                      "live_time": 8,
                                      "local_ip": false,
                                      "localhost": false,
                                      "peer_id": "c959fbfbed9e44fb",
                                      "port": "62950",
                                      "recv_count": 259,
                                      "recv_idle_time": 8,
                                      "send_count": 24342,
                                      "send_idle_time": 8,
                                      "state": "state_normal",
                                      "support_flags": 0
                                    },{
                                    ...
                                    }],
                                    "status": "OK"
                                  }
                                }
                                

get_info

Retrieve general information about the state of your node and the network.

Alias:

See other RPC Methods /get_info (not JSON)

Inputs: None.

Outputs:

Following is an example get_info call and its return:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_info"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "alt_blocks_count": 6,
                                    "block_size_limit": 600000,
                                    "block_size_median": 129017,
                                    "bootstrap_daemon_address": "",
                                    "cumulative_difficulty": 14121125493385685,
                                    "difficulty": 60580751777,
                                    "free_space": 138758750208,
                                    "grey_peerlist_size": 4998,
                                    "height": 1562168,
                                    "height_without_bootstrap": 1562168,
                                    "incoming_connections_count": 2,
                                    "mainnet": true,
                                    "offline": false,
                                    "outgoing_connections_count": 8,
                                    "rpc_connections_count": 2,
                                    "stagenet": false,
                                    "start_time": 1524751757,
                                    "status": "OK",
                                    "target": 120,
                                    "target_height": 1562063,
                                    "testnet": false,
                                    "top_block_hash": "7a7ba647080844073fdd8e3a069e00554c773d6e6863354dba1dec45a43f5592",
                                    "tx_count": 2759894,
                                    "tx_pool_size": 755,
                                    "untrusted": false,
                                    "was_bootstrap_ever_used": false,
                                    "white_peerlist_size": 1000
                                  }
                                }
                                

hard_fork_info

Look up information regarding hard fork voting and readiness.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"hard_fork_info"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "earliest_height": 1009827,
                                    "enabled": false,
                                    "state": 2,
                                    "status": "OK",
                                    "threshold": 0,
                                    "version": 1,
                                    "votes": 7277,
                                    "voting": 2,
                                    "window": 10080
                                  }
                                }
                                

set_bans

Ban another node by IP.

Alias: None.

Inputs:

Outputs:

Examples:

banning by host

In the following example, host is banned with its IP address string-formatted as A.B.C.D:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_bans","params":{"bans":[{"host":"192.168.1.51","ban":true,"seconds":30}]}}' -H  'Content-Type: application/json'

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

banning by ip

In the following example, integer-formatted IP is banned:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"set_bans","params":{"bans":[{"ip":838969536,"ban":true,"seconds":30}]}}' -H  'Content-Type: application/json'

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

get_bans

Get list of banned IPs.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_bans"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "bans": [{
                                      "host": "102.168.1.51",
                                      "ip": 855746662,
                                      "seconds": 22
                                    },{
                                      "host": "192.168.1.50",
                                      "ip": 838969536,
                                      "seconds": 28
                                    }],
                                    "status": "OK"
                                  }
                                }
                                

flush_txpool

Flush tx ids from transaction pool

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"flush_txpool","params":{"txids":["dc16fa8eaffe1484ca9014ea050e13131d3acf23b419f33bb4cc0b32b6c49308",""]}}' -H 'Content-Type: application/json'

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

get_output_histogram

Get a histogram of output amounts. For all amounts (possibly filtered by parameters), gives the number of outputs on the chain for that amount. RingCT outputs counts as 0 amount.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_output_histogram","params":{"amounts":[20000000000]}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "histogram": [{
                                      "amount": 20000000000,
                                      "recent_instances": 0,
                                      "total_instances": 381458,
                                      "unlocked_instances": 0
                                    }],
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_coinbase_tx_sum

Get the coinbase amount and the fees amount for n last blocks starting at particular height

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_coinbase_tx_sum","params":{"height":1563078,"count":2}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "emission_amount": 9387854817320,
                                    "fee_amount": 83981380000,
                                    "status": "OK"
                                  }
                                }
                                

get_version

Give the node current version

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_version"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "status": "OK",
                                    "untrusted": false,
                                    "version": 65555
                                  }
                                }
                                

get_fee_estimate

Gives an estimation on fees per byte.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_fee_estimate"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "fee": 187610000,
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_alternate_chains

Display alternative chains seen by the node.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_alternate_chains"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "chains": [{
                                      "block_hash": "697cf03c89a9b118f7bdf11b1b3a6a028d7b3617d2d0ed91322c5709acf75625",
                                      "difficulty": 14114729638300280,
                                      "height": 1562062,
                                      "length": 2
                                    }],
                                    "status": "OK"
                                  }
                                }
                                

relay_tx

Relay a list of transaction IDs.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"relay_tx","params":{"txids":["9fd75c429cbe52da9a52f2ffc5fbd107fe7fd2099c0d8de274dc8a67e0c98613"]}}' -H 'Content-Type: application/json'

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

sync_info

Get synchronisation informations

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"sync_info"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "height": 1563543,
                                    "peers": [{
                                      "info": {
                                        "address": "70.109.53.128:60064",
                                        "avg_download": 0,
                                        "avg_upload": 5,
                                        "connection_id": "204067223b9b3415c265dd25ad29ee48",
                                        "current_download": 0,
                                        "current_upload": 1,
                                        "height": 1559975,
                                        "host": "70.109.53.128",
                                        "incoming": true,
                                        "ip": "70.109.53.128",
                                        "live_time": 38,
                                        "local_ip": false,
                                        "localhost": false,
                                        "peer_id": "96b8545dbc7a8866",
                                        "port": "60064",
                                        "recv_count": 1580,
                                        "recv_idle_time": 28,
                                        "send_count": 203603,
                                        "send_idle_time": 8,
                                        "state": "state_normal",
                                        "support_flags": 1
                                      }
                                    },{
                                      "info": {
                                        ...
                                      }
                                    },{
                                      ...
                                    },{
                                      ...
                                    },{
                                      ...
                                    }],
                                    "status": "OK",
                                    "target_height": 1564067
                                  }
                                }
                                

get_txpool_backlog

Get all transaction pool backlog

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_txpool_backlog"}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "backlog": "...Binary...",
                                    "status": "OK",
                                    "untrusted": false
                                  }
                                }
                                

get_output_distribution

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/json_rpc -d '{"jsonrpc":"2.0","id":"0","method":"get_output_distribution","params":{"amounts":[628780000],"from_height":1462078}}' -H 'Content-Type: application/json'

                                {
                                  "id": "0",
                                  "jsonrpc": "2.0",
                                  "result": {
                                    "distributions": [{
                                      "amount": 2628780000,
                                      "base": 0,
                                      "distribution": "",
                                      "start_height": 1462078
                                    }],
                                    "status": "OK"
                                  }
                                }
                                

Other RPC Calls

Not all daemon RPC calls use the JSON_RPC interface. This section gives examples of these calls.

The data structure for these calls is different than the JSON RPC calls. Whereas the JSON RPC methods were called using the /json_rpc extension and specifying a method, these methods are called at their own extensions. For example:

IP=127.0.0.1
                            PORT=13580
                            METHOD='gettransactions'
                            PARAMS='{"txs_hashes":["d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090408"]}'
                            curl \
                                http://$IP:$PORT/$METHOD \
                                -d $PARAMS \
                                -H 'Content-Type: application/json'
                            

Note: It is recommended to use JSON RPC where such alternatives exist, rather than the following methods. For example, the recommended way to get a node's height is via the JSON RPC methods get_info or get_last_block_header, rather than getheight below.

For calls that end with .bin, the data is exchanged in the form of binary, serialized objects, as defined in the Core RPC Server.

/get_height

Get the node's current height.

Alias: /getheight.

Inputs: None.

Outputs:

$ curl http://127.0.0.1:13580/get_height -H 'Content-Type: application/json'

                                {
                                  "height": 1564055,
                                  "status": "OK",
                                  "untrusted": false
                                }
                                

/get_blocks.bin

Get all blocks info. Binary request.

Alias: /getblocks.bin.

Inputs:

Outputs:

/get_blocks_by_height.bin

Get blocks by height. Binary request.

Alias: /getblocks_by_height.bin.

Inputs:

Outputs:

/get_hashes.bin

Get hashes. Binary request.

Alias: /gethashes.bin.

Inputs:

Outputs:

/get_o_indexes.bin

Get global outputs of transactions. Binary request.

Alias: None.

Inputs:

Outputs:

/get_outs.bin

Get outputs. Binary request.

Alias: None.

Inputs:

Outputs:

/get_transactions

Look up one or more transactions by hash.

Alias: /gettransactions.

Inputs:

Outputs:

Example 1: Return transaction information in binary format.

$ curl http://127.0.0.1:13580/get_transactions -d '{"txs_hashes":["d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090408"]}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK",
                                  "txs": [{
                                    "as_hex": "...",
                                    "as_json": "",
                                    "block_height": 993442,
                                    "block_timestamp": 1457749396,
                                    "double_spend_seen": false,
                                    "in_pool": false,
                                    "output_indices": [198769,418598,176616,50345,509],
                                    "tx_hash": "d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090408"
                                  }],
                                  "txs_as_hex": ["..."],
                                  "untrusted": false
                                }
                                

Example 2: Decode returned transaction information in JSON format. Note: the "vin", "vout" and "signatures" list have been truncated in the displayed return for space considerations.

$ curl http://127.0.0.1:13580/get_transactions -d '{"txs_hashes":["d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090408"],"decode_as_json":true}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK",
                                  "txs": [{
                                    "as_hex": "...",
                                    "as_json": "{\n  \"version\": 1, \n  \"unlock_time\": 0, \n  \"vin\": [ {\n      \"key\": {\n        \"amount\": 9999999999, \n        \"key_offsets\": [ 691\n        ], \n        \"k_image\": \"6ebee1b651a8da723462b4891d471b990ddc226049a0866d3029b8e2f75b7012\"\n      }\n    }, {\n      \"key\": {\n        \"amount\": 9000000000000, \n        \"key_offsets\": [ 175760\n        ], \n        \"k_image\": \"200bd02b70ee707441a8863c5279b4e4d9f376dc97a140b1e5bc7d72bc508069\"\n      }\n    }, ... \n  ], \n  \"vout\": [ {\n      \"amount\": 60000000000, \n      \"target\": {\n        \"key\": \"8c792dea94dab48160e067fb681edd6247ba375281fbcfedc03cb970f3b98e2d\"\n      }\n    }, {\n      \"amount\": 700000000000, \n      \"target\": {\n        \"key\": \"1ab33e69737e157d23e33274c42793be06a8711670e73fa10ecebc604f87cc71\"\n      }\n    }, ... \n  ], \n  \"extra\": [ 1, 3, 140, 109, 156, 205, 47, 148, 153, 9, 17, 93, 83, 33, 162, 110, 152, 1, 139, 70, 121, 19, 138, 10, 44, 6, 55, 140, 242, 124, 143, 219, 172\n  ], \n  \"signatures\": [ \"fd82214a59c99d9251fa00126d353f9cf502a80d8993a6c223e3c802a40ab405555637f495903d3ba558312881e586d452e6e95826d8e128345f6c0a8f9f350e\", \"8c04ef50cf34afa3a9ec19c457143496f8cf7045ed869b581f9efa2f1d65e30f1cec5272b00e9c61a34bdd3c78cf82ae8ef4df3132f70861391069b9c255cd08\", ... ]\n}",
                                    "block_height": 993442,
                                    "block_timestamp": 1457749396,
                                    "double_spend_seen": false,
                                    "in_pool": false,
                                    "output_indices": [198769,418598,176616,50345,509],
                                    "tx_hash": "d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090408"
                                  }],
                                  "txs_as_hex": ["..."],
                                  "txs_as_json": ["{\n  \"version\": 1, \n  \"unlock_time\": 0, \n  \"vin\": [ {\n      \"key\": {\n        \"amount\": 9999999999, \n        \"key_offsets\": [ 691\n        ], \n        \"k_image\": \"6ebee1b651a8da723462b4891d471b990ddc226049a0866d3029b8e2f75b7012\"\n      }\n    }, {\n      \"key\": {\n        \"amount\": 9000000000000, \n        \"key_offsets\": [ 175760\n        ], \n        \"k_image\": \"200bd02b70ee707441a8863c5279b4e4d9f376dc97a140b1e5bc7d72bc508069\"\n      }\n    }, ... \n  ], \n  \"vout\": [ {\n      \"amount\": 60000000000, \n      \"target\": {\n        \"key\": \"8c792dea94dab48160e067fb681edd6247ba375281fbcfedc03cb970f3b98e2d\"\n      }\n    }, {\n      \"amount\": 700000000000, \n      \"target\": {\n        \"key\": \"1ab33e69737e157d23e33274c42793be06a8711670e73fa10ecebc604f87cc71\"\n      }\n    }, ... \n  ], \n  \"extra\": [ 1, 3, 140, 109, 156, 205, 47, 148, 153, 9, 17, 93, 83, 33, 162, 110, 152, 1, 139, 70, 121, 19, 138, 10, 44, 6, 55, 140, 242, 124, 143, 219, 172\n  ], \n  \"signatures\": [ \"fd82214a59c99d9251fa00126d353f9cf502a80d8993a6c223e3c802a40ab405555637f495903d3ba558312881e586d452e6e95826d8e128345f6c0a8f9f350e\", \"8c04ef50cf34afa3a9ec19c457143496f8cf7045ed869b581f9efa2f1d65e30f1cec5272b00e9c61a34bdd3c78cf82ae8ef4df3132f70861391069b9c255cd08\", ... ]\n}"],
                                  "untrusted": false
                                }
                                

Example 3: Returned a missed (unexisting) transaction.

curl http://127.0.0.1:13580/get_transactions -d '{"txs_hashes":["d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090409"]}' -H 'Content-Type: application/json'

                                {
                                  "missed_tx": ["d6e48158472848e6687173a91ae6eebfa3e1d778e65252ee99d7515d63090409"],
                                  "status": "OK",
                                  "untrusted": false
                                }
                                

/get_alt_blocks_hashes

Get the known blocks hashes which are not on the main chain.

Alias: None.

Inputs: None

Outputs:

Example:

$ curl http://127.0.0.1:13580/get_alt_blocks_hashes -H 'Content-Type: application/json'

                                {
                                  "blks_hashes": ["9c2277c5470234be8b32382cdf8094a103aba4fcd5e875a6fc159dc2ec00e011","637c0e0f0558e284493f38a5fcca3615db59458d90d3a5eff0a18ff59b83f46f","6f3adc174a2e8082819ebb965c96a095e3e8b63929ad9be2d705ad9c086a6b1c","697cf03c89a9b118f7bdf11b1b3a6a028d7b3617d2d0ed91322c5709acf75625","d99b3cf3ac6f17157ac7526782a3c3b9537f89d07e069f9ce7821d74bd9cad0e","e97b62109a6303233dcd697fa8545c9fcbc0bf8ed2268fede57ddfc36d8c939c","70ff822066a53ad64b04885c89bbe5ce3e537cdc1f7fa0dc55317986f01d1788","b0d36b209bd0d4442b55ea2f66b5c633f522401f921f5a85ea6f113fd2988866"],
                                  "status": "OK",
                                  "untrusted": false
                                }
                                

/is_key_image_spent

Check if outputs have been spent using the key image associated with the output.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/is_key_image_spent -d '{"key_images":["8d1bd8181bf7d857bdb281e0153d84cd55a3fcaa57c3e570f4a49f935850b5e3","7319134bfc50668251f5b899c66b005805ee255c136f0e1cecbb0f3a912e09d4"]}' -H 'Content-Type: application/json'

                                {
                                  "spent_status": [1,2],
                                  "status": "OK"
                                  "untrusted": false
                                }
                                

/send_raw_transaction

Broadcast a raw transaction to the network.

Alias: /sendrawtransaction.

Inputs:

Outputs:

Example (No return information included here.):

$ curl http://127.0.0.1:13580/send_raw_transaction -d '{"tx_as_hex":"de6a3...", "do_not_relay":false}' -H 'Content-Type: application/json'
                                

/start_mining

Start mining on the daemon.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/start_mining -d '{"do_background_mining":false,"ignore_battery":true,"miner_address":"47xu3gQpF569au9C2ajo5SSMrWji6xnoE5vhr94EzFRaKAGw6hEGFXYAwVADKuRpzsjiU1PtmaVgcjUJF89ghGPhUXkndHc","threads_count":1}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/stop_mining

Stop mining on the daemon.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/stop_mining -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/mining_status

Get the mining status of the daemon.

Alias: None.

Inputs: None.

Outputs:

Example while mining:

$ curl http://127.0.0.1:13580/mining_status -H 'Content-Type: application/json'

                                {
                                  "active": true,
                                  "address": "47xu3gQpF569au9C2ajo5SSMrWji6xnoE5vhr94EzFRaKAGw6hEGFXYAwVADKuRpzsjiU1PtmaVgcjUJF89ghGPhUXkndHc",
                                  "is_background_mining_enabled": false,
                                  "speed": 20,
                                  "status": "OK",
                                  "threads_count": 1
                                }
                                

Example while not mining:

$ curl http://127.0.0.1:13580/mining_status -H 'Content-Type: application/json'

                                {
                                  "active": false,
                                  "address": "",
                                  "is_background_mining_enabled": false,
                                  "speed": 0,
                                  "status": "OK",
                                  "threads_count": 0
                                }
                                

/save_bc

Save the blockchain. The blockchain does not need saving and is always saved when modified, however it does a sync to flush the filesystem cache onto the disk for safety purposes against Operating System or Harware crashes.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/save_bc -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/get_peer_list

Get the known peers list.

Alias: None.

Inputs: None.

Outputs:

Example (truncated lists):

$ curl http://127.0.0.1:13580/get_peer_list -H 'Content-Type: application/json'

                                {
                                  "gray_list": [{
                                    "host": "640304833",
                                    "id": 5345237316225602120,
                                    "ip": 640304833,
                                    "last_seen": 1525540510,
                                    "port": 18080
                                  },{
                                    "host": "2183731038",
                                    "id": 14955030573998424430,
                                    "ip": 2183731038,
                                    "last_seen": 1525540499,
                                    "port": 28080
                                  }, ...
                                  ],
                                  "status": "OK",
                                  "white_list": [{
                                    "host": "1221637955",
                                    "id": 10354694710033118926,
                                    "ip": 1221637955,
                                    "last_seen": 1525540511,
                                    "port": 18080
                                  },{
                                    "host": "1780407354",
                                    "id": 17193661050352240890,
                                    "ip": 1780407354,
                                    "last_seen": 1525540510,
                                    "port": 18080
                                  }, ...
                                  ]
                                }
                                

/set_log_hash_rate

Set the log hash rate display mode.

Alias: None.

Inputs:

Outputs:

Example while mining:

$ curl http://127.0.0.1:13580/set_log_hash_rate -d '{"visible":true}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

Error while not mining:

$ curl http://127.0.0.1:13580/set_log_hash_rate -d '{"visible":true}' -H 'Content-Type: application/json'

                                {
                                  "status": "NOT MINING"
                                }
                                

/set_log_level

Set the daemon log level. By default, log level is set to 0.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/set_log_level -d '{"level":1}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/set_log_categories

Set the daemon log categories. Categories are represented as a comma separated list of <Category>:<level> (similarly to syslog standard <Facility>:<Severity-level>), where:

Alias: None.

Inputs:

Outputs:

Example to set all facilities to Security Level Info:

$ curl http://127.0.0.1:13580/set_log_categories -d '{"categories": "*:INFO"}' -H 'Content-Type: application/json'

                                {
                                  "categories": "*:INFO",
                                  "status": "OK"
                                }
                                

Example without input to set the default categories:

$ curl http://127.0.0.1:13580/set_log_categories -H 'Content-Type: application/json'

                                {
                                  "categories": "*:WARNING,net:FATAL,net.p2p:FATAL,net.cn:FATAL,global:INFO,verify:FATAL,stacktrace:INFO,logging:INFO,msgwriter:INFO",
                                  "status": "OK"
                                }
                                

/get_transaction_pool

Show information about valid transactions seen by the node but not yet mined into a block, as well as spent key image information for the txpool in the node's memory.

Alias: None.

Inputs: None.

Outputs:

Example (Note: Some lists in the returned information have been truncated for display reasons):

$ curl http://127.0.0.1:13580/get_transaction_pool -H 'Content-Type: application/json'

                                {
                                  "spent_key_images": [{
                                    "id_hash": "a2af919609db4ff5ab8d4ba18502e647d521760e1cbc30288f06fa87bf9a0c1c",
                                    "txs_hashes": ["1ee6a4873b638711795fc3b0b73fc7146505a09a7f4749534fd408d571a273cf"]
                                  },{
                                    "id_hash": "02d5f6559e9bca5ae5a335130aeeb05df2db518ab9837fa64ebbab276c100792",
                                    "txs_hashes": ["531aacc0ceb8514cdde5f104285202ccc3e969c77584e3c6fa614c987c583965"]
                                  },
                                  ...],
                                  "status": "OK",
                                  "transactions": [{
                                    "blob_size": 13193,
                                    "do_not_relay": false,
                                    "double_spend_seen": false,
                                    "fee": 9694360000,
                                    "id_hash": "f8fb875cfc9e2e59bcf96a42474c79e01d50b69e6548d445d45984f7db66e50f",
                                    "kept_by_block": false,
                                    "last_failed_height": 0,
                                    "last_failed_id_hash": "0000000000000000000000000000000000000000000000000000000000000000",
                                    "last_relayed_time": 1525615049,
                                    "max_used_block_height": 1564924,
                                    "max_used_block_id_hash": "4bae7856979f46c7de31f3fb58cac36d4dfd2765bf33f876edf33d0e05ebb4a7",
                                    "receive_time": 1525615049,
                                    "relayed": true,
                                    "tx_blob": " ... ",
                                    "tx_json": "{\n  \"version\": 2, \n  \"unlock_time\": 0, \n  \"vin\": [ {\n      \"key\": {\n        \"amount\": 0, \n        \"key_offsets\": [ 2630347, 594429, 1047509, 758973, 464501, 61971, 22268\n        ], \n        \"k_image\": \"0731363c58dd4492f031fa20c82fe6ddcb9cc070d73938afe8a5f7f77897f8b4\"\n      }\n    }\n  ], \n  \"vout\": [ {\n      \"amount\": 0, \n      \"target\": {\n        \"key\": \"f3b3dd09483616e343b9866eed50a0ce01d5c0d0f2612ce2c4d0e9cce5c218cd\"\n      }\n    }, {\n      \"amount\": 0, \n      \"target\": {\n        \"key\": \"9796f2d477a696b6282bf3cb1a41cefba0c4604eedcc2e7a44904d7033643e0e\"\n      }\n    }\n  ], \n  \"extra\": [ 1, 25, 228, 80, 5, 214, 117, 150, 9, 125, 98, 17, 113, 208, 89, 223, 242, 227, 188, 197, 141, 190, 135, 140, 152, 117, 240, 150, 21, 93, 62, 108, 124\n  ], \n  \"rct_signatures\": {\n    \"type\": 1, \n    \"txnFee\": 9694360000, \n    \"ecdhInfo\": [ {\n        \"mask\": \"645f06a2816aecf83d5041c3320eb31092b994fb2733bb74c8c47e288d452c04\", \n        \"amount\": \"3908f14d39dcb3831331cb255eeadc5b0aea0143645b9cd3034abf613995740d\"\n      }, {\n        \"mask\": \"0785b5df0a994b14d59da810503a022721d8f629720f526e15bd848ad3c2c509\", \n        \"amount\": \"fbd81cf2368dcd742905ded5287457030467aaf5bc9939e13f1d6bf8d4c8ca09\"\n      }], \n    \"outPk\": [ \"c19f5fa052859126e0eed0e3c860aadab049677b2b3dd14cc74d02f92f1d013f\", \"1581ef6368de1608ea366566b88272db220479cf215f6d88d7b60ec221d11e0a\"]\n  }, \n  \"rctsig_prunable\": {\n    \"rangeSigs\": [ {\n        \"asig\": \" ... \", \n        \"Ci\": \" .. \"\n      }, {\n        \"asig\": \" ... \", \n        \"Ci\": \" ... \"\n      }], \n    \"MGs\": [ {\n        \"ss\": [ [ \"218a10a29e0f66e5a324af67b7734708a8a4cc8f16b28acd8cda538aaa495a02\", \"b368b4e956df5808c5c257f0dc3f7eff8c28463d0bb20759d19977fa02d6f205\"], [ \"f741d2c96bc23b362b4155a03fb6f1351ab5bf4445a43b3e52ba776f526af305\", \"a10ad1ee80dce3f311dd3dc141803daeecaa4d2a25a390cd9c35e4161b7c9e0c\"],
                                    ...], \n        \"cc\": \"e93801b707261ca76e146fdf2085abae71ad9203a00edc843c74f4ead8a39601\"\n      }]\n  }\n}"
                                  },
                                  ...]
                                }
                                

/get_transaction_pool_hashes.bin

Get hashes from transaction pool. Binary request.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/get_transaction_pool_hashes.bin -H 'Content-Type: application/json'

                                {
                                  "status": "OK",
                                  "tx_hashes": " ... ",
                                  "untrusted": false
                                }
                                

/get_transaction_pool_stats

Get the transaction pool statistics.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/get_transaction_pool_stats -H 'Content-Type: application/json'

                                {
                                  "pool_stats": {
                                    "bytes_max": 47222,
                                    "bytes_med": 13290,
                                    "bytes_min": 13092,
                                    "bytes_total": 449511,
                                    "fee_total": 289715320000,
                                    "histo": "\t▒'▒5▒4▒\/▒▒▒$3",
                                    "histo_98pc": 0,
                                    "num_10m": 18,
                                    "num_double_spends": 1,
                                    "num_failing": 17,
                                    "num_not_relayed": 0,
                                    "oldest": 1525457001,
                                    "txs_total": 26
                                  },
                                  "status": "OK",
                                  "untrusted": false
                                }
                                

/stop_daemon

Send a command to the daemon to safely disconnect and shut down.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/stop_daemon -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/get_info (not JSON)

This method is a convenient backward support and should not be used anymore. See get_info JSON RPC for details.

Alias:

/get_limit

Get daemon bandwidth limits.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/get_limit -H 'Content-Type: application/json'

                                {
                                  "limit_down": 8192,
                                  "limit_up": 128,
                                  "status": "OK",
                                  "untrusted": false
                                }
                                

/set_limit

Set daemon bandwidth limits.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/set_limit -d '{"limit_down": 1024}' -H 'Content-Type: application/json'

                                {
                                  "limit_down": 1024,
                                  "limit_up": 128,
                                  "status": "OK"
                                }
                                

/out_peers

Limit number of Outgoing peers.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/out_peers -d '{"out_peers": 3232235535}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/in_peers

Limit number of Incoming peers.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/out_peers -d '{"in_peers": 3232235535}' -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/start_save_graph

Obsolete. Conserved here for reference.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/start_save_graph -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/stop_save_graph

Obsolete. Conserved here for reference.

Alias: None.

Inputs: None.

Outputs:

Example:

$ curl http://127.0.0.1:13580/stop_save_graph -H 'Content-Type: application/json'

                                {
                                  "status": "OK"
                                }
                                

/get_outs

Get outputs.

Alias: None.

Inputs:

Outputs:

/update

Update daemon.

Alias: None.

Inputs:

Outputs:

Example:

$ curl http://127.0.0.1:13580/update -d '{"command":"check"}' -H 'Content-Type: application/json'

                                {
                                  "auto_uri": "",
                                  "hash": "",
                                  "path": "",
                                  "status": "OK",
                                  "update": false,
                                  "user_uri": "",
                                  "version": ""
                                }