{"_id":"59180a5f2cd60a0f000d2038","parentDoc":null,"title":"What is IOTA?","createdAt":"2016-07-02T11:37:56.216Z","excerpt":"","link_external":false,"order":0,"__v":1,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"next":{"pages":[],"description":""},"updates":["586d0e19e86a4e1900db401c","594ab3293830a000248d1e61"],"category":"59180a5e2cd60a0f000d2034","githubsync":"","slug":"what-is-iota","version":"59180a5d2cd60a0f000d2033","type":"basic","user":"573f104a176bea2b000e9699","body":"[IOTA](https://iota.org) is a revolutionary new transactional settlement and data integrity layer for the Internet of Things. It’s based on a new distributed ledger architecture, the Tangle, which overcomes the inefficiencies of current Blockchain designs and introduces a new way of reaching consensus in a decentralized peer-to-peer system. For the first time ever, through IOTA people can transfer money without any fees. This means that even infinitesimally small nanopayments can be made through IOTA.\n\nIOTA is the missing puzzle piece for the Machine Economy to fully emerge and reach its desired potential. We envision IOTA to be the public, permissionless backbone for the Internet of Things that enables true interoperability between all devices. \n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"IOTA IS CURRENTLY IN BETA\",\n  \"body\": \"It should be noted that IOTA is currently still in Beta. This means that the current Java implementation is an **reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months.\"\n}\n[/block]","hidden":false,"link_url":"","project":"573f1056804f901700a9e07b","sync_unique":"","childrenPages":[]}

What is IOTA?


[IOTA](https://iota.org) is a revolutionary new transactional settlement and data integrity layer for the Internet of Things. It’s based on a new distributed ledger architecture, the Tangle, which overcomes the inefficiencies of current Blockchain designs and introduces a new way of reaching consensus in a decentralized peer-to-peer system. For the first time ever, through IOTA people can transfer money without any fees. This means that even infinitesimally small nanopayments can be made through IOTA. IOTA is the missing puzzle piece for the Machine Economy to fully emerge and reach its desired potential. We envision IOTA to be the public, permissionless backbone for the Internet of Things that enables true interoperability between all devices. [block:callout] { "type": "danger", "title": "IOTA IS CURRENTLY IN BETA", "body": "It should be noted that IOTA is currently still in Beta. This means that the current Java implementation is an **reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months." } [/block]
[IOTA](https://iota.org) is a revolutionary new transactional settlement and data integrity layer for the Internet of Things. It’s based on a new distributed ledger architecture, the Tangle, which overcomes the inefficiencies of current Blockchain designs and introduces a new way of reaching consensus in a decentralized peer-to-peer system. For the first time ever, through IOTA people can transfer money without any fees. This means that even infinitesimally small nanopayments can be made through IOTA. IOTA is the missing puzzle piece for the Machine Economy to fully emerge and reach its desired potential. We envision IOTA to be the public, permissionless backbone for the Internet of Things that enables true interoperability between all devices. [block:callout] { "type": "danger", "title": "IOTA IS CURRENTLY IN BETA", "body": "It should be noted that IOTA is currently still in Beta. This means that the current Java implementation is an **reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months." } [/block]
{"_id":"59180a5f2cd60a0f000d2039","body":"Because IOTA introduces some rather new concepts to the Blockchain-space, we will list a couple of terms which are important to understand in order to fully grasp IOTA.\n\nThis Glossary is work in progress. If you are uncertain about a term, please suggest [one here](https://iota.readme.io/discuss) so we can add it to this glossary. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Generic Terms\"\n}\n[/block]\n* **`Peer to Peer Network`**: Decentralized network consisting of peers (or nodes) which are connected with each other and perform some form of data sharing with each other. \n* **`Proof of Work`**: Algorithm which prevents Denial of Service and spam attacks on a network. Computationally hard puzzle, but easy to verify.\n* **`Trinary`**: Alternative to binary, which consists of three states: true, false and unknown. Read more [here](https://en.wikipedia.org/wiki/Balanced_ternary) \n* **`DAG`**: Directed Acyclic Graph. Is a specific data structure based on a graph without any directed cycles. Instead of having a single branch with nodes having only one edge, in a DAG there can be multiple branches. Refer to [Wikipedia](https://en.wikipedia.org/wiki/Directed_acyclic_graph) for more information.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"IOTA Terms\"\n}\n[/block]\n* **`Tangle`**: A directed acyclic graph (DAG) as a distributed ledger which stores all transaction data of the IOTA network. It is a Blockchain without the blocks and the chain (so is it really a Blockchain?). The Tangle is the first distributed ledger to achieve **scalability**, **no fee transactions**, **data integrity and transmission** as well as **quantum-computing protection**. Contrary to today’s Blockchains, consensus is no-longer decoupled but instead an intrinsic part of the system, leading to a completely decentralized and self-regulating peer-to-peer network.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/v2GmVOXhRw6tOxXMDSDg_Screen%20Shot%202016-07-03%20at%2014.14.56.png\",\n        \"Screen Shot 2016-07-03 at 14.14.56.png\",\n        \"1178\",\n        \"388\",\n        \"#323232\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n* **`Seed`**: String consisting only of uppercase latin letters and 9's which is used to access an account. A seed is like a private key/password. **Keep it secure and don't share it with anyone.** If someone has access to your seed they can access your account. The maximum security level for seed is 81-trytes (81 chars), but you can choose longer seeds, the security of it just won't increase.\n* **`Tips`**: transactions which have no other transactions referencing them.\n* **`Confirm/Validate`**: In order to broadcast a new transaction in IOTA, you must first validate two previous transactions. This confirmation happens by validating the transaction trytes, the signatures and cross-checking for conflicting transactions as well as the completion of a Proof of Work puzzle.\n* **`Branch/Trunk Transactions`**: Two transactions which were referenced and validated by another transaction.\n* **`Bundle`**: Transactions which are bundled (or grouped) together during the creation of a transfer.","createdAt":"2016-07-02T11:43:52.781Z","isReference":false,"next":{"pages":[],"description":""},"title":"Glossary","category":"59180a5e2cd60a0f000d2034","excerpt":"","order":1,"slug":"glossary","type":"basic","version":"59180a5d2cd60a0f000d2033","user":"573f104a176bea2b000e9699","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"githubsync":"","link_external":false,"link_url":"","project":"573f1056804f901700a9e07b","sync_unique":"","__v":0,"hidden":false,"parentDoc":null,"updates":[],"childrenPages":[]}

Glossary


Because IOTA introduces some rather new concepts to the Blockchain-space, we will list a couple of terms which are important to understand in order to fully grasp IOTA. This Glossary is work in progress. If you are uncertain about a term, please suggest [one here](https://iota.readme.io/discuss) so we can add it to this glossary. [block:api-header] { "type": "basic", "title": "Generic Terms" } [/block] * **`Peer to Peer Network`**: Decentralized network consisting of peers (or nodes) which are connected with each other and perform some form of data sharing with each other. * **`Proof of Work`**: Algorithm which prevents Denial of Service and spam attacks on a network. Computationally hard puzzle, but easy to verify. * **`Trinary`**: Alternative to binary, which consists of three states: true, false and unknown. Read more [here](https://en.wikipedia.org/wiki/Balanced_ternary) * **`DAG`**: Directed Acyclic Graph. Is a specific data structure based on a graph without any directed cycles. Instead of having a single branch with nodes having only one edge, in a DAG there can be multiple branches. Refer to [Wikipedia](https://en.wikipedia.org/wiki/Directed_acyclic_graph) for more information. [block:api-header] { "type": "basic", "title": "IOTA Terms" } [/block] * **`Tangle`**: A directed acyclic graph (DAG) as a distributed ledger which stores all transaction data of the IOTA network. It is a Blockchain without the blocks and the chain (so is it really a Blockchain?). The Tangle is the first distributed ledger to achieve **scalability**, **no fee transactions**, **data integrity and transmission** as well as **quantum-computing protection**. Contrary to today’s Blockchains, consensus is no-longer decoupled but instead an intrinsic part of the system, leading to a completely decentralized and self-regulating peer-to-peer network. [block:image] { "images": [ { "image": [ "https://files.readme.io/v2GmVOXhRw6tOxXMDSDg_Screen%20Shot%202016-07-03%20at%2014.14.56.png", "Screen Shot 2016-07-03 at 14.14.56.png", "1178", "388", "#323232", "" ] } ] } [/block] * **`Seed`**: String consisting only of uppercase latin letters and 9's which is used to access an account. A seed is like a private key/password. **Keep it secure and don't share it with anyone.** If someone has access to your seed they can access your account. The maximum security level for seed is 81-trytes (81 chars), but you can choose longer seeds, the security of it just won't increase. * **`Tips`**: transactions which have no other transactions referencing them. * **`Confirm/Validate`**: In order to broadcast a new transaction in IOTA, you must first validate two previous transactions. This confirmation happens by validating the transaction trytes, the signatures and cross-checking for conflicting transactions as well as the completion of a Proof of Work puzzle. * **`Branch/Trunk Transactions`**: Two transactions which were referenced and validated by another transaction. * **`Bundle`**: Transactions which are bundled (or grouped) together during the creation of a transfer.
Because IOTA introduces some rather new concepts to the Blockchain-space, we will list a couple of terms which are important to understand in order to fully grasp IOTA. This Glossary is work in progress. If you are uncertain about a term, please suggest [one here](https://iota.readme.io/discuss) so we can add it to this glossary. [block:api-header] { "type": "basic", "title": "Generic Terms" } [/block] * **`Peer to Peer Network`**: Decentralized network consisting of peers (or nodes) which are connected with each other and perform some form of data sharing with each other. * **`Proof of Work`**: Algorithm which prevents Denial of Service and spam attacks on a network. Computationally hard puzzle, but easy to verify. * **`Trinary`**: Alternative to binary, which consists of three states: true, false and unknown. Read more [here](https://en.wikipedia.org/wiki/Balanced_ternary) * **`DAG`**: Directed Acyclic Graph. Is a specific data structure based on a graph without any directed cycles. Instead of having a single branch with nodes having only one edge, in a DAG there can be multiple branches. Refer to [Wikipedia](https://en.wikipedia.org/wiki/Directed_acyclic_graph) for more information. [block:api-header] { "type": "basic", "title": "IOTA Terms" } [/block] * **`Tangle`**: A directed acyclic graph (DAG) as a distributed ledger which stores all transaction data of the IOTA network. It is a Blockchain without the blocks and the chain (so is it really a Blockchain?). The Tangle is the first distributed ledger to achieve **scalability**, **no fee transactions**, **data integrity and transmission** as well as **quantum-computing protection**. Contrary to today’s Blockchains, consensus is no-longer decoupled but instead an intrinsic part of the system, leading to a completely decentralized and self-regulating peer-to-peer network. [block:image] { "images": [ { "image": [ "https://files.readme.io/v2GmVOXhRw6tOxXMDSDg_Screen%20Shot%202016-07-03%20at%2014.14.56.png", "Screen Shot 2016-07-03 at 14.14.56.png", "1178", "388", "#323232", "" ] } ] } [/block] * **`Seed`**: String consisting only of uppercase latin letters and 9's which is used to access an account. A seed is like a private key/password. **Keep it secure and don't share it with anyone.** If someone has access to your seed they can access your account. The maximum security level for seed is 81-trytes (81 chars), but you can choose longer seeds, the security of it just won't increase. * **`Tips`**: transactions which have no other transactions referencing them. * **`Confirm/Validate`**: In order to broadcast a new transaction in IOTA, you must first validate two previous transactions. This confirmation happens by validating the transaction trytes, the signatures and cross-checking for conflicting transactions as well as the completion of a Proof of Work puzzle. * **`Branch/Trunk Transactions`**: Two transactions which were referenced and validated by another transaction. * **`Bundle`**: Transactions which are bundled (or grouped) together during the creation of a transfer.
{"_id":"59180a5f2cd60a0f000d203a","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"category":"59180a5e2cd60a0f000d2034","createdAt":"2016-07-02T11:45:41.653Z","link_url":"","title":"Frequently Asked Questions","version":"59180a5d2cd60a0f000d2033","parentDoc":null,"slug":"frequently-asked-questions","__v":0,"body":"### Is IOTA inflationary? Can I mine IOTA's?\n\nAll IOTA's which will ever exist have been created with the genesis transaction. This means that the total supply of IOTA's will always stay the same and you cannot \"mine\" IOTA's. Therefore keep in mind, if you do Proof of Work in IOTA you are not generating new IOTA tokens, you're simply verifying other transactions.\n\n### What is the total supply of IOTA?\n\nThe total supply of IOTA is `(3^33-1) / 2`, which equals to a total number of IOTA's of `2779530283277761`. IOTA is specifically designed for machines, so this high supply makes IOTA optimal for tiny nanotransactions while still keeping efficiency in mind. It also nicely fits into the `MAX_SAFE_INTEGER` value in Javascript.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"WORK IN PROGRESS!\",\n  \"body\": \"This page is currently being worked on and improved. If you have any questions, feel free to submit them via https://iota.readme.io/discuss\"\n}\n[/block]","hidden":false,"isReference":false,"order":2,"type":"basic","updates":[],"user":"573f104a176bea2b000e9699","excerpt":"","next":{"pages":[],"description":""},"sync_unique":"","githubsync":"","link_external":false,"project":"573f1056804f901700a9e07b","childrenPages":[]}

Frequently Asked Questions


### Is IOTA inflationary? Can I mine IOTA's? All IOTA's which will ever exist have been created with the genesis transaction. This means that the total supply of IOTA's will always stay the same and you cannot "mine" IOTA's. Therefore keep in mind, if you do Proof of Work in IOTA you are not generating new IOTA tokens, you're simply verifying other transactions. ### What is the total supply of IOTA? The total supply of IOTA is `(3^33-1) / 2`, which equals to a total number of IOTA's of `2779530283277761`. IOTA is specifically designed for machines, so this high supply makes IOTA optimal for tiny nanotransactions while still keeping efficiency in mind. It also nicely fits into the `MAX_SAFE_INTEGER` value in Javascript. [block:callout] { "type": "warning", "title": "WORK IN PROGRESS!", "body": "This page is currently being worked on and improved. If you have any questions, feel free to submit them via https://iota.readme.io/discuss" } [/block]
### Is IOTA inflationary? Can I mine IOTA's? All IOTA's which will ever exist have been created with the genesis transaction. This means that the total supply of IOTA's will always stay the same and you cannot "mine" IOTA's. Therefore keep in mind, if you do Proof of Work in IOTA you are not generating new IOTA tokens, you're simply verifying other transactions. ### What is the total supply of IOTA? The total supply of IOTA is `(3^33-1) / 2`, which equals to a total number of IOTA's of `2779530283277761`. IOTA is specifically designed for machines, so this high supply makes IOTA optimal for tiny nanotransactions while still keeping efficiency in mind. It also nicely fits into the `MAX_SAFE_INTEGER` value in Javascript. [block:callout] { "type": "warning", "title": "WORK IN PROGRESS!", "body": "This page is currently being worked on and improved. If you have any questions, feel free to submit them via https://iota.readme.io/discuss" } [/block]
{"_id":"59180a5f2cd60a0f000d203b","sync_unique":"","createdAt":"2016-07-09T09:09:31.260Z","order":3,"title":"Whitepaper","updates":[],"api":{"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"excerpt":"","hidden":false,"link_external":false,"project":"573f1056804f901700a9e07b","user":"573f104a176bea2b000e9699","category":"59180a5e2cd60a0f000d2034","githubsync":"","isReference":false,"link_url":"","next":{"pages":[],"description":""},"parentDoc":null,"slug":"whitepaper","type":"basic","__v":0,"body":"The IOTA Whitepaper which describes the main technology behind IOTA - the Tangle - is available to read online. It goes into greater detail about the structure as well as the security of the Tangle.\n\n#### [http://iotatoken.com/IOTA_Whitepaper.pdf](http://iotatoken.com/IOTA_Whitepaper.pdf)","version":"59180a5d2cd60a0f000d2033","childrenPages":[]}

Whitepaper


The IOTA Whitepaper which describes the main technology behind IOTA - the Tangle - is available to read online. It goes into greater detail about the structure as well as the security of the Tangle. #### [http://iotatoken.com/IOTA_Whitepaper.pdf](http://iotatoken.com/IOTA_Whitepaper.pdf)
The IOTA Whitepaper which describes the main technology behind IOTA - the Tangle - is available to read online. It goes into greater detail about the structure as well as the security of the Tangle. #### [http://iotatoken.com/IOTA_Whitepaper.pdf](http://iotatoken.com/IOTA_Whitepaper.pdf)
{"_id":"59180caa2cd60a0f000d2096","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"githubsync":"","project":"573f1056804f901700a9e07b","slug":"find-neighbors","type":"basic","user":"573f104a176bea2b000e9699","__v":1,"excerpt":"","link_url":"","order":1,"isReference":false,"parentDoc":null,"sync_unique":"","updates":["594d453af4cb8a001bbe2d03"],"version":"59180a5d2cd60a0f000d2033","body":"In order to run IRI and sync with the network, you need to have neighbors which want to pair with you. The easiest and fastest way to get neighbors is through our Slack, where you can join the `#nodesharing` channel to find neighbors.\n\nIt should be noted that you have to share your own IP and port with your neighbors as well, because IOTA relies on **mutual tethering** for the data exchange. If you need help simply ask on Slack.","category":"59180c3f1649990f0080a17e","createdAt":"2017-05-14T07:52:10.891Z","hidden":false,"link_external":false,"next":{"pages":[],"description":""},"title":"Find Neighbors","childrenPages":[]}

Find Neighbors


In order to run IRI and sync with the network, you need to have neighbors which want to pair with you. The easiest and fastest way to get neighbors is through our Slack, where you can join the `#nodesharing` channel to find neighbors. It should be noted that you have to share your own IP and port with your neighbors as well, because IOTA relies on **mutual tethering** for the data exchange. If you need help simply ask on Slack.
In order to run IRI and sync with the network, you need to have neighbors which want to pair with you. The easiest and fastest way to get neighbors is through our Slack, where you can join the `#nodesharing` channel to find neighbors. It should be noted that you have to share your own IP and port with your neighbors as well, because IOTA relies on **mutual tethering** for the data exchange. If you need help simply ask on Slack.
{"_id":"59181a61d38bc20f00e6c1fe","__v":1,"createdAt":"2017-05-14T08:50:41.174Z","excerpt":"","hidden":false,"link_external":false,"project":"573f1056804f901700a9e07b","title":"Install IRI","link_url":"","type":"basic","user":"573f104a176bea2b000e9699","sync_unique":"","body":"The official IRI Github repository can be found here: https://github.com/iotaledger/iri. In order to install IRI, there are certain requirements to be considered. It should be noted that IRI only works on 64-bit architectures.\n\n- Java 8u66 or higher  (Oracle)\n- On Windows, make sure that `Microsoft Visual C++ 2015 Redistributable Update 3` is installed\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Install IRI\"\n}\n[/block]\nThe easiest and fastest way to get IRI is by getting the already compiled version from Github. Before the official exchange launch, we will make IRI ready on several package managers, so you will be able to install and update IRI even faster.\n\nYou can find the compiled version on the release page on Github: https://github.com/iotaledger/iri/releases \n[block:api-header]\n{\n  \"title\": \"1.1. (Optional) Compile IRI yourself\"\n}\n[/block]\nCompiling IRI yourself requires you to install [maven](https://maven.apache.org/install.html).\n\n```\ngit clone https://github.com/iotaledger/iri\ncd iri\nmvn clean compile && mvn package\n```\n\nThis will then create a `target` folder, in which you will find the compiled .jar (not the original one) which you can then use.\n[block:api-header]\n{\n  \"title\": \"2. Run IRI\"\n}\n[/block]\nRunning IRI is incredibly simple.\n\n```\njava -jar iri.jar -p 14600\n```\n\nThis will start IRI at port 14600. In order to actually use IRI, you will need to find neighbors (see next section). It should be noted that IRI works with `UDP` and with `TCP`. As such, you can connect to your neighbors with either protocol. In order to get the most out of IRI, we have also made a set of flags available for you.\n\nOption | Shortened version | Description | Example Input\n--- | --- | --- | --- \n`--port` | `-p` | This is a *mandatory* option that defines the port to be used to send API commands to your node | `-p 14800`\n`--neighbors` | `-n` | Neighbors that you are connected with will be added via this option. | `-n \"udp://148.148.148.148:14265 tcp://[2001:db8:a0b:12f0::1]:14265\"`\n`--config` | `-c` | Config INI file that can be used instead of CLI options. See more below | `-c iri.ini`\n`--udp-receiver-port` | `-u` | UDP receiver port. Standard port is 14600 | `-u 14800`\n`--tcp-receiver-port` | `-t` | TCP receiver port. Standard port is 15600 | `-t 14800`\n`--testnet` | | Makes it possible to run IRI with the IOTA testnet | `--testnet`\n`--remote` | | Remotely access your node and send API commands | `--remote`\n`--remote-auth` | | Require authentication password for accessing remotely. Requires a correct `username:hashedpassword` combination | `--remote-auth iotatoken:LL9EZFNCHZCMLJLVUBCKJSWKFEXNYRHHMYS9XQLUZRDEKUUDOCMBMRBWJEMEDDXSDPHIGQULENCRVEYMO`\n`--remote-limit-api` | | Exclude certain API calls from being able to be accessed remotely | `--remote-limit-api \"attachToTangle, addNeighbors\"`\n\nOnce you have successfully started IRI, it will create a database folder (either `mainnetdb` or `testnetdb`).\n[block:api-header]\n{\n  \"title\": \"2.1. Run IRI with .ini file\"\n}\n[/block]\nYou can also provide an ini file to store all of your command line options and easily update (especially neighbors) if needed. You can enable it via the `--config` flag. Here is an example INI file:\n```\n[IRI]\nPORT = 14700\nUDP_RECEIVER_PORT = 14700\nNEIGHBORS = udp://my.favorite.com:15600\nIXI_DIR = ixi\nHEADLESS = true\nDEBUG = true\nTESTNET = true\nDB_PATH = db\n```","category":"59180c3f1649990f0080a17e","isReference":false,"next":{"pages":[],"description":""},"parentDoc":null,"slug":"install-iri","updates":["59359231988102000fddfd36"],"version":"59180a5d2cd60a0f000d2033","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"githubsync":"","order":999,"childrenPages":[]}

Install IRI


The official IRI Github repository can be found here: https://github.com/iotaledger/iri. In order to install IRI, there are certain requirements to be considered. It should be noted that IRI only works on 64-bit architectures. - Java 8u66 or higher (Oracle) - On Windows, make sure that `Microsoft Visual C++ 2015 Redistributable Update 3` is installed [block:api-header] { "type": "basic", "title": "1. Install IRI" } [/block] The easiest and fastest way to get IRI is by getting the already compiled version from Github. Before the official exchange launch, we will make IRI ready on several package managers, so you will be able to install and update IRI even faster. You can find the compiled version on the release page on Github: https://github.com/iotaledger/iri/releases [block:api-header] { "title": "1.1. (Optional) Compile IRI yourself" } [/block] Compiling IRI yourself requires you to install [maven](https://maven.apache.org/install.html). ``` git clone https://github.com/iotaledger/iri cd iri mvn clean compile && mvn package ``` This will then create a `target` folder, in which you will find the compiled .jar (not the original one) which you can then use. [block:api-header] { "title": "2. Run IRI" } [/block] Running IRI is incredibly simple. ``` java -jar iri.jar -p 14600 ``` This will start IRI at port 14600. In order to actually use IRI, you will need to find neighbors (see next section). It should be noted that IRI works with `UDP` and with `TCP`. As such, you can connect to your neighbors with either protocol. In order to get the most out of IRI, we have also made a set of flags available for you. Option | Shortened version | Description | Example Input --- | --- | --- | --- `--port` | `-p` | This is a *mandatory* option that defines the port to be used to send API commands to your node | `-p 14800` `--neighbors` | `-n` | Neighbors that you are connected with will be added via this option. | `-n "udp://148.148.148.148:14265 tcp://[2001:db8:a0b:12f0::1]:14265"` `--config` | `-c` | Config INI file that can be used instead of CLI options. See more below | `-c iri.ini` `--udp-receiver-port` | `-u` | UDP receiver port. Standard port is 14600 | `-u 14800` `--tcp-receiver-port` | `-t` | TCP receiver port. Standard port is 15600 | `-t 14800` `--testnet` | | Makes it possible to run IRI with the IOTA testnet | `--testnet` `--remote` | | Remotely access your node and send API commands | `--remote` `--remote-auth` | | Require authentication password for accessing remotely. Requires a correct `username:hashedpassword` combination | `--remote-auth iotatoken:LL9EZFNCHZCMLJLVUBCKJSWKFEXNYRHHMYS9XQLUZRDEKUUDOCMBMRBWJEMEDDXSDPHIGQULENCRVEYMO` `--remote-limit-api` | | Exclude certain API calls from being able to be accessed remotely | `--remote-limit-api "attachToTangle, addNeighbors"` Once you have successfully started IRI, it will create a database folder (either `mainnetdb` or `testnetdb`). [block:api-header] { "title": "2.1. Run IRI with .ini file" } [/block] You can also provide an ini file to store all of your command line options and easily update (especially neighbors) if needed. You can enable it via the `--config` flag. Here is an example INI file: ``` [IRI] PORT = 14700 UDP_RECEIVER_PORT = 14700 NEIGHBORS = udp://my.favorite.com:15600 IXI_DIR = ixi HEADLESS = true DEBUG = true TESTNET = true DB_PATH = db ```
The official IRI Github repository can be found here: https://github.com/iotaledger/iri. In order to install IRI, there are certain requirements to be considered. It should be noted that IRI only works on 64-bit architectures. - Java 8u66 or higher (Oracle) - On Windows, make sure that `Microsoft Visual C++ 2015 Redistributable Update 3` is installed [block:api-header] { "type": "basic", "title": "1. Install IRI" } [/block] The easiest and fastest way to get IRI is by getting the already compiled version from Github. Before the official exchange launch, we will make IRI ready on several package managers, so you will be able to install and update IRI even faster. You can find the compiled version on the release page on Github: https://github.com/iotaledger/iri/releases [block:api-header] { "title": "1.1. (Optional) Compile IRI yourself" } [/block] Compiling IRI yourself requires you to install [maven](https://maven.apache.org/install.html). ``` git clone https://github.com/iotaledger/iri cd iri mvn clean compile && mvn package ``` This will then create a `target` folder, in which you will find the compiled .jar (not the original one) which you can then use. [block:api-header] { "title": "2. Run IRI" } [/block] Running IRI is incredibly simple. ``` java -jar iri.jar -p 14600 ``` This will start IRI at port 14600. In order to actually use IRI, you will need to find neighbors (see next section). It should be noted that IRI works with `UDP` and with `TCP`. As such, you can connect to your neighbors with either protocol. In order to get the most out of IRI, we have also made a set of flags available for you. Option | Shortened version | Description | Example Input --- | --- | --- | --- `--port` | `-p` | This is a *mandatory* option that defines the port to be used to send API commands to your node | `-p 14800` `--neighbors` | `-n` | Neighbors that you are connected with will be added via this option. | `-n "udp://148.148.148.148:14265 tcp://[2001:db8:a0b:12f0::1]:14265"` `--config` | `-c` | Config INI file that can be used instead of CLI options. See more below | `-c iri.ini` `--udp-receiver-port` | `-u` | UDP receiver port. Standard port is 14600 | `-u 14800` `--tcp-receiver-port` | `-t` | TCP receiver port. Standard port is 15600 | `-t 14800` `--testnet` | | Makes it possible to run IRI with the IOTA testnet | `--testnet` `--remote` | | Remotely access your node and send API commands | `--remote` `--remote-auth` | | Require authentication password for accessing remotely. Requires a correct `username:hashedpassword` combination | `--remote-auth iotatoken:LL9EZFNCHZCMLJLVUBCKJSWKFEXNYRHHMYS9XQLUZRDEKUUDOCMBMRBWJEMEDDXSDPHIGQULENCRVEYMO` `--remote-limit-api` | | Exclude certain API calls from being able to be accessed remotely | `--remote-limit-api "attachToTangle, addNeighbors"` Once you have successfully started IRI, it will create a database folder (either `mainnetdb` or `testnetdb`). [block:api-header] { "title": "2.1. Run IRI with .ini file" } [/block] You can also provide an ini file to store all of your command line options and easily update (especially neighbors) if needed. You can enable it via the `--config` flag. Here is an example INI file: ``` [IRI] PORT = 14700 UDP_RECEIVER_PORT = 14700 NEIGHBORS = udp://my.favorite.com:15600 IXI_DIR = ixi HEADLESS = true DEBUG = true TESTNET = true DB_PATH = db ```
{"_id":"59180a5f2cd60a0f000d203c","api":{"params":[],"url":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required"},"sync_unique":"","title":"How to Install","project":"573f1056804f901700a9e07b","type":"basic","updates":[],"createdAt":"2016-07-04T18:34:00.813Z","category":"59180a5e2cd60a0f000d2035","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"body":"Currently the best way to use IOTA is through our GUI (Graphical User Interface) Client. The Client makes it easy to get set up quickly on all major operating systems. The downside is that this makes it impossible to run IOTA on smaller IoT devices right now. This will change once you will be able to compile from source (within 1 - 2 weeks).\n\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Download the Client\"\n}\n[/block]\nYou can download the latest client from https://github.com/iotaledger/wallet/releases. Download the respective version for your operating system.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"JAVA REQUIREMENT\",\n  \"body\": \"All installations require Java higher than 8u66. Make sure you have it installed, else the GUI Client can automatically install it for you.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Compiling from Source\",\n  \"body\": \"If you want to install the GUI from source, follow the instructions on the Readme on Github.\"\n}\n[/block]","version":"59180a5d2cd60a0f000d2033","link_url":"","next":{"pages":[],"description":""},"order":0,"slug":"general","user":"573f104a176bea2b000e9699","__v":0,"childrenPages":[]}

How to Install


Currently the best way to use IOTA is through our GUI (Graphical User Interface) Client. The Client makes it easy to get set up quickly on all major operating systems. The downside is that this makes it impossible to run IOTA on smaller IoT devices right now. This will change once you will be able to compile from source (within 1 - 2 weeks). [block:api-header] { "type": "basic", "title": "Download the Client" } [/block] You can download the latest client from https://github.com/iotaledger/wallet/releases. Download the respective version for your operating system. [block:callout] { "type": "warning", "title": "JAVA REQUIREMENT", "body": "All installations require Java higher than 8u66. Make sure you have it installed, else the GUI Client can automatically install it for you." } [/block] [block:callout] { "type": "info", "title": "Compiling from Source", "body": "If you want to install the GUI from source, follow the instructions on the Readme on Github." } [/block]
Currently the best way to use IOTA is through our GUI (Graphical User Interface) Client. The Client makes it easy to get set up quickly on all major operating systems. The downside is that this makes it impossible to run IOTA on smaller IoT devices right now. This will change once you will be able to compile from source (within 1 - 2 weeks). [block:api-header] { "type": "basic", "title": "Download the Client" } [/block] You can download the latest client from https://github.com/iotaledger/wallet/releases. Download the respective version for your operating system. [block:callout] { "type": "warning", "title": "JAVA REQUIREMENT", "body": "All installations require Java higher than 8u66. Make sure you have it installed, else the GUI Client can automatically install it for you." } [/block] [block:callout] { "type": "info", "title": "Compiling from Source", "body": "If you want to install the GUI from source, follow the instructions on the Readme on Github." } [/block]
{"_id":"59180a5f2cd60a0f000d203d","slug":"windows","version":"59180a5d2cd60a0f000d2033","category":"59180a5e2cd60a0f000d2035","excerpt":"","hidden":false,"link_url":"","project":"573f1056804f901700a9e07b","user":"573f104a176bea2b000e9699","createdAt":"2016-07-04T18:33:34.917Z","githubsync":"","next":{"pages":[],"description":""},"parentDoc":null,"sync_unique":"","body":"After you have downloaded the .exe file from our [Github repo](https://github.com/iotaledger/wallet/releases) go to the Download folder and double click on the executable. After that you should see an installation screen, wait until it's finished.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/LVPdGaZ6RtiVSrHNElzg_2016-07-07%2000.52.16.png\",\n        \"2016-07-07 00.52.16.png\",\n        \"516\",\n        \"309\",\n        \"#3ab0dc\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce the installation is completed, the app will automatically open as well as create Desktop shortcut. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7Vd00mwgQ6qEbMNj2HpM_2016-07-07%2000.52.50.png\",\n        \"2016-07-07 00.52.50.png\",\n        \"559\",\n        \"611\",\n        \"#26958a\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","isReference":false,"order":1,"type":"basic","updates":["57a4efc77523720e00b4aa7f","59441c70e9e79c000f5d4626"],"__v":1,"api":{"params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required"},"link_external":false,"title":"Install on Windows","childrenPages":[]}

Install on Windows


After you have downloaded the .exe file from our [Github repo](https://github.com/iotaledger/wallet/releases) go to the Download folder and double click on the executable. After that you should see an installation screen, wait until it's finished. [block:image] { "images": [ { "image": [ "https://files.readme.io/LVPdGaZ6RtiVSrHNElzg_2016-07-07%2000.52.16.png", "2016-07-07 00.52.16.png", "516", "309", "#3ab0dc", "" ] } ] } [/block] Once the installation is completed, the app will automatically open as well as create Desktop shortcut. [block:image] { "images": [ { "image": [ "https://files.readme.io/7Vd00mwgQ6qEbMNj2HpM_2016-07-07%2000.52.50.png", "2016-07-07 00.52.50.png", "559", "611", "#26958a", "" ] } ] } [/block]
After you have downloaded the .exe file from our [Github repo](https://github.com/iotaledger/wallet/releases) go to the Download folder and double click on the executable. After that you should see an installation screen, wait until it's finished. [block:image] { "images": [ { "image": [ "https://files.readme.io/LVPdGaZ6RtiVSrHNElzg_2016-07-07%2000.52.16.png", "2016-07-07 00.52.16.png", "516", "309", "#3ab0dc", "" ] } ] } [/block] Once the installation is completed, the app will automatically open as well as create Desktop shortcut. [block:image] { "images": [ { "image": [ "https://files.readme.io/7Vd00mwgQ6qEbMNj2HpM_2016-07-07%2000.52.50.png", "2016-07-07 00.52.50.png", "559", "611", "#26958a", "" ] } ] } [/block]
{"_id":"59180a5f2cd60a0f000d203e","next":{"pages":[],"description":""},"title":"Install on Mac OS X","version":"59180a5d2cd60a0f000d2033","slug":"mac-os-x","sync_unique":"","updates":["594095797fc65d001b7e7253"],"user":"573f104a176bea2b000e9699","excerpt":"","hidden":false,"order":2,"type":"basic","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"category":"59180a5e2cd60a0f000d2035","githubsync":"","project":"573f1056804f901700a9e07b","link_external":false,"link_url":"","parentDoc":null,"__v":1,"body":"After you have downloaded the `.dmg` file from our [Github repo](https://github.com/iotaledger/wallet/releases), head to the Download folder and click on the .dmg file. You should see a folder like below. Drag the IOTA Wallet icon into the Applications folder. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1fhN84MOTTWzTspwdLkj_8vihIdnNj.png\",\n        \"8vihIdnNj.png\",\n        \"592\",\n        \"555\",\n        \"#d06056\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce you've dragged the IOTA Wallet into your applications folder, head to your Applications folder and right click on the IOTA Wallet and click on \"Open\". \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ssv9oY74RwWI7Hm8aRYw_Screen%20Shot%202016-07-06%20at%2023.42.25.png\",\n        \"Screen Shot 2016-07-06 at 23.42.25.png\",\n        \"1540\",\n        \"880\",\n        \"#3c618d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nAfter that you'll see a security alert. Click on \"Open\". \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Mac OSX Security Settings\",\n  \"body\": \"Make sure that your Mac OSX security settings are set to \\\"Allow apps downloaded from: **Mac App Store and identified developers**. If you want to change to head to System Preferences -> Security & Privacy. Then you can change it.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/sPp1aNDTQ2w0yIDV0rkp_Screen%20Shot%202016-07-06%20at%2023.38.03.png\",\n        \"Screen Shot 2016-07-06 at 23.38.03.png\",\n        \"850\",\n        \"468\",\n        \"#904c0c\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nAfter that you should see your IOTA application successfully running. Congratz! You're successfully connected to the network now and are running your node.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Java Update\",\n  \"body\": \"If you are using an older version of Java, the GUI prompts you to update to Java 8. You can automatically upgrade your Java version through the GUI.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/T6ReRyRIufBVm3QLTQzH_8vhYM9gx9.png\",\n        \"8vhYM9gx9.png\",\n        \"595\",\n        \"837\",\n        \"#37b2a5\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","createdAt":"2016-07-04T18:33:41.577Z","isReference":false,"childrenPages":[]}

Install on Mac OS X


After you have downloaded the `.dmg` file from our [Github repo](https://github.com/iotaledger/wallet/releases), head to the Download folder and click on the .dmg file. You should see a folder like below. Drag the IOTA Wallet icon into the Applications folder. [block:image] { "images": [ { "image": [ "https://files.readme.io/1fhN84MOTTWzTspwdLkj_8vihIdnNj.png", "8vihIdnNj.png", "592", "555", "#d06056", "" ] } ] } [/block] Once you've dragged the IOTA Wallet into your applications folder, head to your Applications folder and right click on the IOTA Wallet and click on "Open". [block:image] { "images": [ { "image": [ "https://files.readme.io/ssv9oY74RwWI7Hm8aRYw_Screen%20Shot%202016-07-06%20at%2023.42.25.png", "Screen Shot 2016-07-06 at 23.42.25.png", "1540", "880", "#3c618d", "" ] } ] } [/block] After that you'll see a security alert. Click on "Open". [block:callout] { "type": "warning", "title": "Mac OSX Security Settings", "body": "Make sure that your Mac OSX security settings are set to \"Allow apps downloaded from: **Mac App Store and identified developers**. If you want to change to head to System Preferences -> Security & Privacy. Then you can change it." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/sPp1aNDTQ2w0yIDV0rkp_Screen%20Shot%202016-07-06%20at%2023.38.03.png", "Screen Shot 2016-07-06 at 23.38.03.png", "850", "468", "#904c0c", "" ] } ] } [/block] After that you should see your IOTA application successfully running. Congratz! You're successfully connected to the network now and are running your node. [block:callout] { "type": "warning", "title": "Java Update", "body": "If you are using an older version of Java, the GUI prompts you to update to Java 8. You can automatically upgrade your Java version through the GUI." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/T6ReRyRIufBVm3QLTQzH_8vhYM9gx9.png", "8vhYM9gx9.png", "595", "837", "#37b2a5", "" ] } ] } [/block]
After you have downloaded the `.dmg` file from our [Github repo](https://github.com/iotaledger/wallet/releases), head to the Download folder and click on the .dmg file. You should see a folder like below. Drag the IOTA Wallet icon into the Applications folder. [block:image] { "images": [ { "image": [ "https://files.readme.io/1fhN84MOTTWzTspwdLkj_8vihIdnNj.png", "8vihIdnNj.png", "592", "555", "#d06056", "" ] } ] } [/block] Once you've dragged the IOTA Wallet into your applications folder, head to your Applications folder and right click on the IOTA Wallet and click on "Open". [block:image] { "images": [ { "image": [ "https://files.readme.io/ssv9oY74RwWI7Hm8aRYw_Screen%20Shot%202016-07-06%20at%2023.42.25.png", "Screen Shot 2016-07-06 at 23.42.25.png", "1540", "880", "#3c618d", "" ] } ] } [/block] After that you'll see a security alert. Click on "Open". [block:callout] { "type": "warning", "title": "Mac OSX Security Settings", "body": "Make sure that your Mac OSX security settings are set to \"Allow apps downloaded from: **Mac App Store and identified developers**. If you want to change to head to System Preferences -> Security & Privacy. Then you can change it." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/sPp1aNDTQ2w0yIDV0rkp_Screen%20Shot%202016-07-06%20at%2023.38.03.png", "Screen Shot 2016-07-06 at 23.38.03.png", "850", "468", "#904c0c", "" ] } ] } [/block] After that you should see your IOTA application successfully running. Congratz! You're successfully connected to the network now and are running your node. [block:callout] { "type": "warning", "title": "Java Update", "body": "If you are using an older version of Java, the GUI prompts you to update to Java 8. You can automatically upgrade your Java version through the GUI." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/T6ReRyRIufBVm3QLTQzH_8vhYM9gx9.png", "8vhYM9gx9.png", "595", "837", "#37b2a5", "" ] } ] } [/block]
{"_id":"59180a5f2cd60a0f000d203f","link_external":false,"type":"basic","title":"Install on Linux","body":"For Linux there are several different packages which you can use to install the IOTA GUI. Most prominently Debian, RedHat, the tar files as well as the newly provided [AppImages](http://appimage.org/).. Download your preferable package for your OS and then follow the simple installation instructions.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Debian Package\"\n}\n[/block]\nOnce you've downloaded the package, go to the Download folder and doubeclick on the package.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/dvZPUH5CR9mouO2qWZKE_Qo6xvBh.png\",\n        \"Qo6xvBh.png\",\n        \"855\",\n        \"579\",\n        \"#e1724b\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nAfter that you'll be taken to the Ubuntu Software Center. Proceed the installation process by clicking on \"Install\". \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/LZAASYTQT5mghbg9aDQ6_3Zv0EKF.png\",\n        \"3Zv0EKF.png\",\n        \"1155\",\n        \"681\",\n        \"#b69d65\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nIf asked for authentication, enter your password.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ZcDHeH00TnyqKcl0NpsH_DzSOYfp.png\",\n        \"DzSOYfp.png\",\n        \"1071\",\n        \"537\",\n        \"#af7259\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce completed, you should see that the IOTA wallet was successfully installed.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/W2gCSZaPR66aYpZQkm0g_a1uYulp.png\",\n        \"a1uYulp.png\",\n        \"1149\",\n        \"653\",\n        \"#bb9b63\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nNow you should have it in your Applications folder.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/pX2UI3ESPa3FmCmJKUid_Xtr1DMv.png\",\n        \"Xtr1DMv.png\",\n        \"1139\",\n        \"465\",\n        \"#52648c\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/05zmC5pWQRaNU0YLtheW_0avIsHD.png\",\n        \"0avIsHD.png\",\n        \"832\",\n        \"698\",\n        \"#1e8b7e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","createdAt":"2016-07-04T18:33:45.398Z","excerpt":"","order":3,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"linux","sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"link_url":"","next":{"pages":[],"description":""},"isReference":false,"updates":[],"user":"573f104a176bea2b000e9699","version":"59180a5d2cd60a0f000d2033","__v":0,"category":"59180a5e2cd60a0f000d2035","githubsync":"","hidden":false,"childrenPages":[]}

Install on Linux


For Linux there are several different packages which you can use to install the IOTA GUI. Most prominently Debian, RedHat, the tar files as well as the newly provided [AppImages](http://appimage.org/).. Download your preferable package for your OS and then follow the simple installation instructions. [block:api-header] { "type": "basic", "title": "Debian Package" } [/block] Once you've downloaded the package, go to the Download folder and doubeclick on the package. [block:image] { "images": [ { "image": [ "https://files.readme.io/dvZPUH5CR9mouO2qWZKE_Qo6xvBh.png", "Qo6xvBh.png", "855", "579", "#e1724b", "" ] } ] } [/block] After that you'll be taken to the Ubuntu Software Center. Proceed the installation process by clicking on "Install". [block:image] { "images": [ { "image": [ "https://files.readme.io/LZAASYTQT5mghbg9aDQ6_3Zv0EKF.png", "3Zv0EKF.png", "1155", "681", "#b69d65", "" ] } ] } [/block] If asked for authentication, enter your password. [block:image] { "images": [ { "image": [ "https://files.readme.io/ZcDHeH00TnyqKcl0NpsH_DzSOYfp.png", "DzSOYfp.png", "1071", "537", "#af7259", "" ] } ] } [/block] Once completed, you should see that the IOTA wallet was successfully installed. [block:image] { "images": [ { "image": [ "https://files.readme.io/W2gCSZaPR66aYpZQkm0g_a1uYulp.png", "a1uYulp.png", "1149", "653", "#bb9b63", "" ] } ] } [/block] Now you should have it in your Applications folder. [block:image] { "images": [ { "image": [ "https://files.readme.io/pX2UI3ESPa3FmCmJKUid_Xtr1DMv.png", "Xtr1DMv.png", "1139", "465", "#52648c", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/05zmC5pWQRaNU0YLtheW_0avIsHD.png", "0avIsHD.png", "832", "698", "#1e8b7e", "" ] } ] } [/block]
For Linux there are several different packages which you can use to install the IOTA GUI. Most prominently Debian, RedHat, the tar files as well as the newly provided [AppImages](http://appimage.org/).. Download your preferable package for your OS and then follow the simple installation instructions. [block:api-header] { "type": "basic", "title": "Debian Package" } [/block] Once you've downloaded the package, go to the Download folder and doubeclick on the package. [block:image] { "images": [ { "image": [ "https://files.readme.io/dvZPUH5CR9mouO2qWZKE_Qo6xvBh.png", "Qo6xvBh.png", "855", "579", "#e1724b", "" ] } ] } [/block] After that you'll be taken to the Ubuntu Software Center. Proceed the installation process by clicking on "Install". [block:image] { "images": [ { "image": [ "https://files.readme.io/LZAASYTQT5mghbg9aDQ6_3Zv0EKF.png", "3Zv0EKF.png", "1155", "681", "#b69d65", "" ] } ] } [/block] If asked for authentication, enter your password. [block:image] { "images": [ { "image": [ "https://files.readme.io/ZcDHeH00TnyqKcl0NpsH_DzSOYfp.png", "DzSOYfp.png", "1071", "537", "#af7259", "" ] } ] } [/block] Once completed, you should see that the IOTA wallet was successfully installed. [block:image] { "images": [ { "image": [ "https://files.readme.io/W2gCSZaPR66aYpZQkm0g_a1uYulp.png", "a1uYulp.png", "1149", "653", "#bb9b63", "" ] } ] } [/block] Now you should have it in your Applications folder. [block:image] { "images": [ { "image": [ "https://files.readme.io/pX2UI3ESPa3FmCmJKUid_Xtr1DMv.png", "Xtr1DMv.png", "1139", "465", "#52648c", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/05zmC5pWQRaNU0YLtheW_0avIsHD.png", "0avIsHD.png", "832", "698", "#1e8b7e", "" ] } ] } [/block]
{"_id":"59180a5f2cd60a0f000d2041","createdAt":"2016-07-07T07:16:42.746Z","githubsync":"","link_external":false,"next":{"pages":[],"description":""},"sync_unique":"","project":"573f1056804f901700a9e07b","slug":"creating-a-new-account","api":{"params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required"},"category":"59180a5e2cd60a0f000d2035","excerpt":"","hidden":false,"isReference":false,"user":"573f104a176bea2b000e9699","__v":0,"updates":[],"version":"59180a5d2cd60a0f000d2033","body":"Creating a new account is as easy as generating a new, unique seed (consisting of 81-chars, only latin letters and 9's). You do not need to make your seed 81-chars long, but that is suggested. If you already generated a seed before you can enter it and access your account directly. \n\nOnce you've done so you can start generating addresses, receiving and sending transactions. \n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"IMPORTANT\",\n  \"body\": \"Your seed is your private key that is used to access your account, and thus your IOTA tokens. Do not share it with anyone and keep it stored safely somewhere where nobody else but you can access it. If you have forgotten your seed, you will lose access to your IOTA tokens.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/HlEh6klTRSqOxiPH6C2P_Screen%20Shot%202016-07-06%20at%2023.44.15.png\",\n        \"Screen Shot 2016-07-06 at 23.44.15.png\",\n        \"1606\",\n        \"1356\",\n        \"#1c9c90\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","link_url":"","order":4,"parentDoc":null,"title":"Creating a New Account","type":"basic","childrenPages":[]}

Creating a New Account


Creating a new account is as easy as generating a new, unique seed (consisting of 81-chars, only latin letters and 9's). You do not need to make your seed 81-chars long, but that is suggested. If you already generated a seed before you can enter it and access your account directly. Once you've done so you can start generating addresses, receiving and sending transactions. [block:callout] { "type": "danger", "title": "IMPORTANT", "body": "Your seed is your private key that is used to access your account, and thus your IOTA tokens. Do not share it with anyone and keep it stored safely somewhere where nobody else but you can access it. If you have forgotten your seed, you will lose access to your IOTA tokens." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/HlEh6klTRSqOxiPH6C2P_Screen%20Shot%202016-07-06%20at%2023.44.15.png", "Screen Shot 2016-07-06 at 23.44.15.png", "1606", "1356", "#1c9c90", "" ] } ] } [/block]
Creating a new account is as easy as generating a new, unique seed (consisting of 81-chars, only latin letters and 9's). You do not need to make your seed 81-chars long, but that is suggested. If you already generated a seed before you can enter it and access your account directly. Once you've done so you can start generating addresses, receiving and sending transactions. [block:callout] { "type": "danger", "title": "IMPORTANT", "body": "Your seed is your private key that is used to access your account, and thus your IOTA tokens. Do not share it with anyone and keep it stored safely somewhere where nobody else but you can access it. If you have forgotten your seed, you will lose access to your IOTA tokens." } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/HlEh6klTRSqOxiPH6C2P_Screen%20Shot%202016-07-06%20at%2023.44.15.png", "Screen Shot 2016-07-06 at 23.44.15.png", "1606", "1356", "#1c9c90", "" ] } ] } [/block]
{"_id":"59180a5f2cd60a0f000d2040","__v":0,"type":"basic","excerpt":"","isReference":false,"order":5,"project":"573f1056804f901700a9e07b","body":"A simplistic User Interface (Nostalgia), is provided to help community members get started with using IOTA. The actual GUI wallet will be released in a few days, so if you don't feel comfortable with Nostalgia, I suggest you to wait until the wallet is ready. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Download Nostalgia\"\n}\n[/block]\nAs a first step, you should download Nostalgia from our Github: \n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Download Nostalgia\",\n  \"body\": \"https://github.com/domschiener/nostalgia\"\n}\n[/block]\nIf you are on Linux/Mac, you can simply open your console and clone the project: \n```\ngit clone https://github.com/domschiener/nostalgia \n```\n\nElse you can also simply download the zipped version from here: https://github.com/domschiener/nostalgia/archive/master.zip \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"5. Run Nostalgia\"\n}\n[/block]\nNow in order to run nostalgia, all you need to do is open up `nostalgia.html`. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Different Port\",\n  \"body\": \"If you are using a different port than **14265**, change line 18 in nostalgia.html to the correct port.\"\n}\n[/block]\nNow all you have to do is type in your seed and hit enter in order to login. You should now see an empty screen and you can start sending transactions and generating addresses. \n\nIf you have already made transactions, Nostalgia will mark sent transactions in red (as in the picture below), so that you know to which address you have sent tokens.\n \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/14258c0-Screen_Shot_2016-10-21_at_18.01.56.png\",\n        \"Screen Shot 2016-10-21 at 18.01.56.png\",\n        2728,\n        1714,\n        \"#f0e1e1\"\n      ]\n    }\n  ]\n}\n[/block]\nIn addition to that, you can also take a look at the entire bundle by clicking on \"Show Bundle\". The transactions form the bundle will be marked in blue. If you click on Show Bundle again they will disappear.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/7c194ba-Screen_Shot_2016-10-21_at_18.04.01.png\",\n        \"Screen Shot 2016-10-21 at 18.04.01.png\",\n        2530,\n        772,\n        \"#e0e8ee\"\n      ]\n    }\n  ]\n}\n[/block]","category":"59180a5e2cd60a0f000d2035","createdAt":"2016-10-24T13:22:29.304Z","slug":"getting-started-with-nostalgia","title":"Getting Started with Nostalgia","version":"59180a5d2cd60a0f000d2033","user":"573f104a176bea2b000e9699","githubsync":"","hidden":false,"link_url":"","updates":[],"sync_unique":"","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"link_external":false,"next":{"pages":[],"description":""},"parentDoc":null,"childrenPages":[]}

Getting Started with Nostalgia


A simplistic User Interface (Nostalgia), is provided to help community members get started with using IOTA. The actual GUI wallet will be released in a few days, so if you don't feel comfortable with Nostalgia, I suggest you to wait until the wallet is ready. [block:api-header] { "type": "basic", "title": "1. Download Nostalgia" } [/block] As a first step, you should download Nostalgia from our Github: [block:callout] { "type": "success", "title": "Download Nostalgia", "body": "https://github.com/domschiener/nostalgia" } [/block] If you are on Linux/Mac, you can simply open your console and clone the project: ``` git clone https://github.com/domschiener/nostalgia ``` Else you can also simply download the zipped version from here: https://github.com/domschiener/nostalgia/archive/master.zip [block:api-header] { "type": "basic", "title": "5. Run Nostalgia" } [/block] Now in order to run nostalgia, all you need to do is open up `nostalgia.html`. [block:callout] { "type": "warning", "title": "Different Port", "body": "If you are using a different port than **14265**, change line 18 in nostalgia.html to the correct port." } [/block] Now all you have to do is type in your seed and hit enter in order to login. You should now see an empty screen and you can start sending transactions and generating addresses. If you have already made transactions, Nostalgia will mark sent transactions in red (as in the picture below), so that you know to which address you have sent tokens. [block:image] { "images": [ { "image": [ "https://files.readme.io/14258c0-Screen_Shot_2016-10-21_at_18.01.56.png", "Screen Shot 2016-10-21 at 18.01.56.png", 2728, 1714, "#f0e1e1" ] } ] } [/block] In addition to that, you can also take a look at the entire bundle by clicking on "Show Bundle". The transactions form the bundle will be marked in blue. If you click on Show Bundle again they will disappear. [block:image] { "images": [ { "image": [ "https://files.readme.io/7c194ba-Screen_Shot_2016-10-21_at_18.04.01.png", "Screen Shot 2016-10-21 at 18.04.01.png", 2530, 772, "#e0e8ee" ] } ] } [/block]
A simplistic User Interface (Nostalgia), is provided to help community members get started with using IOTA. The actual GUI wallet will be released in a few days, so if you don't feel comfortable with Nostalgia, I suggest you to wait until the wallet is ready. [block:api-header] { "type": "basic", "title": "1. Download Nostalgia" } [/block] As a first step, you should download Nostalgia from our Github: [block:callout] { "type": "success", "title": "Download Nostalgia", "body": "https://github.com/domschiener/nostalgia" } [/block] If you are on Linux/Mac, you can simply open your console and clone the project: ``` git clone https://github.com/domschiener/nostalgia ``` Else you can also simply download the zipped version from here: https://github.com/domschiener/nostalgia/archive/master.zip [block:api-header] { "type": "basic", "title": "5. Run Nostalgia" } [/block] Now in order to run nostalgia, all you need to do is open up `nostalgia.html`. [block:callout] { "type": "warning", "title": "Different Port", "body": "If you are using a different port than **14265**, change line 18 in nostalgia.html to the correct port." } [/block] Now all you have to do is type in your seed and hit enter in order to login. You should now see an empty screen and you can start sending transactions and generating addresses. If you have already made transactions, Nostalgia will mark sent transactions in red (as in the picture below), so that you know to which address you have sent tokens. [block:image] { "images": [ { "image": [ "https://files.readme.io/14258c0-Screen_Shot_2016-10-21_at_18.01.56.png", "Screen Shot 2016-10-21 at 18.01.56.png", 2728, 1714, "#f0e1e1" ] } ] } [/block] In addition to that, you can also take a look at the entire bundle by clicking on "Show Bundle". The transactions form the bundle will be marked in blue. If you click on Show Bundle again they will disappear. [block:image] { "images": [ { "image": [ "https://files.readme.io/7c194ba-Screen_Shot_2016-10-21_at_18.04.01.png", "Screen Shot 2016-10-21 at 18.04.01.png", 2530, 772, "#e0e8ee" ] } ] } [/block]
{"_id":"59180a612cd60a0f000d2051","project":"573f1056804f901700a9e07b","title":"API Introduction","type":"basic","version":"59180a5d2cd60a0f000d2033","api":{"url":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"githubsync":"","link_url":"","slug":"getting-started","updates":[],"user":"573f104a176bea2b000e9699","excerpt":"","next":{"pages":[],"description":""},"sync_unique":"","__v":0,"body":"The IOTA Java client makes it possible to interact with your local node and request certain information or actions to be taken. Once your node is successfully setup, you can interface with it through port `14265` by passing along a JSON object which contains a specified command; and upon successful execution of the command, returns your requested information.\n\nThe main priority of the API as well as IRI itself is security. As such, anything that has to do with private keys is done *client side*. For this we have provided several libraries that take care of this, but you can implement this functionality yourself as well. \n\nFor your convenience, we have added concrete examples on how to use the API in Curl, Python and NodeJS. If you are using Javascript, you can simply follow along by using either XMLHttpRequest or jQuery. For NodeJS, please install the wonderful [request npm package](https://github.com/request/request), as all our examples require the request package.\n\nFor the rest of this documentation it is assumed that you have the IOTA client running at port `14265` (or a port of your choice, change your requests accordingly then).","category":"59180a5e2cd60a0f000d2036","link_external":false,"order":0,"parentDoc":null,"createdAt":"2016-05-20T13:25:43.013Z","hidden":false,"isReference":false,"childrenPages":[]}

API Introduction


The IOTA Java client makes it possible to interact with your local node and request certain information or actions to be taken. Once your node is successfully setup, you can interface with it through port `14265` by passing along a JSON object which contains a specified command; and upon successful execution of the command, returns your requested information. The main priority of the API as well as IRI itself is security. As such, anything that has to do with private keys is done *client side*. For this we have provided several libraries that take care of this, but you can implement this functionality yourself as well. For your convenience, we have added concrete examples on how to use the API in Curl, Python and NodeJS. If you are using Javascript, you can simply follow along by using either XMLHttpRequest or jQuery. For NodeJS, please install the wonderful [request npm package](https://github.com/request/request), as all our examples require the request package. For the rest of this documentation it is assumed that you have the IOTA client running at port `14265` (or a port of your choice, change your requests accordingly then).
The IOTA Java client makes it possible to interact with your local node and request certain information or actions to be taken. Once your node is successfully setup, you can interface with it through port `14265` by passing along a JSON object which contains a specified command; and upon successful execution of the command, returns your requested information. The main priority of the API as well as IRI itself is security. As such, anything that has to do with private keys is done *client side*. For this we have provided several libraries that take care of this, but you can implement this functionality yourself as well. For your convenience, we have added concrete examples on how to use the API in Curl, Python and NodeJS. If you are using Javascript, you can simply follow along by using either XMLHttpRequest or jQuery. For NodeJS, please install the wonderful [request npm package](https://github.com/request/request), as all our examples require the request package. For the rest of this documentation it is assumed that you have the IOTA client running at port `14265` (or a port of your choice, change your requests accordingly then).
{"_id":"59180a612cd60a0f000d2052","excerpt":"","githubsync":"","sync_unique":"","title":"Making Requests","user":"573f104a176bea2b000e9699","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"category":"59180a5e2cd60a0f000d2036","hidden":false,"isReference":false,"next":{"pages":[],"description":""},"slug":"making-requests","body":"All API calls need to be sent to `http://localhost:14265` (if you are using the standard port) via a POST HTTP request. The data which will be sent is a **JSON object** which follows the same standard schema of:\n\n    {‘command’: ’YOURCOMMANDHERE’}\n\nAdditional parameters are simply added as additional key-value pairs. If the command is successfully executed, your requested information is returned as either an object or a stringified object (use `json.parse` or equivalent to turn it into an object).\n\nWhen making a request, make sure that the HTTP library you're using defines the `Content-Length` of the data to be sent. If this is not done automatically, manually add it via a header field e.g. `'Content-Length': Buffer.byteLength(JSON.stringify(command))`.","parentDoc":null,"version":"59180a5d2cd60a0f000d2033","type":"basic","updates":[],"__v":0,"createdAt":"2016-07-02T11:52:30.391Z","link_external":false,"link_url":"","order":1,"project":"573f1056804f901700a9e07b","childrenPages":[]}

Making Requests


All API calls need to be sent to `http://localhost:14265` (if you are using the standard port) via a POST HTTP request. The data which will be sent is a **JSON object** which follows the same standard schema of: {‘command’: ’YOURCOMMANDHERE’} Additional parameters are simply added as additional key-value pairs. If the command is successfully executed, your requested information is returned as either an object or a stringified object (use `json.parse` or equivalent to turn it into an object). When making a request, make sure that the HTTP library you're using defines the `Content-Length` of the data to be sent. If this is not done automatically, manually add it via a header field e.g. `'Content-Length': Buffer.byteLength(JSON.stringify(command))`.
All API calls need to be sent to `http://localhost:14265` (if you are using the standard port) via a POST HTTP request. The data which will be sent is a **JSON object** which follows the same standard schema of: {‘command’: ’YOURCOMMANDHERE’} Additional parameters are simply added as additional key-value pairs. If the command is successfully executed, your requested information is returned as either an object or a stringified object (use `json.parse` or equivalent to turn it into an object). When making a request, make sure that the HTTP library you're using defines the `Content-Length` of the data to be sent. If this is not done automatically, manually add it via a header field e.g. `'Content-Length': Buffer.byteLength(JSON.stringify(command))`.
{"_id":"59180a612cd60a0f000d2053","next":{"pages":[],"description":""},"type":"basic","title":"CORS","updates":[],"__v":0,"createdAt":"2016-07-02T11:56:01.888Z","githubsync":"","link_external":false,"order":2,"user":"573f104a176bea2b000e9699","version":"59180a5d2cd60a0f000d2033","excerpt":"","hidden":false,"parentDoc":null,"slug":"cors","sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"CORS is enabled \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Work in progress\"\n}\n[/block]","category":"59180a5e2cd60a0f000d2036","isReference":false,"link_url":"","project":"573f1056804f901700a9e07b","childrenPages":[]}

CORS


CORS is enabled [block:callout] { "type": "warning", "title": "Work in progress" } [/block]
CORS is enabled [block:callout] { "type": "warning", "title": "Work in progress" } [/block]
{"_id":"59180a612cd60a0f000d2054","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","auth":"required","params":[],"url":""},"excerpt":"","hidden":false,"isReference":false,"next":{"pages":[],"description":""},"slug":"errors","type":"basic","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"WORK IN PROGRESS\",\n  \"body\": \"This page will be taken care of soon.\"\n}\n[/block]","order":3,"project":"573f1056804f901700a9e07b","category":"59180a5e2cd60a0f000d2036","createdAt":"2016-07-02T11:56:17.540Z","link_external":false,"sync_unique":"","title":"Errors","updates":[],"version":"59180a5d2cd60a0f000d2033","__v":0,"githubsync":"","link_url":"","parentDoc":null,"user":"573f104a176bea2b000e9699","childrenPages":[]}

Errors


[block:callout] { "type": "warning", "title": "WORK IN PROGRESS", "body": "This page will be taken care of soon." } [/block]
[block:callout] { "type": "warning", "title": "WORK IN PROGRESS", "body": "This page will be taken care of soon." } [/block]
{"_id":"59180a612cd60a0f000d2055","updates":["58dea0ed6641651b002d2cab"],"body":"Here we list and describe all additional parameters which are required to be passed along for certain commands.\n\n- **`seed`**: `string` tryte encoded string which contains the accounts seed. The seed must be correctly encoded trytes: only uppercase latin letters and 9’s. No other characters are allowed. The maximum security level is 81-trytes, but you can choose longer/shorter seeds.\n- **`address`**: `string` 81-trytes long address of the recipient of a transaction.\nvalue: string the quantity of IOTA’s which should be transferred.\n- **`message`**: `string` tryte-encoded string which can contain arbitrary information and is sent alongside a transaction. The message value is publicly visible. The max value is 2187 trytes, which is 6561 trits (or roughly 1312 bytes).\n- **`transaction`** / **`hash`**: `string` hash of a transaction. A single transaction hash is 81-chars long.\n- **`trytes`**: `string` the raw data of a transaction.\n- **`bundles`**: `list` contains a list of transaction bundles. Bundles are basically linked, individual transactions which were created with a single transfer. They are uniquely identified by a 27-char hash.\n- **`addresses`** : `list` a list of addresses. A single address is 81-chars long.\n- **`tags`**: `list` the tag of a transaction.\n- **`approvees`**: `list` a list of transaction which were referenced by this transaction\n- **`securityLevel`**: `int` specifies the security level of your transaction. Can either by 0 (for 81-trit security), 1 (for 162-trit security) and 2 (for 243-trit security). Lower security transactions are faster to generate.\n- **`minWeightMagnitude`**: `int` specifies the amount of Proof of Work that will be carried out. Currently can only take the value 18.","link_url":"","title":"Fields","next":{"pages":[],"description":""},"slug":"fields","sync_unique":"","user":"573f104a176bea2b000e9699","category":"59180a5e2cd60a0f000d2036","isReference":false,"link_external":false,"hidden":false,"order":4,"parentDoc":null,"project":"573f1056804f901700a9e07b","version":"59180a5d2cd60a0f000d2033","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"createdAt":"2016-07-02T11:56:42.554Z","excerpt":"","type":"basic","__v":0,"githubsync":"","childrenPages":[]}

Fields


Here we list and describe all additional parameters which are required to be passed along for certain commands. - **`seed`**: `string` tryte encoded string which contains the accounts seed. The seed must be correctly encoded trytes: only uppercase latin letters and 9’s. No other characters are allowed. The maximum security level is 81-trytes, but you can choose longer/shorter seeds. - **`address`**: `string` 81-trytes long address of the recipient of a transaction. value: string the quantity of IOTA’s which should be transferred. - **`message`**: `string` tryte-encoded string which can contain arbitrary information and is sent alongside a transaction. The message value is publicly visible. The max value is 2187 trytes, which is 6561 trits (or roughly 1312 bytes). - **`transaction`** / **`hash`**: `string` hash of a transaction. A single transaction hash is 81-chars long. - **`trytes`**: `string` the raw data of a transaction. - **`bundles`**: `list` contains a list of transaction bundles. Bundles are basically linked, individual transactions which were created with a single transfer. They are uniquely identified by a 27-char hash. - **`addresses`** : `list` a list of addresses. A single address is 81-chars long. - **`tags`**: `list` the tag of a transaction. - **`approvees`**: `list` a list of transaction which were referenced by this transaction - **`securityLevel`**: `int` specifies the security level of your transaction. Can either by 0 (for 81-trit security), 1 (for 162-trit security) and 2 (for 243-trit security). Lower security transactions are faster to generate. - **`minWeightMagnitude`**: `int` specifies the amount of Proof of Work that will be carried out. Currently can only take the value 18.
Here we list and describe all additional parameters which are required to be passed along for certain commands. - **`seed`**: `string` tryte encoded string which contains the accounts seed. The seed must be correctly encoded trytes: only uppercase latin letters and 9’s. No other characters are allowed. The maximum security level is 81-trytes, but you can choose longer/shorter seeds. - **`address`**: `string` 81-trytes long address of the recipient of a transaction. value: string the quantity of IOTA’s which should be transferred. - **`message`**: `string` tryte-encoded string which can contain arbitrary information and is sent alongside a transaction. The message value is publicly visible. The max value is 2187 trytes, which is 6561 trits (or roughly 1312 bytes). - **`transaction`** / **`hash`**: `string` hash of a transaction. A single transaction hash is 81-chars long. - **`trytes`**: `string` the raw data of a transaction. - **`bundles`**: `list` contains a list of transaction bundles. Bundles are basically linked, individual transactions which were created with a single transfer. They are uniquely identified by a 27-char hash. - **`addresses`** : `list` a list of addresses. A single address is 81-chars long. - **`tags`**: `list` the tag of a transaction. - **`approvees`**: `list` a list of transaction which were referenced by this transaction - **`securityLevel`**: `int` specifies the security level of your transaction. Can either by 0 (for 81-trit security), 1 (for 162-trit security) and 2 (for 243-trit security). Lower security transactions are faster to generate. - **`minWeightMagnitude`**: `int` specifies the amount of Proof of Work that will be carried out. Currently can only take the value 18.
{"_id":"59180a602cd60a0f000d2043","type":"post","updates":[],"version":"59180a5d2cd60a0f000d2033","api":{"settings":"","auth":"required","params":[{"ref":"","in":"body","required":true,"desc":"","default":"getNodeInfo","type":"string","name":"command","_id":"5777ad46ea758f0e00e6f7b1"}],"url":"/","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getNodeInfo\"}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getNodeInfo'\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n    'command': 'getNodeInfo'\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","name":"NodeJS"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"appName\": \"IRI\",\n    \"appVersion\": \"1.0.8.nu\",\n    \"duration\": 1,\n    \"jreAvailableProcessors\": 4,\n    \"jreFreeMemory\": 91707424,\n    \"jreMaxMemory\": 1908932608,\n    \"jreTotalMemory\": 122683392,\n    \"latestMilestone\": \"VBVEUQYE99LFWHDZRFKTGFHYGDFEAMAEBGUBTTJRFKHCFBRTXFAJQ9XIUEZQCJOQTZNOOHKUQIKOY9999\",\n    \"latestMilestoneIndex\": 107,\n    \"latestSolidSubtangleMilestone\": \"VBVEUQYE99LFWHDZRFKTGFHYGDFEAMAEBGUBTTJRFKHCFBRTXFAJQ9XIUEZQCJOQTZNOOHKUQIKOY9999\",\n    \"latestSolidSubtangleMilestoneIndex\": 107,\n    \"neighbors\": 2,\n    \"packetsQueueSize\": 0,\n    \"time\": 1477037811737,\n    \"tips\": 3,\n    \"transactionsToRequest\": 0\n}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]}},"link_url":"","next":{"pages":[],"description":""},"sync_unique":"","githubsync":"","isReference":false,"parentDoc":null,"hidden":false,"link_external":false,"user":"573f104a176bea2b000e9699","__v":0,"body":"Returns information about your node.\n\n#### Return Values\n\n- **`appName`**: Name of the IOTA software you're currently using (IRI stands for Initial Reference Implementation).\n- **`appVersion`**: The version of the IOTA software you're currently running. \n- **`jreAvailableProcesses`**: Available cores on your machine for JRE. \n- **`jreFreeMemory`**: Returns the amount of free memory in the Java Virtual Machine.\n- **`jreMaxMemory`**: Returns the maximum amount of memory that the Java virtual machine will attempt to use. \n- **`jreTotalMemory`**: Returns the total amount of memory in the Java virtual machine. \n- **`latestMilestone`**: Latest milestone that was signed off by the coordinator. \n- **`latestMilestoneIndex`**: Index of the latest milestone.\n- **`latestSolidSubtangleMilestone`**: The latest milestone which is solid and is used for sending transactions. For a milestone to become solid your local node must basically approve the subtangle of coordinator-approved transactions, and have a consistent view of all referenced transactions. \n- **`latestSolidSubtangleMilestoneIndex`**: Index of the latest solid subtangle.  \n- **`neighbors`**: Number of neighbors you are directly connected with.\n- **`packetsQueueSize`**: Packets which are currently queued up.\n- **`time`**: Current UNIX timestamp.\n- **`tips`**: Number of tips in the network.\n- **`transactionsToRequest`**: Transactions to request during syncing process.","excerpt":"","order":0,"project":"573f1056804f901700a9e07b","slug":"getnodeinfo","title":"getNodeInfo","category":"59180a5e2cd60a0f000d2037","createdAt":"2016-07-02T11:58:27.093Z","childrenPages":[]}

postgetNodeInfo


Body Params

command:
required
stringgetNodeInfo
Returns information about your node. #### Return Values - **`appName`**: Name of the IOTA software you're currently using (IRI stands for Initial Reference Implementation). - **`appVersion`**: The version of the IOTA software you're currently running. - **`jreAvailableProcesses`**: Available cores on your machine for JRE. - **`jreFreeMemory`**: Returns the amount of free memory in the Java Virtual Machine. - **`jreMaxMemory`**: Returns the maximum amount of memory that the Java virtual machine will attempt to use. - **`jreTotalMemory`**: Returns the total amount of memory in the Java virtual machine. - **`latestMilestone`**: Latest milestone that was signed off by the coordinator. - **`latestMilestoneIndex`**: Index of the latest milestone. - **`latestSolidSubtangleMilestone`**: The latest milestone which is solid and is used for sending transactions. For a milestone to become solid your local node must basically approve the subtangle of coordinator-approved transactions, and have a consistent view of all referenced transactions. - **`latestSolidSubtangleMilestoneIndex`**: Index of the latest solid subtangle. - **`neighbors`**: Number of neighbors you are directly connected with. - **`packetsQueueSize`**: Packets which are currently queued up. - **`time`**: Current UNIX timestamp. - **`tips`**: Number of tips in the network. - **`transactionsToRequest`**: Transactions to request during syncing process.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns information about your node. #### Return Values - **`appName`**: Name of the IOTA software you're currently using (IRI stands for Initial Reference Implementation). - **`appVersion`**: The version of the IOTA software you're currently running. - **`jreAvailableProcesses`**: Available cores on your machine for JRE. - **`jreFreeMemory`**: Returns the amount of free memory in the Java Virtual Machine. - **`jreMaxMemory`**: Returns the maximum amount of memory that the Java virtual machine will attempt to use. - **`jreTotalMemory`**: Returns the total amount of memory in the Java virtual machine. - **`latestMilestone`**: Latest milestone that was signed off by the coordinator. - **`latestMilestoneIndex`**: Index of the latest milestone. - **`latestSolidSubtangleMilestone`**: The latest milestone which is solid and is used for sending transactions. For a milestone to become solid your local node must basically approve the subtangle of coordinator-approved transactions, and have a consistent view of all referenced transactions. - **`latestSolidSubtangleMilestoneIndex`**: Index of the latest solid subtangle. - **`neighbors`**: Number of neighbors you are directly connected with. - **`packetsQueueSize`**: Packets which are currently queued up. - **`time`**: Current UNIX timestamp. - **`tips`**: Number of tips in the network. - **`transactionsToRequest`**: Transactions to request during syncing process.
{"_id":"59180a602cd60a0f000d2044","api":{"auth":"required","params":[{"_id":"577a21c0d051530e00f65556","ref":"","in":"body","required":true,"desc":"","default":"getNeighbors","type":"string","name":"command"}],"url":"/","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getNeighbors\"}'","language":"curl"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getNeighbors'\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n    'command': 'getNeighbors'\n}\n\nvar headers = {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n};\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","name":"NodeJS"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"duration\": 37,\n    \"neighbors\": [\n        {\n            \"address\": \"/8.8.8.8:14265\",\n            \"numberOfAllTransactions\": 922,\n            \"numberOfInvalidTransactions\": 0,\n            \"numberOfNewTransactions\": 92\n        },\n        {\n            \"address\": \"/8.8.8.8:5000\",\n            \"numberOfAllTransactions\": 925,\n            \"numberOfInvalidTransactions\": 0,\n            \"numberOfNewTransactions\": 20\n        }\n    ]\n}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]},"settings":""},"body":"Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI.\n\n#### Return Values\n\n- **`address`** : address of your peer \n- **`numberOfAllTransactions`**: Number of all transactions sent (invalid, valid, already-seen)\n- **`numberOfInvalidTransactions`**: Invalid transactions your peer has sent you. These are transactions with invalid signatures or overall schema.\n- **`numberOfNewTransactions`**: New transactions which were transmitted.","hidden":false,"order":1,"project":"573f1056804f901700a9e07b","slug":"getneighborsactivity","category":"59180a5e2cd60a0f000d2037","excerpt":"","link_external":false,"sync_unique":"","type":"post","updates":[],"link_url":"","parentDoc":null,"version":"59180a5d2cd60a0f000d2033","user":"573f104a176bea2b000e9699","__v":0,"createdAt":"2016-07-02T12:03:50.844Z","githubsync":"","isReference":false,"next":{"pages":[],"description":""},"title":"getNeighbors","childrenPages":[]}

postgetNeighbors


Body Params

command:
required
stringgetNeighbors
Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI. #### Return Values - **`address`** : address of your peer - **`numberOfAllTransactions`**: Number of all transactions sent (invalid, valid, already-seen) - **`numberOfInvalidTransactions`**: Invalid transactions your peer has sent you. These are transactions with invalid signatures or overall schema. - **`numberOfNewTransactions`**: New transactions which were transmitted.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns the set of neighbors you are connected with, as well as their activity count. The activity counter is reset after restarting IRI. #### Return Values - **`address`** : address of your peer - **`numberOfAllTransactions`**: Number of all transactions sent (invalid, valid, already-seen) - **`numberOfInvalidTransactions`**: Invalid transactions your peer has sent you. These are transactions with invalid signatures or overall schema. - **`numberOfNewTransactions`**: New transactions which were transmitted.
{"_id":"59180a602cd60a0f000d2045","title":"addNeighbors","type":"post","user":"573f104a176bea2b000e9699","__v":1,"body":"Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI.\n\nThe URI (Unique Resource Identification) for adding neighbors is: \n**`udp://IPADDRESS:PORT`**","githubsync":"","link_url":"","isReference":false,"order":2,"project":"573f1056804f901700a9e07b","slug":"addneighors","next":{"pages":[],"description":""},"parentDoc":null,"api":{"results":{"codes":[{"name":"","code":"{\n  \"addedNeighbors\": 0, \n  \"duration\": 2\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"name":"command","_id":"5809de49629bf91900cd1397","ref":"","in":"body","required":true,"desc":"","default":"addNeighbors","type":"string"},{"type":"array_string","name":"uris","_id":"5809de49629bf91900cd1396","ref":"","in":"body","required":true,"desc":"List of URI elements.","default":""}],"url":"/","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"addNeighbors\", \"uris\": [\"udp://8.8.8.8:14265\", \"udp://8.8.8.5:14265\"]}'","language":"curl"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n  'command': 'addNeighbors',\n\t'uris': ['udp://8.1.8.8:14265', 'udp://8.8.2.5:14265']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"code":"var request = require('request');\n\nvar command = {\n  'command': 'addNeighbors',\n\t'uris': ['udp://8.1.8.8:14265', 'udp://8.8.2.5:14265']\n}\n\nvar headers = {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n};\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript","name":"NodeJS"}]},"method":"post"},"excerpt":"","link_external":false,"updates":["594c21d6f0be9d000f640526"],"version":"59180a5d2cd60a0f000d2033","category":"59180a5e2cd60a0f000d2037","createdAt":"2016-10-21T08:59:31.037Z","hidden":false,"sync_unique":"","childrenPages":[]}

postaddNeighbors


Body Params

command:
required
stringaddNeighbors
uris:
required
array of strings
List of URI elements.
Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI. The URI (Unique Resource Identification) for adding neighbors is: **`udp://IPADDRESS:PORT`**

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Add a list of neighbors to your node. It should be noted that this is only temporary, and the added neighbors will be removed from your set of neighbors after you relaunch IRI. The URI (Unique Resource Identification) for adding neighbors is: **`udp://IPADDRESS:PORT`**
{"_id":"59180a602cd60a0f000d2046","api":{"settings":"","auth":"required","params":[{"type":"string","name":"command","_id":"5809de49629bf91900cd1397","ref":"","in":"body","required":true,"desc":"","default":"removeNeighbors"},{"required":true,"desc":"List of URI elements.","default":"","type":"array_string","name":"uris","_id":"5809de49629bf91900cd1396","ref":"","in":"body"}],"url":"/","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"removeNeighbors\", \"uris\": [\"udp://8.8.8.8:14265\", \"udp://8.8.8.5:14265\"]}'","language":"curl"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n  'command': 'removeNeighbors',\n\t'uris': ['udp://8.1.8.8:14265', 'udp://8.8.2.5:14265']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"name":"NodeJS","code":"var request = require('request');\n\nvar command = {\n  'command': 'removeNeighbors',\n\t'uris': ['udp://8.1.8.8:14265', 'udp://8.8.2.5:14265']\n}\n\nvar headers = {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n};\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"removedNeighbors\": 0, \n  \"duration\": 2\n}","language":"json","status":200},{"code":"{}","language":"json","status":400,"name":""}]}},"hidden":false,"link_external":false,"project":"573f1056804f901700a9e07b","slug":"removeneighors","updates":[],"user":"573f104a176bea2b000e9699","body":"Removes a list of neighbors to your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node. \n\nThe URI (Unique Resource Identification) for adding neighbors is: \n**`udp://IPADDRESS:PORT`**","githubsync":"","isReference":false,"next":{"pages":[],"description":""},"sync_unique":"","title":"removeNeighbors","createdAt":"2016-10-21T09:27:00.024Z","parentDoc":null,"version":"59180a5d2cd60a0f000d2033","__v":0,"category":"59180a5e2cd60a0f000d2037","excerpt":"","link_url":"","order":3,"type":"post","childrenPages":[]}

postremoveNeighbors


Body Params

command:
required
stringremoveNeighbors
uris:
required
array of strings
List of URI elements.
Removes a list of neighbors to your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node. The URI (Unique Resource Identification) for adding neighbors is: **`udp://IPADDRESS:PORT`**

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Removes a list of neighbors to your node. This is only temporary, and if you have your neighbors added via the command line, they will be retained after you restart your node. The URI (Unique Resource Identification) for adding neighbors is: **`udp://IPADDRESS:PORT`**
{"_id":"59180a602cd60a0f000d2047","parentDoc":null,"updates":[],"body":"Returns the list of tips.","createdAt":"2016-07-04T08:49:23.141Z","githubsync":"","isReference":false,"link_external":false,"version":"59180a5d2cd60a0f000d2033","next":{"pages":[],"description":""},"project":"573f1056804f901700a9e07b","__v":0,"category":"59180a5e2cd60a0f000d2037","hidden":false,"order":4,"title":"getTips","user":"573f104a176bea2b000e9699","api":{"examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTips\"}'"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getTips'\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData","language":"python"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n    'command': 'getTips'\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest.post('http://localhost:14265',JSON.stringify(command), function (error, response, data) {\n  console.log(error, response);\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});\n","name":"NodeJS"}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"hashes\": \n  [\"YVXJOEOP9JEPRQUVBPJMB9MGIB9OMTIJJLIUYPM9YBIWXPZ9PQCCGXYSLKQWKHBRVA9AKKKXXMXF99999\", \"ZUMARCWKZOZRMJM9EEYJQCGXLHWXPRTMNWPBRCAGSGQNRHKGRUCIYQDAEUUEBRDBNBYHAQSSFZZQW9999\", \"QLQECHDVQBMXKD9YYLBMGQLLIQ9PSOVDRLYCLLFMS9O99XIKCUHWAFWSTARYNCPAVIQIBTVJROOYZ9999\"], \n  \"duration\": 4\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"desc":"","default":"getTips","type":"string","name":"command","_id":"577a2313aea88b0e00f632dd","ref":"","in":"body","required":true}],"url":"/"},"excerpt":"","link_url":"","slug":"gettips","sync_unique":"","type":"post","childrenPages":[]}

postgetTips


Body Params

command:
required
stringgetTips
Returns the list of tips.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns the list of tips.
{"_id":"59180a602cd60a0f000d2048","sync_unique":"","type":"post","version":"59180a5d2cd60a0f000d2033","__v":0,"createdAt":"2016-07-06T17:58:47.726Z","link_external":false,"slug":"findtransactions","api":{"url":"/","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"findTransactions\", \"addresses\": [\"RVORZ9SIIP9RCYMREUIXXVPQIPHVCNPQ9HZWYKFWYWZRE9JQKG9REPKIASHUUECPSQO9JT9XNMVKWYGVAZETAIRPTM\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'findTransactions',\n    'addresses': ['RVORZ9SIIP9RCYMREUIXXVPQIPHVCNPQ9HZWYKFWYWZRE9JQKG9REPKIASHUUECPSQO9JT9XNMVKWYGVAZETAIRPTM']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"code":"var request = require('request');\n\nvar command = {\n  'command': 'findTransactions',\n  'addresses': ['RVORZ9SIIP9RCYMREUIXXVPQIPHVCNPQ9HZWYKFWYWZRE9JQKG9REPKIASHUUECPSQO9JT9XNMVKWYGVAZETAIRPTM']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","name":"NodeJS","language":"javascript"}]},"method":"post","results":{"codes":[{"code":"{ \n  hashes: [ \n    'ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999' \n  ] \n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}"}]},"settings":"","auth":"required","params":[{"type":"string","name":"command","_id":"577d46d7aa701f0e00382593","ref":"","in":"body","required":true,"desc":"","default":"findTransactions"},{"desc":"List of bundle hashes. The hashes need to be extended to 81chars by padding the hash with 9's.","default":"","type":"array_string","name":"bundles","_id":"577d46d7aa701f0e00382592","ref":"","in":"body","required":false},{"name":"addresses","_id":"577d46d7aa701f0e00382591","ref":"","in":"body","required":false,"desc":"List of addresses.","default":"","type":"array_string"},{"ref":"","in":"body","required":false,"desc":"List of transaction tags.","default":"","type":"array_string","name":"tags","_id":"577d46d7aa701f0e00382590"},{"in":"body","required":false,"desc":"List of approvees of a transaction.","default":"","type":"array_string","name":"approvees","_id":"577d46d7aa701f0e0038258f","ref":""}]},"body":"Find the transactions which match the specified input and return. All input values are lists, for which a list of return values (transaction hashes), in the same order, is returned for all individual elements. The input fields can either be `bundles`, `addresses`, `tags` or `approvees`. **Using multiple of these input fields returns the intersection of the values.**\n\nParameters | Type | Required | Description\n------------ | ------------- | ------------- | -------------\n`bundles` | list | Optional | List of bundle hashes. The hashes needs to be extended to 81 trytes by padding the hash with 9's.\n`addresses` | list | Optional | List of addresses.\n`tags` | list | Optional | List of tags. Has to be 27 trytes.\n`approvees` | list | Optional | List of approvee transaction hashes.\n\n#### Return Values\n\nThe transaction hashes which are returned depend on your input. For each specified input value, the command will return the following:\n\n- **`bundles`**: returns the list of transactions which contain the specified bundle hash.\n- **`addresses`**: returns the list of transactions which have the specified address as an input/output field.\n- **`tags`**: returns the list of transactions which contain the specified tag value.\n- **`approvees`**: returns the list of transaction which reference (i.e. confirm) the specified transaction.","category":"59180a5e2cd60a0f000d2037","isReference":false,"parentDoc":null,"githubsync":"","hidden":false,"link_url":"","next":{"pages":[],"description":""},"updates":[],"excerpt":"","order":5,"project":"573f1056804f901700a9e07b","title":"findTransactions","user":"573f104a176bea2b000e9699","childrenPages":[]}

postfindTransactions


Body Params

command:
required
stringfindTransactions
bundles:
array of strings
List of bundle hashes. The hashes need to be extended to 81chars by padding the hash with 9's.
addresses:
array of strings
List of addresses.
tags:
array of strings
List of transaction tags.
approvees:
array of strings
List of approvees of a transaction.
Find the transactions which match the specified input and return. All input values are lists, for which a list of return values (transaction hashes), in the same order, is returned for all individual elements. The input fields can either be `bundles`, `addresses`, `tags` or `approvees`. **Using multiple of these input fields returns the intersection of the values.** Parameters | Type | Required | Description ------------ | ------------- | ------------- | ------------- `bundles` | list | Optional | List of bundle hashes. The hashes needs to be extended to 81 trytes by padding the hash with 9's. `addresses` | list | Optional | List of addresses. `tags` | list | Optional | List of tags. Has to be 27 trytes. `approvees` | list | Optional | List of approvee transaction hashes. #### Return Values The transaction hashes which are returned depend on your input. For each specified input value, the command will return the following: - **`bundles`**: returns the list of transactions which contain the specified bundle hash. - **`addresses`**: returns the list of transactions which have the specified address as an input/output field. - **`tags`**: returns the list of transactions which contain the specified tag value. - **`approvees`**: returns the list of transaction which reference (i.e. confirm) the specified transaction.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Find the transactions which match the specified input and return. All input values are lists, for which a list of return values (transaction hashes), in the same order, is returned for all individual elements. The input fields can either be `bundles`, `addresses`, `tags` or `approvees`. **Using multiple of these input fields returns the intersection of the values.** Parameters | Type | Required | Description ------------ | ------------- | ------------- | ------------- `bundles` | list | Optional | List of bundle hashes. The hashes needs to be extended to 81 trytes by padding the hash with 9's. `addresses` | list | Optional | List of addresses. `tags` | list | Optional | List of tags. Has to be 27 trytes. `approvees` | list | Optional | List of approvee transaction hashes. #### Return Values The transaction hashes which are returned depend on your input. For each specified input value, the command will return the following: - **`bundles`**: returns the list of transactions which contain the specified bundle hash. - **`addresses`**: returns the list of transactions which have the specified address as an input/output field. - **`tags`**: returns the list of transactions which contain the specified tag value. - **`approvees`**: returns the list of transaction which reference (i.e. confirm) the specified transaction.
{"_id":"59180a602cd60a0f000d2049","api":{"url":"/","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTrytes\", \"hashes\": [\"OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getTrytes',\n    'hashes': ['OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n  'command': 'getTrytes',\n  'hashes': ['OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","name":"NodeJS"}]},"method":"post","results":{"codes":[{"name":"","code":"{ \n  trytes: [ 'BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' \n          ] \n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"577d54f1aa701f0e003825ca","ref":"","in":"body","required":true,"desc":"","default":"getTrytes","type":"string","name":"command"},{"_id":"577d54f1aa701f0e003825c9","ref":"","in":"body","required":true,"desc":"List of transaction hashes of which you want to get trytes from.","default":"","type":"array_string","name":"hashes"}]},"category":"59180a5e2cd60a0f000d2037","parentDoc":null,"type":"post","updates":["58497f3ff212ae1b009d04ad"],"__v":0,"excerpt":"","link_external":false,"next":{"pages":[],"description":""},"title":"getTrytes","user":"573f104a176bea2b000e9699","version":"59180a5d2cd60a0f000d2033","createdAt":"2016-07-06T18:58:57.283Z","hidden":false,"link_url":"","order":6,"project":"573f1056804f901700a9e07b","slug":"gettrytes","sync_unique":"","githubsync":"","isReference":false,"body":"Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. See utility functions for more details.","childrenPages":[]}

postgetTrytes


Body Params

command:
required
stringgetTrytes
hashes:
required
array of strings
List of transaction hashes of which you want to get trytes from.
Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. See utility functions for more details.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns the raw transaction data (trytes) of a specific transaction. These trytes can then be easily converted into the actual transaction object. See utility functions for more details.
{"_id":"59180a602cd60a0f000d204a","project":"573f1056804f901700a9e07b","sync_unique":"","user":"573f104a176bea2b000e9699","api":{"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"states\": [true], \n  \"duration\": 91\n}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"required":true,"desc":"","default":"getInclusionStates","type":"string","name":"command","_id":"57c7fec3690c200e0047b714","ref":"","in":"body"},{"ref":"","in":"body","required":true,"desc":"List of transactions you want to get the inclusion state for.","default":"","type":"array_string","name":"transactions","_id":"57c7fec3690c200e0047b713"},{"in":"body","required":true,"desc":"List of tips (including milestones) you want to search for the inclusion state.","default":"","type":"array_string","name":"tips","_id":"57c7fec3690c200e0047b712","ref":""}],"url":"/","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getInclusionStates\", \"transactions\": [\"QHBYXQWRAHQJZEIARWSQGZJTAIITOZRMBFICIPAVD9YRJMXFXBDPFDTRAHHHP9YPDUVTNOFWZGFGWMYHEKNAGNJHMW\"], \"tips\": [\"ZIJGAJ9AADLRPWNCYNNHUHRRAC9QOUDATEDQUMTNOTABUVRPTSTFQDGZKFYUUIE9ZEBIVCCXXXLKX9999\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getInclusionStates',\n    'transactions': ['QHBYXQWRAHQJZEIARWSQGZJTAIITOZRMBFICIPAVD9YRJMXFXBDPFDTRAHHHP9YPDUVTNOFWZGFGWMYHEKNAGNJHMW'],\n    'tips': ['ZIJGAJ9AADLRPWNCYNNHUHRRAC9QOUDATEDQUMTNOTABUVRPTSTFQDGZKFYUUIE9ZEBIVCCXXXLKX9999']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"code":"var request = require('request');\n\nvar command = {\n    'command': 'getInclusionStates',\n    'transactions': ['QHBYXQWRAHQJZEIARWSQGZJTAIITOZRMBFICIPAVD9YRJMXFXBDPFDTRAHHHP9YPDUVTNOFWZGFGWMYHEKNAGNJHMW'],\n    'tips': ['ZIJGAJ9AADLRPWNCYNNHUHRRAC9QOUDATEDQUMTNOTABUVRPTSTFQDGZKFYUUIE9ZEBIVCCXXXLKX9999']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript","name":"NodeJS"}]}},"createdAt":"2016-09-01T10:11:15.115Z","hidden":false,"updates":[],"version":"59180a5d2cd60a0f000d2033","githubsync":"","link_url":"","parentDoc":null,"next":{"pages":[],"description":""},"order":7,"title":"getInclusionStates","__v":0,"body":"Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions. \n\nThis API call simply returns a list of boolean values in the same order as the transaction list you submitted, thus you get a true/false whether a transaction is confirmed or not.","link_external":false,"isReference":false,"slug":"getinclusionstates","type":"post","category":"59180a5e2cd60a0f000d2037","excerpt":"","childrenPages":[]}

postgetInclusionStates


Body Params

command:
required
stringgetInclusionStates
transactions:
required
array of strings
List of transactions you want to get the inclusion state for.
tips:
required
array of strings
List of tips (including milestones) you want to search for the inclusion state.
Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions. This API call simply returns a list of boolean values in the same order as the transaction list you submitted, thus you get a true/false whether a transaction is confirmed or not.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Get the inclusion states of a set of transactions. This is for determining if a transaction was accepted and confirmed by the network or not. You can search for multiple tips (and thus, milestones) to get past inclusion states of transactions. This API call simply returns a list of boolean values in the same order as the transaction list you submitted, thus you get a true/false whether a transaction is confirmed or not.
{"_id":"59180a602cd60a0f000d204b","__v":0,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"balances\": [\n        \"114544444\"\n    ],\n    \"duration\": 30,\n    \"milestone\": \"INRTUYSZCWBHGFGGXXPWRWBZACYAFGVRRP9VYEQJOHYD9URMELKWAFYFMNTSP9MCHLXRGAFMBOZPZ9999\",\n    \"milestoneIndex\": 128\n}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[{"desc":"","default":"getBalances","type":"string","name":"command","_id":"57c7fec3690c200e0047b714","ref":"","in":"body","required":true},{"name":"addresses","_id":"57c7fec3690c200e0047b713","ref":"","in":"body","required":true,"desc":"List of addresses you want to get the confirmed balance from","default":"","type":"array_string"},{"type":"int","name":"threshold","_id":"57c7fec3690c200e0047b712","ref":"","in":"body","required":true,"desc":"Confirmation threshold, should be set to 100.","default":"100"}],"url":"/","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getBalances\", \"addresses\": [\"HBBYKAKTILIPVUKFOTSLHGENPTXYBNKXZFQFR9VQFWNBMTQNRVOUKPVPRNBSZVVILMAFBKOTBLGLWLOHQ\"], \"threshold\": 100}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getBalances',\n    'addresses': ['HBBYKAKTILIPVUKFOTSLHGENPTXYBNKXZFQFR9VQFWNBMTQNRVOUKPVPRNBSZVVILMAFBKOTBLGLWLOHQ'],\n    'threshold': 100\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"code":"var request = require('request');\n\nvar command = {\n    'command': 'getBalances',\n    'addresses': ['HBBYKAKTILIPVUKFOTSLHGENPTXYBNKXZFQFR9VQFWNBMTQNRVOUKPVPRNBSZVVILMAFBKOTBLGLWLOHQ'],\n    'threshold': 100\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript","name":"NodeJS"}]}},"parentDoc":null,"project":"573f1056804f901700a9e07b","sync_unique":"","excerpt":"","link_url":"","next":{"pages":[],"description":""},"order":8,"updates":[],"version":"59180a5d2cd60a0f000d2033","category":"59180a5e2cd60a0f000d2037","createdAt":"2016-10-21T10:16:13.536Z","hidden":false,"isReference":false,"link_external":false,"slug":"getbalances","title":"getBalances","type":"post","user":"573f104a176bea2b000e9699","body":"Similar to `getInclusionStates`. It returns the confirmed balance which a list of addresses have at the latest confirmed milestone. In addition to the balances, it also returns the milestone as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input.","githubsync":"","childrenPages":[]}

postgetBalances


Body Params

command:
required
stringgetBalances
addresses:
required
array of strings
List of addresses you want to get the confirmed balance from
threshold:
required
integer100
Confirmation threshold, should be set to 100.
Similar to `getInclusionStates`. It returns the confirmed balance which a list of addresses have at the latest confirmed milestone. In addition to the balances, it also returns the milestone as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Similar to `getInclusionStates`. It returns the confirmed balance which a list of addresses have at the latest confirmed milestone. In addition to the balances, it also returns the milestone as well as the index with which the confirmed balance was determined. The balances is returned as a list in the same order as the addresses were provided as input.
{"_id":"59180a602cd60a0f000d204c","sync_unique":"","title":"getTransactionsToApprove","body":"Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is `depth`, which basically determines how many bundles to go back to for finding the transactions to approve. The higher your `depth` value, the more \"babysitting\" you do for the network (as you have to confirm more transactions).","createdAt":"2016-07-30T20:58:31.665Z","link_url":"","next":{"pages":[],"description":""},"type":"post","updates":[],"user":"573f104a176bea2b000e9699","excerpt":"","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"api":{"url":"/","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTransactionsToApprove\", \"depth\": 27}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getTransactionsToApprove',\n    'depth': 27\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData","language":"python"},{"code":"var request = require('request');\n\nvar command = {\n  'command': 'getTransactionsToApprove',\n  'depth': 27 \n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest.post('http://localhost:14265',JSON.stringify(command), function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript","name":"NodeJS"}]},"method":"post","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"trunkTransaction\": \"TKGDZ9GEI9CPNQGHEATIISAKYPPPSXVCXBSR9EIWCTHHSSEQCD9YLDPEXYERCNJVASRGWMAVKFQTC9999\", \n  \"branchTransaction\": \"TKGDZ9GEI9CPNQGHEATIISAKYPPPSXVCXBSR9EIWCTHHSSEQCD9YLDPEXYERCNJVASRGWMAVKFQTC9999\", \n  \"duration\": 936\n}"},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","auth":"required","params":[{"ref":"","in":"body","required":true,"desc":"","default":"getTransactionsToApprove","type":"string","name":"command","_id":"579d14f710a40b0e000c7bf8"},{"default":"","type":"int","name":"depth","_id":"579d14f710a40b0e000c7bf7","ref":"","in":"body","required":true,"desc":"Number of bundles to go back to determine the transactions for approval."}]},"category":"59180a5e2cd60a0f000d2037","githubsync":"","order":9,"version":"59180a5d2cd60a0f000d2033","__v":0,"project":"573f1056804f901700a9e07b","slug":"gettransactionstoapprove","childrenPages":[]}

postgetTransactionsToApprove


Body Params

command:
required
stringgetTransactionsToApprove
depth:
required
integer
Number of bundles to go back to determine the transactions for approval.
Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is `depth`, which basically determines how many bundles to go back to for finding the transactions to approve. The higher your `depth` value, the more "babysitting" you do for the network (as you have to confirm more transactions).

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is `depth`, which basically determines how many bundles to go back to for finding the transactions to approve. The higher your `depth` value, the more "babysitting" you do for the network (as you have to confirm more transactions).
{"_id":"59180a602cd60a0f000d204d","user":"573f104a176bea2b000e9699","version":"59180a5d2cd60a0f000d2033","__v":0,"excerpt":"","hidden":false,"link_url":"","updates":[],"body":"Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply `branchTransaction` as well as `trunkTransaction` (basically the tips which you're going to validate and reference with this transaction) - both of which you'll get through the `getTransactionsToApprove` API call. \n\nThe returned value is a different set of tryte values which you can input into `broadcastTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `trunkTransaction` + `branchTransaction` + `nonce`. These are valid trytes which are then accepted by the network.","githubsync":"","type":"post","createdAt":"2016-07-30T21:56:11.692Z","isReference":false,"next":{"pages":[],"description":""},"parentDoc":null,"sync_unique":"","title":"attachToTangle","api":{"examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"attachToTangle\", \"trunkTransaction\": \"JVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999\", \"branchTransaction\": \"P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999\", \"minWeightMagnitude\": 18, \"trytes\": [\"TRYTVALUEHERE\"]}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'attachToTangle',\n    'trunkTransaction': 'JVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999', \n    'branchTransaction': 'P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999',\n    'minWeightMagnitude': 18,\n    'trytes': ['TRYTVALUEHERE']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url='http://localhost:14265', data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData\n","language":"python"},{"code":"var request = require('request');\n\nvar command = {\n    'command': 'attachToTangle',\n    'trunkTransaction': 'JVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999',\n    'branchTransaction': 'P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999',\n    'minWeightMagnitude': 18,\n    'trytes': ['TRYTVALUEHERE']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': JSON.stringify(command).length\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});\n","language":"javascript","name":"NodeJS"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  'trytes':['TRYTEVALUEHERE']\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"name":"command","_id":"579d227be781c719001a7bd9","ref":"","in":"body","required":true,"desc":"","default":"attachToTangle","type":"string"},{"type":"string","name":"trunkTransaction","_id":"579d227be781c719001a7bd8","ref":"","in":"body","required":true,"desc":"Trunk transaction to approve.","default":""},{"required":true,"desc":"Branch transaction to approve.","default":"","type":"string","name":"branchTransaction","_id":"579d227be781c719001a7bd7","ref":"","in":"body"},{"ref":"","in":"body","required":true,"desc":"Proof of Work intensity. Minimum value is 18","default":"18","type":"int","name":"minWeightMagnitude","_id":"579d227be781c719001a7bd6"},{"in":"body","required":true,"desc":"List of trytes (raw transaction data) to attach to the tangle.","default":"","type":"array_string","name":"trytes","_id":"579d227be781c719001a7bd5","ref":""}],"url":"/"},"category":"59180a5e2cd60a0f000d2037","link_external":false,"order":10,"project":"573f1056804f901700a9e07b","slug":"attachtotangle","childrenPages":[]}

postattachToTangle


Body Params

command:
required
stringattachToTangle
trunkTransaction:
required
string
Trunk transaction to approve.
branchTransaction:
required
string
Branch transaction to approve.
minWeightMagnitude:
required
integer18
Proof of Work intensity. Minimum value is 18
trytes:
required
array of strings
List of trytes (raw transaction data) to attach to the tangle.
Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply `branchTransaction` as well as `trunkTransaction` (basically the tips which you're going to validate and reference with this transaction) - both of which you'll get through the `getTransactionsToApprove` API call. The returned value is a different set of tryte values which you can input into `broadcastTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `trunkTransaction` + `branchTransaction` + `nonce`. These are valid trytes which are then accepted by the network.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply `branchTransaction` as well as `trunkTransaction` (basically the tips which you're going to validate and reference with this transaction) - both of which you'll get through the `getTransactionsToApprove` API call. The returned value is a different set of tryte values which you can input into `broadcastTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `trunkTransaction` + `branchTransaction` + `nonce`. These are valid trytes which are then accepted by the network.
{"_id":"59180a602cd60a0f000d204e","excerpt":"","link_external":false,"project":"573f1056804f901700a9e07b","title":"interruptAttachingToTangle","user":"573f104a176bea2b000e9699","api":{"url":"/","examples":{"codes":[]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","auth":"required","params":[{"in":"body","required":true,"desc":"","default":"interruptAttachingToTangle","type":"string","name":"command","_id":"57c7fef3690c200e0047b716","ref":""}]},"category":"59180a5e2cd60a0f000d2037","order":11,"slug":"interruptattachingtotangle","type":"post","updates":[],"body":"Interrupts and completely aborts the `attachToTangle` process.","createdAt":"2016-09-01T10:12:03.747Z","githubsync":"","hidden":false,"isReference":false,"parentDoc":null,"sync_unique":"","version":"59180a5d2cd60a0f000d2033","__v":0,"link_url":"","next":{"pages":[],"description":""},"childrenPages":[]}

postinterruptAttachingToTangle


Body Params

command:
required
stringinterruptAttachingToTangle
Interrupts and completely aborts the `attachToTangle` process.

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Interrupts and completely aborts the `attachToTangle` process.
{"_id":"59180a602cd60a0f000d204f","version":"59180a5d2cd60a0f000d2033","api":{"settings":"","auth":"required","params":[{"ref":"","in":"body","required":true,"desc":"","default":"broadcastTransactions","type":"string","name":"command","_id":"577d66b647a9ab0e003dfed2"},{"in":"body","required":true,"desc":"List of raw data of transactions to be rebroadcast.","default":"","type":"array_string","name":"trytes","_id":"577d66b647a9ab0e003dfed1","ref":""}],"url":"/","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"broadcastTransactions\", \"trytes\": [\"BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999\"]}'","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'broadcastTransactions',\n    'trytes': ['BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData","language":"python"},{"code":"var request = require('request');\n\nvar command = {\n  'command': 'broadcastTransactions',\n  'trytes': ['SECRETMESSAGE99999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999UMHUBWT9YHMQ9PUWOFVJNWWIYPYJROYXZVTNKMQCMFMYQOXMFHJLZCNGPFGMMYJKJONSMBSFPBP9IWJOONOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999WB9XLUD99A99999999IOKRINUKSMUZAOSYKNNSYKELXJM999999999999999999999999999MWRHKZRYYJPCQYOMUZU9ZGUGCPZWYVUTLDPTSRMQPGAPCUDDXQNIOOR9KPAHLYOGQJQUCBDP9DRXORKUOJVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","language":"javascript"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2016-07-06T20:14:46.483Z","hidden":false,"project":"573f1056804f901700a9e07b","user":"573f104a176bea2b000e9699","body":"Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by `attachToTangle`.","excerpt":"","link_url":"","order":12,"updates":[],"category":"59180a5e2cd60a0f000d2037","link_external":false,"parentDoc":null,"slug":"broadcasttransactions","title":"broadcastTransactions","sync_unique":"","type":"post","__v":0,"githubsync":"","isReference":false,"next":{"pages":[],"description":""},"childrenPages":[]}

postbroadcastTransactions


Body Params

command:
required
stringbroadcastTransactions
trytes:
required
array of strings
List of raw data of transactions to be rebroadcast.
Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by `attachToTangle`.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by `attachToTangle`.
{"_id":"59180a602cd60a0f000d2050","githubsync":"","link_url":"","api":{"examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"storeTransactions\", \"trytes\": [\"BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'storeTransactions',\n    'trytes': ['BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999']\n}\n\nstringified = json.dumps(command)\n\nheaders = {'content-type': 'application/json'}\n\nrequest = urllib2.Request(url=\"http://localhost:14265\", data=stringified, headers=headers)\nreturnData = urllib2.urlopen(request).read()\n\njsonData = json.loads(returnData)\n\nprint jsonData"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n  'command': 'storeTransactions',\n  'trytes': ['SECRETMESSAGE99999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999UMHUBWT9YHMQ9PUWOFVJNWWIYPYJROYXZVTNKMQCMFMYQOXMFHJLZCNGPFGMMYJKJONSMBSFPBP9IWJOONOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999WB9XLUD99A99999999IOKRINUKSMUZAOSYKNNSYKELXJM999999999999999999999999999MWRHKZRYYJPCQYOMUZU9ZGUGCPZWYVUTLDPTSRMQPGAPCUDDXQNIOOR9KPAHLYOGQJQUCBDP9DRXORKUOJVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999']\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json',\n    'Content-Length': Buffer.byteLength(JSON.stringify(command))\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});","name":"NodeJS"}]},"method":"post","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","auth":"required","params":[{"in":"body","required":true,"desc":"","default":"broadcastTransactions","type":"string","name":"command","_id":"577d66b647a9ab0e003dfed2","ref":""},{"desc":"List of raw data of transactions to be rebroadcast.","default":"","type":"array_string","name":"trytes","_id":"577d66b647a9ab0e003dfed1","ref":"","in":"body","required":true}],"url":"/"},"excerpt":"","hidden":false,"order":13,"parentDoc":null,"slug":"storetransactions","updates":[],"__v":0,"isReference":false,"link_external":false,"next":{"pages":[],"description":""},"project":"573f1056804f901700a9e07b","title":"storeTransactions","type":"post","body":"Store transactions into the local storage. The trytes to be used for this call are returned by `attachToTangle`.","category":"59180a5e2cd60a0f000d2037","createdAt":"2016-07-30T22:00:30.291Z","sync_unique":"","user":"573f104a176bea2b000e9699","version":"59180a5d2cd60a0f000d2033","childrenPages":[]}

poststoreTransactions


Body Params

command:
required
stringbroadcastTransactions
trytes:
required
array of strings
List of raw data of transactions to be rebroadcast.
Store transactions into the local storage. The trytes to be used for this call are returned by `attachToTangle`.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Store transactions into the local storage. The trytes to be used for this call are returned by `attachToTangle`.