{"__v":0,"_id":"57c75e17eba84d0e007d0069","api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"body":"[IOTA](https://iotatoken.com) is a revolutionary new transactional settlement and data transfer layer for the Internet of Things. It’s based on a new distributed ledger, 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 **unoptimized reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months.\"\n}\n[/block]","category":"57c75e17eba84d0e007d0064","createdAt":"2016-07-02T11:37:56.216Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"what-is-iota","sync_unique":"","title":"What is IOTA?","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

What is IOTA?


[IOTA](https://iotatoken.com) is a revolutionary new transactional settlement and data transfer layer for the Internet of Things. It’s based on a new distributed ledger, 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 **unoptimized reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months." } [/block]
[IOTA](https://iotatoken.com) is a revolutionary new transactional settlement and data transfer layer for the Internet of Things. It’s based on a new distributed ledger, 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 **unoptimized reference implementation**. Major improvements to performance, features as well as ease of use will be made over the coming months." } [/block]
{"__v":0,"_id":"57c75e17eba84d0e007d006a","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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.","category":"57c75e17eba84d0e007d0064","createdAt":"2016-07-02T11:43:52.781Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"glossary","sync_unique":"","title":"Glossary","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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.
{"__v":0,"_id":"57c75e17eba84d0e007d006b","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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]","category":"57c75e17eba84d0e007d0064","createdAt":"2016-07-02T11:45:41.653Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"frequently-asked-questions","sync_unique":"","title":"Frequently Asked Questions","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d006c","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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)","category":"57c75e17eba84d0e007d0064","createdAt":"2016-07-09T09:09:31.260Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"whitepaper","sync_unique":"","title":"Whitepaper","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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)
{"__v":0,"_id":"57c75e18eba84d0e007d006d","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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, 32-bit or 64-bit. \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\": \"Currently you cannot compile IOTA from source. Once we have officially launched you will be able to simply clone it from our Github repo. Stay tuned.\"\n}\n[/block]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-04T18:34:00.813Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"general","sync_unique":"","title":"How to Install","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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, 32-bit or 64-bit. [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": "Currently you cannot compile IOTA from source. Once we have officially launched you will be able to simply clone it from our Github repo. Stay tuned." } [/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, 32-bit or 64-bit. [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": "Currently you cannot compile IOTA from source. Once we have officially launched you will be able to simply clone it from our Github repo. Stay tuned." } [/block]
{"__v":0,"_id":"57c75e18eba84d0e007d006e","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"After you have downloaded the .exe file from our [Github repo](https://github.com/iotaledger/wallet/releases) (either 32-bit or 64-bit, depending on your system) 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]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-04T18:33:34.917Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"windows","sync_unique":"","title":"Install on Windows","type":"basic","updates":["57a4efc77523720e00b4aa7f"],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

Install on Windows


After you have downloaded the .exe file from our [Github repo](https://github.com/iotaledger/wallet/releases) (either 32-bit or 64-bit, depending on your system) 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) (either 32-bit or 64-bit, depending on your system) 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]
{"__v":0,"_id":"57c75e18eba84d0e007d006f","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-04T18:33:41.577Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"mac-os-x","sync_unique":"","title":"Install on Mac OS X","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d0070","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-04T18:33:45.398Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"linux","sync_unique":"","title":"Install on Linux","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d0071","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-07T07:16:42.746Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"creating-a-new-account","sync_unique":"","title":"Creating a New Account","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d0072","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Since release 1.0.3 automated peer discovery has been added, which means that you should be able to sync with the network within 1 - 2 hours on a good connection.\n\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Tangle not Solid\",\n  \"body\": \"If you get a \\\"Tangle not solid\\\" error, it means that you have to wait until you're synced with the network.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]","category":"57c75e17eba84d0e007d0065","createdAt":"2016-07-12T08:34:27.285Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"syncing-to-the-network","sync_unique":"","title":"Syncing to the Network","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

Syncing to the Network


Since release 1.0.3 automated peer discovery has been added, which means that you should be able to sync with the network within 1 - 2 hours on a good connection. [block:callout] { "type": "info", "title": "Tangle not Solid", "body": "If you get a \"Tangle not solid\" error, it means that you have to wait until you're synced with the network." } [/block] [block:api-header] { "type": "basic" } [/block]
Since release 1.0.3 automated peer discovery has been added, which means that you should be able to sync with the network within 1 - 2 hours on a good connection. [block:callout] { "type": "info", "title": "Tangle not Solid", "body": "If you get a \"Tangle not solid\" error, it means that you have to wait until you're synced with the network." } [/block] [block:api-header] { "type": "basic" } [/block]
{"__v":0,"_id":"57c75e18eba84d0e007d0086","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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\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. You can find an example on how to do it with the [HTTP package here](https://github.com/IOTAledger/documentation/examples/getNodeInfo/script_http.js).\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":"57c75e17eba84d0e007d0066","createdAt":"2016-05-20T13:25:43.013Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getting-started","sync_unique":"","title":"API Introduction","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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. 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. You can find an example on how to do it with the [HTTP package here](https://github.com/IOTAledger/documentation/examples/getNodeInfo/script_http.js). 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. 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. You can find an example on how to do it with the [HTTP package here](https://github.com/IOTAledger/documentation/examples/getNodeInfo/script_http.js). 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).
{"__v":0,"_id":"57c75e18eba84d0e007d0087","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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))`.","category":"57c75e17eba84d0e007d0066","createdAt":"2016-07-02T11:52:30.391Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"making-requests","sync_unique":"","title":"Making Requests","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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))`.
{"__v":0,"_id":"57c75e18eba84d0e007d0088","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":"57c75e17eba84d0e007d0066","createdAt":"2016-07-02T11:56:01.888Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"cors","sync_unique":"","title":"CORS","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d0089","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"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]","category":"57c75e17eba84d0e007d0066","createdAt":"2016-07-02T11:56:17.540Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"errors","sync_unique":"","title":"Errors","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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]
{"__v":0,"_id":"57c75e18eba84d0e007d008a","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Here we list and describe all additional parameters which are required to be passed along for certain commands.\n\n- **`seed`**: `string` 81-char encoded string which contains the accounts seed. The seed must be correctly encoded: only uppercase latin letters and 9’s. No other characters are allowed.  \n- **`address`**: `string` 81-char 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`**: `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- **`digests`**: `list` the message digest 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 13.","category":"57c75e17eba84d0e007d0066","createdAt":"2016-07-02T11:56:42.554Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"fields","sync_unique":"","title":"Fields","type":"basic","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

Fields


Here we list and describe all additional parameters which are required to be passed along for certain commands. - **`seed`**: `string` 81-char encoded string which contains the accounts seed. The seed must be correctly encoded: only uppercase latin letters and 9’s. No other characters are allowed. - **`address`**: `string` 81-char 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`**: `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. - **`digests`**: `list` the message digest 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 13.
Here we list and describe all additional parameters which are required to be passed along for certain commands. - **`seed`**: `string` 81-char encoded string which contains the accounts seed. The seed must be correctly encoded: only uppercase latin letters and 9’s. No other characters are allowed. - **`address`**: `string` 81-char 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`**: `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. - **`digests`**: `list` the message digest 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 13.
{"__v":0,"_id":"57c75e18eba84d0e007d0073","api":{"auth":"required","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","params":[{"_id":"5777ad46ea758f0e00e6f7b1","ref":"","in":"body","required":true,"desc":"","default":"getNodeInfo","type":"string","name":"command"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  appName: 'IRI',\n  appVersion: '1.0.4',\n  incomingPacketsBacklog: 0,\n  jreAvailableProcessors: 4,\n  jreFreeMemory: 40076864,\n  jreMaxMemory: 1908932608,\n  jreTotalMemory: 250085376,\n  milestoneIndex: 45863,\n  neighbors: 12,\n  time: 1469881493553,\n  tips: 18344,\n  transactionsToRequest: 0 \n}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]},"settings":"","url":"/"},"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- **`incomingPacketsBacklog`**: Backlog of transaction packets which have not been processed.\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- **`milestoneIndex`**: Latest milestone index of the coordinator. \n- **`time`**: Current UNIX timestamp.\n- **`tips`**: Number of tips in the network.\n- **`transactionsToRequest`**: Transactions to request during syncing process.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-02T11:58:27.093Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getnodeinfo","sync_unique":"","title":"getNodeInfo","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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. - **`incomingPacketsBacklog`**: Backlog of transaction packets which have not been processed. - **`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. - **`milestoneIndex`**: Latest milestone index of the coordinator. - **`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. - **`incomingPacketsBacklog`**: Backlog of transaction packets which have not been processed. - **`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. - **`milestoneIndex`**: Latest milestone index of the coordinator. - **`time`**: Current UNIX timestamp. - **`tips`**: Number of tips in the network. - **`transactionsToRequest`**: Transactions to request during syncing process.
{"__v":0,"_id":"57c7f4394434350e00509970","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getMilestone\", \"index\": 8059}'"},{"name":"NodeJS","language":"javascript","code":"var request = require('request');\n\nvar command = {\n    'command': 'getMilestone',\n    'transaction': 8059\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":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getMilestone',\n    'transaction': 8059\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"}]},"method":"post","params":[{"_id":"57c7f4394434350e00509972","ref":"","in":"body","required":true,"desc":"","default":"getMilestone","type":"string","name":"command"},{"_id":"57c7f4394434350e00509971","ref":"","in":"body","required":true,"desc":"Milestone index","default":"","type":"int","name":"index"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"milestone\": \"DIOPNRDXKY9DDKOKGOFDHCRISJBTTTNWUDEEUKGAJYKEJGDZMHHEYDAZTGXUGMAAFTOWN9KTKTOEY9999\", \n  \"duration\": 32\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Returns a milestone from a given index.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-09-01T09:26:17.546Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getmilestone","sync_unique":"","title":"getMilestone","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetMilestone


Body Params

command:
required
stringgetMilestone
index:
required
integer
Milestone index
Returns a milestone from a given index.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns a milestone from a given index.
{"__v":0,"_id":"57c75e18eba84d0e007d0074","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getPeers\"}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getPeers'\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': 'getPeers'\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","params":[{"_id":"577a21c0d051530e00f65556","ref":"","in":"body","required":true,"desc":"","default":"getNeighborsActivity","type":"string","name":"command"}],"results":{"codes":[{"status":200,"language":"json","code":"{ peers: \n   [ \n     { address: '/8.8.8.8:14265',\n       latestReceivedNewTransactionTimeDelta: 56323,\n       latestSentTransactionTimeDelta: '1629' },\n     { address: '/8.8.8.8:14265',\n       latestReceivedNewTransactionTimeDelta: null,\n       latestSentTransactionTimeDelta: '4285' },\n     { address: '/8.8.8.8:14265',\n       latestReceivedNewTransactionTimeDelta: null,\n       latestSentTransactionTimeDelta: '9821' \n     } \n  ] \n}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]},"settings":"","url":"/"},"body":"Get the latest activity information of your connected peers (neighbors).\n\n#### Return Values\n\n**`address`** : address of your peer \n**`latestReceivedNewTransactionTimeDelta`**: ms since latest packet received\n**`latestSentTransactionTimeDelta`**: ms since latest packet sent","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-02T12:03:50.844Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getneighborsactivity","sync_unique":"","title":"getPeers","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetPeers


Body Params

command:
required
stringgetNeighborsActivity
Get the latest activity information of your connected peers (neighbors). #### Return Values **`address`** : address of your peer **`latestReceivedNewTransactionTimeDelta`**: ms since latest packet received **`latestSentTransactionTimeDelta`**: ms since latest packet sent

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Get the latest activity information of your connected peers (neighbors). #### Return Values **`address`** : address of your peer **`latestReceivedNewTransactionTimeDelta`**: ms since latest packet received **`latestSentTransactionTimeDelta`**: ms since latest packet sent
{"__v":0,"_id":"57c75e18eba84d0e007d0078","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTips\"}'"},{"language":"python","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":"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","params":[{"_id":"577a2313aea88b0e00f632dd","ref":"","in":"body","required":true,"desc":"","default":"getTips","type":"string","name":"command"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  'hashes': [\n    'CMKUQMAFUVJBWFPMPZYIXMTFOPN9DGYICAUT9CJDDXRWZTVILKQWSOQMUSVOIDDYOXATRQHVGHJCY9999',\n    'MYCUEU9KFSV9VUKMKRSZEHEPXRRHWAZWPYZZ9JWBWCJUVSEDPKDPKZBVFPPRCEXOFFYSAUZGLBRNX9999',\n    'PLBLALOIPPRYDHKHMXUGOLIHJYIDZRQTVUEDCVRLGDQSHUCQWGNLTURBQQBKSWKPDLSTHJLJOOPCZ9999',\n    'MYH9OQVPVD9ZDWCQXSCIYM9KLMKFWQSCSRKXWUL9MOHOUYIMN9OLKMLXPTWYYXPM9VSIXYXPHKXR99999',\n    'XHUOHQZASLGPDJGKVTAIVGFUMZKCFUF9BHPVJPUHUNADTVJBVOBYCXXISWKNO9IJJYBER9GEQM9TA9999',\n    'E9QIKIIC9PEVI9HITYSCSMSXIRMMFAWUTP9BAHHKNHFKHBSATRIERVORWJSZRXLO9DGSALSNUPLEC9999' \n  ] \n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Get the list of latest tips (unconfirmed transactions).","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-04T08:49:23.141Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"gettips","sync_unique":"","title":"getTips","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetTips


Body Params

command:
required
stringgetTips
Get the list of latest tips (unconfirmed transactions).

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Get the list of latest tips (unconfirmed transactions).
{"__v":0,"_id":"57c75e18eba84d0e007d0079","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTransfers\", \"seed\": \"AAA999999999999999999999999999999999999999999999999999999999999999999999999999999\", \"securityLevel\": 1}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getTransfers',\n    'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n    'securityLevel': 1\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': 'getTransfers',\n  'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n  'securityLevel': 1\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","params":[{"_id":"577a26f6aea88b0e00f632e7","ref":"","in":"body","required":true,"desc":"","default":"getTransfers","type":"string","name":"command"},{"_id":"577a26f6aea88b0e00f632e6","ref":"","in":"body","required":true,"desc":"Seed of a specified account. Has to be 81-chars encoded.","default":"","type":"string","name":"seed"},{"_id":"577a26f6aea88b0e00f632e5","ref":"","in":"body","required":true,"desc":"SecurityLevel of your account and its transfers. A different securityLevel gives a different account. Can have values 0, 1 or 2 (from lowest to highest security).","default":"1","type":"int","name":"securityLevel"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  transfers: \n   [ \n     { hash: 'IYYQXMSLBRTOKWWRDALHUBLXM9PHSAEIXJJDNMWGYZJYZDQHCSSGEIKIHOFWBBBHDEKTQKGRYFRZY9999',\n       timestamp: '1468652572',\n       address: 'BDRZJZXZGMXI9YIMFAFFYLAQBFUKYDRJWK9QZC9KFAZLRSNDPTYAFFEHSLUEEUCNKYRVTCZJLTSNTRVU9',\n       value: '0',\n       persistence: 100 },\n     { hash: 'MAPBDNYBQRKRPLZMPJNNWYBTBWOJZVDXEYLDVBDVBRSECSUR9ZQCCFS9QBWFELGAFHRVBXIFMJXNA9999',\n       timestamp: '1468652839',\n       address: 'CLZOTFWXLSDRYJHNAELX9VVR99CTSAKVAFESBOXKPQJVAC9JRYJTCVFESINHBPQNOEFYBXYXMPSNLWX9C',\n       value: '10000',\n       persistence: 100 },\n     { hash: 'FZQSOFAK9TVQKAIHADLAODVRTQRDJXNREVMMEUTSIOJVYCNGV9SNQX9DBOHUJNYAZWLHHAJMLQFND9999',\n       timestamp: '1468656293',\n       address: 'GFNOYSUAK9INRGFBNHHMAXTRKAPQSJXJKTMCRY9HFC9NVMREEYSIMTXQKXLREWBBVIYHEXJD9SW9CKYPT',\n       value: '-5',\n       persistence: 0 \n     } \n   ] \n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Get the list of transfers from a specified seed (account). The securityLevel determines from which account you want to get the list of transfers, a different securityLevel brings up a different account. This API call does not return messages which were sent to this account. Use `findTransactions` for that.\n\n#### Return Values\n\nThe return value includes both, inbound and outbound transactions. **Persistence indicates if the transaction is confirmed or not.** The value field determines which type of transaction it is, as explained in the following table:\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Value\",\n    \"h-1\": \"Type of Transaction\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"negative\",\n    \"0-1\": \"Send transaction\",\n    \"0-2\": \"If the value is negative, it is a send/outbound transaction.\",\n    \"1-0\": \"positive\",\n    \"1-1\": \"Receive transaction\",\n    \"1-2\": \"If the value is above 0, then it is an incoming/receive transaction.\",\n    \"2-0\": \"zero\",\n    \"2-1\": \"Address generation\",\n    \"2-2\": \"If the value is zero, then it's a transaction which generated and assigned a new address to your account. In this case, the `address` field is the newly generated address.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-04T09:05:58.559Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"gettransfers","sync_unique":"","title":"getTransfers","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetTransfers


Body Params

command:
required
stringgetTransfers
seed:
required
string
Seed of a specified account. Has to be 81-chars encoded.
securityLevel:
required
integer1
SecurityLevel of your account and its transfers. A different securityLevel gives a different account. Can have values 0, 1 or 2 (from lowest to highest security).
Get the list of transfers from a specified seed (account). The securityLevel determines from which account you want to get the list of transfers, a different securityLevel brings up a different account. This API call does not return messages which were sent to this account. Use `findTransactions` for that. #### Return Values The return value includes both, inbound and outbound transactions. **Persistence indicates if the transaction is confirmed or not.** The value field determines which type of transaction it is, as explained in the following table: [block:parameters] { "data": { "h-0": "Value", "h-1": "Type of Transaction", "h-2": "Description", "0-0": "negative", "0-1": "Send transaction", "0-2": "If the value is negative, it is a send/outbound transaction.", "1-0": "positive", "1-1": "Receive transaction", "1-2": "If the value is above 0, then it is an incoming/receive transaction.", "2-0": "zero", "2-1": "Address generation", "2-2": "If the value is zero, then it's a transaction which generated and assigned a new address to your account. In this case, the `address` field is the newly generated address." }, "cols": 3, "rows": 3 } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Get the list of transfers from a specified seed (account). The securityLevel determines from which account you want to get the list of transfers, a different securityLevel brings up a different account. This API call does not return messages which were sent to this account. Use `findTransactions` for that. #### Return Values The return value includes both, inbound and outbound transactions. **Persistence indicates if the transaction is confirmed or not.** The value field determines which type of transaction it is, as explained in the following table: [block:parameters] { "data": { "h-0": "Value", "h-1": "Type of Transaction", "h-2": "Description", "0-0": "negative", "0-1": "Send transaction", "0-2": "If the value is negative, it is a send/outbound transaction.", "1-0": "positive", "1-1": "Receive transaction", "1-2": "If the value is above 0, then it is an incoming/receive transaction.", "2-0": "zero", "2-1": "Address generation", "2-2": "If the value is zero, then it's a transaction which generated and assigned a new address to your account. In this case, the `address` field is the newly generated address." }, "cols": 3, "rows": 3 } [/block]
{"__v":0,"_id":"57c75e18eba84d0e007d007a","api":{"auth":"required","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"},{"language":"javascript","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"}]},"method":"post","params":[{"_id":"577d46d7aa701f0e00382593","ref":"","in":"body","required":true,"desc":"","default":"findTransactions","type":"string","name":"command"},{"_id":"577d46d7aa701f0e00382592","ref":"","in":"body","required":false,"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":"577d46d7aa701f0e00382591","ref":"","in":"body","required":false,"desc":"List of addresses.","default":"","type":"array_string","name":"addresses"},{"_id":"577d46d7aa701f0e00382590","ref":"","in":"body","required":false,"desc":"List of hash digests.","default":"","type":"array_string","name":"digests"},{"_id":"577d46d7aa701f0e0038258f","ref":"","in":"body","required":false,"desc":"List of approvees of a transaction.","default":"","type":"array_string","name":"approvees"}],"results":{"codes":[{"status":200,"language":"json","code":"{ \n  hashes: [ \n    'ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999' \n  ] \n}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]},"settings":"","url":"/"},"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`, `digests` 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 need to be extended to 81chars by padding the hash with 9's.\n`addresses` | list | Optional | List of addresses.\n`digests` | list | Optional | List of message digests.\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- **`digests`**: returns the list of transactions which contain the specified digest value.\n- **`approvees`**: returns the list of transaction which reference (i.e. confirm) the specified transaction.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T17:58:47.726Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"findtransactions","sync_unique":"","title":"findTransactions","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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.
digests:
array of strings
List of hash digests.
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`, `digests` 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 need to be extended to 81chars by padding the hash with 9's. `addresses` | list | Optional | List of addresses. `digests` | list | Optional | List of message digests. `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. - **`digests`**: returns the list of transactions which contain the specified digest 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`, `digests` 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 need to be extended to 81chars by padding the hash with 9's. `addresses` | list | Optional | List of addresses. `digests` | list | Optional | List of message digests. `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. - **`digests`**: returns the list of transactions which contain the specified digest value. - **`approvees`**: returns the list of transaction which reference (i.e. confirm) the specified transaction.
{"__v":0,"_id":"57c7fec3690c200e0047b711","api":{"auth":"required","examples":{"codes":[{"language":"text","code":""},{"language":"text","code":""},{"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"}]},"method":"post","params":[{"_id":"57c7fec3690c200e0047b714","ref":"","in":"body","required":true,"desc":"","default":"getInclusionStates","type":"string","name":"command"},{"_id":"57c7fec3690c200e0047b713","ref":"","in":"body","required":true,"desc":"List of transactions you want to get the inclusion state for.","default":"","type":"array_string","name":"transactions"},{"_id":"57c7fec3690c200e0047b712","ref":"","in":"body","required":true,"desc":"List of tips (including milestones) you want to search through.","default":"","type":"array_string","name":"tips"}],"results":{"codes":[{"status":200,"language":"json","code":"{\"states\": [true], \"duration\": 91}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"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.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-09-01T10:11:15.115Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getinclusionstates","sync_unique":"","title":"getInclusionStates","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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 through.
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 }}

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.
{"__v":0,"_id":"57c75e18eba84d0e007d007b","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getBundle\", \"transaction\": \"ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999\"}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getBundle',\n    'transaction': 'ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999'\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': 'getBundle',\n    'transaction': 'ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999'\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json'\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","params":[{"_id":"577d4bf94841700e001417ee","ref":"","in":"body","required":true,"desc":"","default":"getBundle","type":"string","name":"command"},{"_id":"577d4bf94841700e001417ed","ref":"","in":"body","required":true,"desc":"Hash of a tail transaction.","default":"","type":"string","name":"transaction"}],"results":{"codes":[{"status":200,"language":"json","code":"{ transactions: \n   [ { hash: 'ZJVYUGTDRPDYFGFXMKOTV9ZWSGFK9CFPXTITQLQNLPPG9YNAARMKNKYQO9GSCSBIOTGMLJUFLZWSY9999',\n       type: 1,\n       signatureMessageChunk: 'SHORTENEDFORTUTORIAL',\n       digest: '999999999999999999999999999999999999999999999999999999999999999999999999999999999',\n       address: 'RVORZ9SIIP9RCYMREUIXXVPQIPHVCNPQ9HZWYKFWYWZRE9JQKG9REPKIASHUUECPSQO9JT9XNMVKWYGVA',\n       value: '5000',\n       timestamp: '1467664647',\n       index: '0',\n       bundle: 'NKZKEKWLDKMJCI9N9XQOLWEPAYW',\n       signatureNonce: '999999999999999999999999999',\n       approvalNonce: 'WD9NOXDAYTXABZOPSEI9XZSMRB9LGKQER9QAERTNSOUIFMQKPAQHECGVBJRMW9MSEMYFZOUZF9CDLGYOE',\n       approvedTrunkTransaction: 'VLVNRHJNYQIXNVJVTVJHDKPNPBECKYLGZYMDHPJLGWHYSFCFUOSCRQGBJUZSZRJVAYJAFDZOBQCJA9999',\n       approvedBranchTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' },\n     { hash: 'VLVNRHJNYQIXNVJVTVJHDKPNPBECKYLGZYMDHPJLGWHYSFCFUOSCRQGBJUZSZRJVAYJAFDZOBQCJA9999',\n       type: 1,\n       signatureMessageChunk: 'SHORTENEDFORTUTORIAL',\n       digest: '999999999999999999999999999999999999999999999999999999999999999999999999999999999',\n       address: 'LCWZDIQTDXIXIXYTJWJUZTIKIIUULLP9BB9MODWNUWWGNRSNCKUZPAFYYYANCGZDZQARIFUQOEXTQWMFR',\n       value: '1061291639544',\n       timestamp: '1467664647',\n       index: '1',\n       bundle: 'NKZKEKWLDKMJCI9N9XQOLWEPAYW',\n       signatureNonce: '999999999999999999999999999',\n       approvalNonce: 'OBPYOZAJAJJPYCXAYTGTECDTNMAYLQAJTPAGS9YCSQJVCZZEMQOADTPZRKIDXRPXKSOLTAPPER99KMSUZ',\n       approvedTrunkTransaction: 'UWPITSAOKBQYHADDZHSDNTIUNETKLKFBDMRWKLJXSUOUZEUPICAGJWISEEAVLHGLHUUMJYZBKQW9C9999',\n       approvedBranchTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' },\n     { hash: 'UWPITSAOKBQYHADDZHSDNTIUNETKLKFBDMRWKLJXSUOUZEUPICAGJWISEEAVLHGLHUUMJYZBKQW9C9999',\n       type: -1,\n       signatureMessageChunk: 'SHORTENEDFORTUTORIAL',\n       digest: '999999999999999999999999999999999999999999999999999999999999999999999999999999999',\n       address: 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n       value: '-1061291644544',\n       timestamp: '1467664647',\n       index: '2',\n       bundle: 'NKZKEKWLDKMJCI9N9XQOLWEPAYW',\n       signatureNonce: 'SH9999999999999999999999999',\n       approvalNonce: 'VCF9VJOIYNBVTZMLEVIIGYXZOJVHYCEHLOBLNMESIBCGQOSOWZCKFX9SOVPEDEWJYGITUVAVRYE9OPNOA',\n       approvedTrunkTransaction: 'OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999',\n       approvedBranchTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' },\n     { hash: 'OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999',\n       type: -1,\n       signatureMessageChunk: 'SHORTENEDFORTUTORIAL',\n       digest: '999999999999999999999999999999999999999999999999999999999999999999999999999999999',\n       address: 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n       value: '0',\n       timestamp: '1467664647',\n       index: '3',\n       bundle: 'NKZKEKWLDKMJCI9N9XQOLWEPAYW',\n       signatureNonce: 'SH9999999999999999999999999',\n       approvalNonce: 'KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXS',\n       approvedTrunkTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999',\n       approvedBranchTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' } ] }","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Get the list of transactions which were bundled with the specified tail transaction. This call returns the full value of all individual transactions, not just the hashes.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T18:20:41.105Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getbundle","sync_unique":"","title":"getBundle","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetBundle


Body Params

command:
required
stringgetBundle
transaction:
required
string
Hash of a tail transaction.
Get the list of transactions which were bundled with the specified tail transaction. This call returns the full value of all individual transactions, not just the hashes.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Get the list of transactions which were bundled with the specified tail transaction. This call returns the full value of all individual transactions, not just the hashes.
{"__v":0,"_id":"57c75e18eba84d0e007d007c","api":{"auth":"required","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","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 the raw data from.","default":"","type":"array_string","name":"hashes"}],"results":{"codes":[{"name":"","code":"{ \n  trytes: [ 'BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' \n          ] \n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/"},"body":"Returns the raw trytes data of a transaction.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T18:58:57.283Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"gettrytes","sync_unique":"","title":"getTrytes","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetTrytes


Body Params

command:
required
stringgetTrytes
hashes:
required
array of strings
List of transaction hashes of which you want to get the raw data from.
Returns the raw trytes data of a transaction.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns the raw trytes data of a transaction.
{"__v":0,"_id":"57c75e18eba84d0e007d007d","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"analyzeTransactions\", \"trytes\": [\"BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'analyzeTransactions',\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': 'analyzeTransactions',\n  'trytes': ['BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999']\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});"}]},"method":"post","params":[{"_id":"577d5954781f3e0e005fb871","ref":"","in":"body","required":true,"desc":"","default":"analyzeTransactions","type":"string","name":"command"},{"_id":"577d5954781f3e0e005fb870","ref":"","in":"body","required":true,"desc":"Raw transaction data of a transaction.","default":"","type":"array_string","name":"trytes"}],"results":{"codes":[{"status":200,"language":"json","code":"{ transactions: \n   [ { hash: 'OAATQS9VQLSXCLDJVJJVYUGONXAXOFMJOZNSYWRZSWECMXAQQURHQBJNLD9IOFEPGZEPEMPXCIVRX9999',\n       type: -1,\n       signatureMessageChunk: 'BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK',\n       digest: '999999999999999999999999999999999999999999999999999999999999999999999999999999999',\n       address: 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n       value: '0',\n       timestamp: '1467664647',\n       index: '3',\n       bundle: 'NKZKEKWLDKMJCI9N9XQOLWEPAYW',\n       signatureNonce: 'SH9999999999999999999999999',\n       approvalNonce: 'KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXS',\n       approvedTrunkTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999',\n       approvedBranchTransaction: 'IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999' \n     } \n   ] \n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Analyze a raw transaction by its trytes and return the full transaction object.\n\n#### Return Values\n\n- **`hash`**: Transaction hash.\n- **`type`**:  The type of transaction (-1 is spend, 1 is receive). \n- **`signatureMessageChunk`**: Signature used for signing the transaction. If no signature was required for signing the transaction (e.g. a simple message), then it will contain the message value. \n- **`digest`**: Hash digest of the transaction. \n- **`address`**: Address of the recipient of this transaction.\n- **`value`**: Value transferred. \n- **`bundle`**: Bundle hash. \n- **`signatureNonce`**: None used for generating the signature.\n- **`approvalNonce`**:\n- **`approvedTrunkTransaction`**: Trunk transaction which was referenced by this transaction.\n- **`approvedBranchTransaction`**:  Branch transaction which was referenced by this transaction.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T19:17:40.181Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"analyzetransactions","sync_unique":"","title":"analyzeTransactions","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postanalyzeTransactions


Body Params

command:
required
stringanalyzeTransactions
trytes:
required
array of strings
Raw transaction data of a transaction.
Analyze a raw transaction by its trytes and return the full transaction object. #### Return Values - **`hash`**: Transaction hash. - **`type`**: The type of transaction (-1 is spend, 1 is receive). - **`signatureMessageChunk`**: Signature used for signing the transaction. If no signature was required for signing the transaction (e.g. a simple message), then it will contain the message value. - **`digest`**: Hash digest of the transaction. - **`address`**: Address of the recipient of this transaction. - **`value`**: Value transferred. - **`bundle`**: Bundle hash. - **`signatureNonce`**: None used for generating the signature. - **`approvalNonce`**: - **`approvedTrunkTransaction`**: Trunk transaction which was referenced by this transaction. - **`approvedBranchTransaction`**: Branch transaction which was referenced by this transaction.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Analyze a raw transaction by its trytes and return the full transaction object. #### Return Values - **`hash`**: Transaction hash. - **`type`**: The type of transaction (-1 is spend, 1 is receive). - **`signatureMessageChunk`**: Signature used for signing the transaction. If no signature was required for signing the transaction (e.g. a simple message), then it will contain the message value. - **`digest`**: Hash digest of the transaction. - **`address`**: Address of the recipient of this transaction. - **`value`**: Value transferred. - **`bundle`**: Bundle hash. - **`signatureNonce`**: None used for generating the signature. - **`approvalNonce`**: - **`approvedTrunkTransaction`**: Trunk transaction which was referenced by this transaction. - **`approvedBranchTransaction`**: Branch transaction which was referenced by this transaction.
{"__v":0,"_id":"57c75e18eba84d0e007d007e","api":{"auth":"required","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getNewAddress\", \"seed\": \"AAA999999999999999999999999999999999999999999999999999999999999999999999999999999\", \"securityLevel\": 1}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getNewAddress',\n    'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n    'securityLevel': 1\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': 'getNewAddress',\n  'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n  'securityLevel': 1\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","params":[{"_id":"579cf48010a40b0e000c7bea","ref":"","in":"body","required":true,"desc":"","default":"getNewAddress","type":"string","name":"command"},{"_id":"579cf48010a40b0e000c7be9","ref":"","in":"body","required":true,"desc":"Seed for which you want to generate a new address.","default":"","type":"string","name":"seed"},{"_id":"579cf48010a40b0e000c7be8","ref":"","in":"body","required":true,"desc":"Security Level of your account.","default":"","type":"int","name":"securityLevel"}],"results":{"codes":[{"name":"","code":"{ \n  address: 'KIXDAIGV9GH99ZKJNUHIWCVSBSQBZOYUCRUDL9YYTTCWPYCDEQHWECYFBPKOCICUFVEJBDQUKAOMXUFSB' \n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/"},"body":"Generates a new address for your specified account (seed + securityLevel). The generation of the address itself is done deterministically, this means that you have to attach the newly generated address to the Tangle in order to get a new address. Else repeatedly calling `getNewAddress` will always generate the same address. \n\nIn order to attach the address to the tangle, all you have to do is send a transaction to the address: this can either be a transaction with value set to zero and an empty message (least amount of Proof of Work required), or a value transfer.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-30T18:40:00.691Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"getnewaddress","sync_unique":"","title":"getNewAddress","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetNewAddress


Body Params

command:
required
stringgetNewAddress
seed:
required
string
Seed for which you want to generate a new address.
securityLevel:
required
integer
Security Level of your account.
Generates a new address for your specified account (seed + securityLevel). The generation of the address itself is done deterministically, this means that you have to attach the newly generated address to the Tangle in order to get a new address. Else repeatedly calling `getNewAddress` will always generate the same address. In order to attach the address to the tangle, all you have to do is send a transaction to the address: this can either be a transaction with value set to zero and an empty message (least amount of Proof of Work required), or a value transfer.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Generates a new address for your specified account (seed + securityLevel). The generation of the address itself is done deterministically, this means that you have to attach the newly generated address to the Tangle in order to get a new address. Else repeatedly calling `getNewAddress` will always generate the same address. In order to attach the address to the tangle, all you have to do is send a transaction to the address: this can either be a transaction with value set to zero and an empty message (least amount of Proof of Work required), or a value transfer.
{"__v":0,"_id":"57c75e18eba84d0e007d007f","api":{"auth":"required","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"prepareTransfers\", \"seed\": \"AAA999999999999999999999999999999999999999999999999999999999999999999999999999999\", \"securityLevel\": 1, \"transfers\": [{\"address\": \"NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB\", \"value\": \"1\", \"message\": \"\"}, {\"address\": \"NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB\", \"value\": \"0\", \"message\": \"SECRETMESSAGE\"}]}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'prepareTransfers',\n    'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n    'securityLevel': 1,\n    'transfers': [\n        {\n            'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n            'value': '1',\n            'message': ''\n        }, {\n            'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n            'value': '0',\n            'message': 'SECRETMESSAGE'\n        }\n    ]\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': 'prepareTransfers',\n  'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n  'securityLevel': 1,\n  'transfers': [\n      {\n          'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n          'value': '1',\n          'message': ''\n      }, {\n          'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n          'value': '0',\n          'message': 'SECRETMESSAGE'\n      }\n  ]\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","params":[{"_id":"579d002afefb1d0e00c94f27","ref":"","in":"body","required":true,"desc":"","default":"prepareTransfers","type":"string","name":"command"},{"_id":"579d002afefb1d0e00c94f26","ref":"","in":"body","required":true,"desc":"Seed from which you want to send transactions from.","default":"","type":"string","name":"seed"},{"_id":"579d002afefb1d0e00c94f25","ref":"","in":"body","required":true,"desc":"Security Level of your account.","default":"","type":"int","name":"securityLevel"},{"_id":"579d002afefb1d0e00c94f24","ref":"","in":"body","required":true,"desc":"List of objects containing value, address and message fields. Each new entry is a new transaction.","default":"","type":"array_object","name":"transfers"}],"results":{"codes":[{"name":"","code":"{\n  trytes: \n   [ 'TRYTEVALUESHERE1', 'TRYTEVALUESHERE2' ] \n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/"},"body":"Prepares the trytes (raw transaction data) for a list of transfers for a specified account. Each element in the `transfers` list needs to conform to the standard schema of a transaction. This means that the maximum `value` per transfer is `3812798742493` and the `message` field needs to be properly encoded into trytes.\n\nEach transaction will output a new tryte value. These values can then be input into `attachToTangle`.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-30T19:29:46.905Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":11,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"preparetransfers","sync_unique":"","title":"prepareTransfers","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postprepareTransfers


Body Params

command:
required
stringprepareTransfers
seed:
required
string
Seed from which you want to send transactions from.
securityLevel:
required
integer
Security Level of your account.
transfers:
required
array of objects
List of objects containing value, address and message fields. Each new entry is a new transaction.
Prepares the trytes (raw transaction data) for a list of transfers for a specified account. Each element in the `transfers` list needs to conform to the standard schema of a transaction. This means that the maximum `value` per transfer is `3812798742493` and the `message` field needs to be properly encoded into trytes. Each transaction will output a new tryte value. These values can then be input into `attachToTangle`.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Prepares the trytes (raw transaction data) for a list of transfers for a specified account. Each element in the `transfers` list needs to conform to the standard schema of a transaction. This means that the maximum `value` per transfer is `3812798742493` and the `message` field needs to be properly encoded into trytes. Each transaction will output a new tryte value. These values can then be input into `attachToTangle`.
{"__v":0,"_id":"57c75e18eba84d0e007d0080","api":{"auth":"required","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"getTransactionsToApprove\", \"milestone\": \"SMYMAKKPSUKCKDRUEYCGZJTYCZ9HHDMDUWBAPXARGURPQRHTAJDASRWMIDTPTBNDKDEFBUTBGGAFX9999\"}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'getTransactionsToApprove',\n    'milestone': 'SMYMAKKPSUKCKDRUEYCGZJTYCZ9HHDMDUWBAPXARGURPQRHTAJDASRWMIDTPTBNDKDEFBUTBGGAFX9999'\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  'milestone': 'SMYMAKKPSUKCKDRUEYCGZJTYCZ9HHDMDUWBAPXARGURPQRHTAJDASRWMIDTPTBNDKDEFBUTBGGAFX9999'\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","params":[{"_id":"579d14f710a40b0e000c7bf8","ref":"","in":"body","required":true,"desc":"","default":"getTransactionsToApprove","type":"string","name":"command"},{"_id":"579d14f710a40b0e000c7bf7","ref":"","in":"body","required":true,"desc":"Latest coordinator milestone","default":"","type":"string","name":"milestone"}],"results":{"codes":[{"name":"","code":"{\n  \"trunkTransaction\": \"JVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999\", \"branchTransaction\": \"P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/"},"body":"Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is the latest coordinator `milestone`, as provided through the `getNodeInfo` API call.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-30T20:58:31.665Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":12,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"gettransactionstoapprove","sync_unique":"","title":"getTransactionsToApprove","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postgetTransactionsToApprove


Body Params

command:
required
stringgetTransactionsToApprove
milestone:
required
string
Latest coordinator milestone
Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is the latest coordinator `milestone`, as provided through the `getNodeInfo` API call.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Tip selection which returns `trunkTransaction` and `branchTransaction`. The input value is the latest coordinator `milestone`, as provided through the `getNodeInfo` API call.
{"__v":0,"_id":"57c75e18eba84d0e007d0081","api":{"auth":"required","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\": 13, \"trytes\": [\"TRYTVALUEHERE\"]}'\n","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'attachToTangle',\n    'trunkTransaction': 'JVMTDGDPDFYHMZPMWEKKANBQSLSDTIIHAYQUMZOKHXXXGJHJDQPOMDOMNRDKYCZRUFZROZDADTHZC9999', \n    'branchTransaction': 'P9KFSJVGSPLXAEBJSHWFZLGP9GGJTIO9YITDEHATDTGAFLPLBZ9FOFWWTKMAZXZHFGQHUOXLXUALY9999',\n    'minWeightMagnitude': 13,\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': 13,\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","params":[{"_id":"579d227be781c719001a7bd9","ref":"","in":"body","required":true,"desc":"","default":"attachToTangle","type":"string","name":"command"},{"_id":"579d227be781c719001a7bd8","default":"","desc":"Trunk transaction to approve.","in":"body","name":"trunkTransaction","ref":"","required":true,"type":"string"},{"_id":"579d227be781c719001a7bd7","default":"","desc":"Branch transaction to approve.","in":"body","name":"branchTransaction","ref":"","required":true,"type":"string"},{"_id":"579d227be781c719001a7bd6","ref":"","in":"body","required":true,"desc":"Proof of Work intensity. Currently only value 13 is valid.","default":"13","type":"int","name":"minWeightMagnitude"},{"_id":"579d227be781c719001a7bd5","ref":"","in":"body","required":true,"desc":"List of trytes (raw transactions) to attach to the tangle.","default":"","type":"array_string","name":"trytes"}],"results":{"codes":[{"name":"","code":"{'trytes':['TRYTEVALUEHERE']}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/"},"body":"Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply `branchTransactionToApprove` as well as `trunkTransactionToApprove` (basically the tips which you're going to 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 `pushTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `signatureNonce` + `trunkTransaction` + `branchTransaction`. These are valid trytes which you can then accepted by the network.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-30T21:56:11.692Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":13,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"attachtotangle","sync_unique":"","title":"attachToTangle","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postattachToTangle


Body Params

command:
required
stringattachToTangle
trunkTransaction:
required
string
Trunk transaction to approve.
branchTransaction:
required
string
Branch transaction to approve.
minWeightMagnitude:
required
integer13
Proof of Work intensity. Currently only value 13 is valid.
trytes:
required
array of strings
List of trytes (raw transactions) to attach to the tangle.
Attaches the specified transactions (trytes) to the Tangle by doing Proof of Work. You need to supply `branchTransactionToApprove` as well as `trunkTransactionToApprove` (basically the tips which you're going to 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 `pushTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `signatureNonce` + `trunkTransaction` + `branchTransaction`. These are valid trytes which you can 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 `branchTransactionToApprove` as well as `trunkTransactionToApprove` (basically the tips which you're going to 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 `pushTransactions` and `storeTransactions`. The returned tryte value, the last 243 trytes basically consist of the: `signatureNonce` + `trunkTransaction` + `branchTransaction`. These are valid trytes which you can then accepted by the network.
{"__v":0,"_id":"57c7fef3690c200e0047b715","api":{"auth":"required","examples":{"codes":[]},"method":"post","params":[{"_id":"57c7fef3690c200e0047b716","ref":"","in":"body","required":true,"desc":"","default":"interruptAttachingToTangle","type":"string","name":"command"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Interrupts and completely aborts the `attachToTangle` process.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-09-01T10:12:03.747Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":14,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"interruptattachingtotangle","sync_unique":"","title":"interruptAttachingToTangle","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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.
{"__v":0,"_id":"57c75e18eba84d0e007d0082","api":{"auth":"required","examples":{"codes":[{"code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"pushTransactions\", \"trytes\": [\"BYSWEAUTWXHXZ9YBZISEK9LUHWGMHXCGEVNZHRLUWQFCUSDXZHOFHWHL9MQPVJXXZLIXPXPXF9KYEREFSKCPKYIIKPZVLHUTDFQKKVVBBN9ATTLPCNPJDWDEVIYYLGPZGCWXOBDXMLJC9VO9QXTTBLAXTTBFUAROYEGQIVB9MJWJKXJMCUPTWAUGFZBTZCSJVRBGMYXTVBDDS9MYUJCPZ9YDWWQNIPUAIJXXSNLKUBSCOIJPCLEFPOXFJREXQCUVUMKSDOVQGGHRNILCO9GNCLWFM9APMNMWYASHXQAYBEXF9QRIHIBHYEJOYHRQJAOKAQ9AJJFQ9WEIWIJOTZATIBOXQLBMIJU9PCGBLVDDVFP9CFFSXTDUXMEGOOFXWRTLFGV9XXMYWEMGQEEEDBTIJ9OJOXFAPFQXCDAXOUDMLVYRMRLUDBETOLRJQAEDDLNVIRQJUBZBO9CCFDHIX9MSQCWYAXJVWHCUPTRSXJDESISQPRKZAFKFRULCGVRSBLVFOPEYLEE99JD9SEBALQINPDAZHFAB9RNBH9AZWIJOTLBZVIEJIAYGMC9AZGNFWGRSWAXTYSXVROVNKCOQQIWGPNQZKHUNODGYADPYLZZZUQRTJRTODOUKAOITNOMWNGHJBBA99QUMBHRENGBHTH9KHUAOXBVIVDVYYZMSEYSJWIOGGXZVRGN999EEGQMCOYVJQRIRROMPCQBLDYIGQO9AMORPYFSSUGACOJXGAQSPDY9YWRRPESNXXBDQ9OZOXVIOMLGTSWAMKMTDRSPGJKGBXQIVNRJRFRYEZ9VJDLHIKPSKMYC9YEGHFDS9SGVDHRIXBEMLFIINOHVPXIFAZCJKBHVMQZEVWCOSNWQRDYWVAIBLSCBGESJUIBWZECPUCAYAWMTQKRMCHONIPKJYYTEGZCJYCT9ABRWTJLRQXKMWY9GWZMHYZNWPXULNZAPVQLPMYQZCYNEPOCGOHBJUZLZDPIXVHLDMQYJUUBEDXXPXFLNRGIPWBRNQQZJSGSJTTYHIGGFAWJVXWL9THTPWOOHTNQWCNYOYZXALHAZXVMIZE9WMQUDCHDJMIBWKTYH9AC9AFOT9DPCADCV9ZWUTE9QNOMSZPTZDJLJZCJGHXUNBJFUBJWQUEZDMHXGBPTNSPZBR9TGSKVOHMOQSWPGFLSWNESFKSAZY9HHERAXALZCABFYPOVLAHMIHVDBGKUMDXC9WHHTIRYHZVWNXSVQUWCR9M9RAGMFEZZKZ9XEOQGOSLFQCHHOKLDSA9QCMDGCGMRYJZLBVIFOLBIJPROKMHOYTBTJIWUZWJMCTKCJKKTR9LCVYPVJI9AHGI9JOWMIWZAGMLDFJA9WU9QAMEFGABIBEZNNAL9OXSBFLOEHKDGHWFQSHMPLYFCNXAAZYJLMQDEYRGL9QKCEUEJ9LLVUOINVSZZQHCIKPAGMT9CAYIIMTTBCPKWTYHOJIIY9GYNPAJNUJ9BKYYXSV9JSPEXYMCFAIKTGNRSQGUNIYZCRT9FOWENSZQPD9ALUPYYAVICHVYELYFPUYDTWUSWNIYFXPX9MICCCOOZIWRNJIDALWGWRATGLJXNAYTNIZWQ9YTVDBOFZRKO9CFWRPAQQRXTPACOWCPRLYRYSJARRKSQPR9TCFXDVIXLP9XVL99ERRDSOHBFJDJQQGGGCZNDQ9NYCTQJWVZIAELCRBJJFDMCNZU9FIZRPGNURTXOCDSQGXTQHKHUECGWFUUYS9J9NYQ9U9P9UUP9YMZHWWWCIASCFLCMSKTELZWUGCDE9YOKVOVKTAYPHDF9ZCCQAYPJIJNGSHUIHHCOSSOOBUDOKE9CJZGYSSGNCQJVBEFTZFJ9SQUHOASKRRGBSHWKBCBWBTJHOGQ9WOMQFHWJVEG9NYX9KWBTCAIXNXHEBDIOFO9ALYMFGRICLCKKLG9FOBOX9PDWNQRGHBKHGKKRLWTBEQMCWQRLHAVYYZDIIPKVQTHYTWQMTOACXZOQCDTJTBAAUWXSGJF9PNQIJ9AJRUMUVCPWYVYVARKR9RKGOUHHNKNVGGPDDLGKPQNOYHNKAVVKCXWXOQPZNSLATUJT9AUWRMPPSWHSTTYDFAQDXOCYTZHOYYGAIM9CELMZ9AZPWB9MJXGHOKDNNSZVUDAGXTJJSSZCPZVPZBYNNTUQABSXQWZCHDQSLGK9UOHCFKBIBNETK999999999999999999999999999999999999999999999999999999999999999999999999999999999NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB999999999XKBRHUD99C99999999NKZKEKWLDKMJCI9N9XQOLWEPAYWSH9999999999999999999999999KDDTGZLIPBNZKMLTOLOXQVNGLASESDQVPTXALEKRMIOHQLUHD9ELQDBQETS9QFGTYOYWLNTSKKMVJAUXSIROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999IROUICDOXKSYZTDPEDKOQENTJOWJONDEWROCEJIEWFWLUAACVSJFTMCHHXJBJRKAAPUDXXVXFWP9X9999\"]}'","language":"curl"},{"code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'pushTransactions',\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': 'pushTransactions',\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","params":[{"_id":"577d66b647a9ab0e003dfed2","ref":"","in":"body","required":true,"desc":"","default":"broadcastTransactions","type":"string","name":"command"},{"_id":"577d66b647a9ab0e003dfed1","ref":"","in":"body","required":true,"desc":"List of raw data of transactions to be rebroadcast.","default":"","type":"array_string","name":"trytes"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Broadcast a list of transactions to all neighbors. The input trytes for this call are provided by `attachToTangle`.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T20:14:46.483Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":15,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"broadcasttransactions","sync_unique":"","title":"pushTransactions","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postpushTransactions


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`.
{"__v":0,"_id":"57c75e18eba84d0e007d0083","api":{"auth":"required","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","params":[{"_id":"577d66b647a9ab0e003dfed2","ref":"","in":"body","required":true,"desc":"","default":"broadcastTransactions","type":"string","name":"command"},{"_id":"577d66b647a9ab0e003dfed1","ref":"","in":"body","required":true,"desc":"List of raw data of transactions to be rebroadcast.","default":"","type":"array_string","name":"trytes"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"Store transactions into the local storage. The trytes to be used for this call are returned by `attachToTangle`.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-30T22:00:30.291Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":17,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"storetransactions","sync_unique":"","title":"storeTransactions","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","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`.
{"__v":0,"_id":"57c75e18eba84d0e007d0084","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"transfer\", \"seed\": \"AAA999999999999999999999999999999999999999999999999999999999999999999999999999999\", \"address\": \"NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB\", \"value\": \"1\" \"message\": \"\", \"securityLevel\": 1, \"minWeightMagnitude\": 13}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'transfer',\n    'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n    'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n    'value': '1',\n    'message': '',\n    'securityLevel': 1,\n    'minWeightMagnitude': 13\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': 'transfer',\n  'seed': 'AAA999999999999999999999999999999999999999999999999999999999999999999999999999999',\n  'address': 'NOXDXXKUDWLOFJLIPQIBRBMGDYCPGDNLQOLQS99EQYKBIU9VHCJVIPFUYCQDNY9APGEVYLCENJIOBLWNB',\n  'value': '1',\n  'message': '',\n  'securityLevel': 1,\n  'minWeightMagnitude': 13\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json'\n  },\n  json: command\n};\n\nrequest(options, function (error, response, data) {\n  if (!error && response.statusCode == 200) {\n    console.log(data);\n  }\n});"}]},"method":"post","params":[{"_id":"577d61bb47a9ab0e003dfebb","ref":"","in":"body","required":true,"desc":"","default":"transfer","type":"string","name":"command"},{"_id":"577d61bb47a9ab0e003dfeba","ref":"","in":"body","required":true,"desc":"Seed from which the transfer will be made and the specified value subtracted.","default":"","type":"string","name":"seed"},{"_id":"577d61bb47a9ab0e003dfeb9","ref":"","in":"body","required":true,"desc":"Recipient's address.","default":"","type":"string","name":"address"},{"_id":"577d61bb47a9ab0e003dfeb8","ref":"","in":"body","required":true,"desc":"The value to be sent. The maximum value to be sent is 3812798742493.","default":"","type":"string","name":"value"},{"_id":"577d61bb47a9ab0e003dfeb7","ref":"","in":"body","required":true,"desc":"Message value which will be added to the transaction. Can be left empty. If you add a message value, make sure to encode it.","default":"","type":"string","name":"message"},{"_id":"577d61bb47a9ab0e003dfeb6","ref":"","in":"body","required":true,"desc":"The security level of the transaction.","default":"1","type":"int","name":"securityLevel"},{"_id":"577d61bb47a9ab0e003dfeb5","ref":"","in":"body","required":true,"desc":"Weight of PoW. Default value is 13.","default":"13","type":"int","name":"minWeightMagnitude"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"tail\":\"BXMNQGX9FGRCWDYNGBNKOBVRZKHWNDZQSX9OVWMVRMMJIGLMBEIMZIMEKDZBFIPBYALKOQHAUZM9Z9999\",\n   \"neighbors\":7\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/"},"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"This API command will be removed soon\",\n  \"title\": \"Soon Removed\"\n}\n[/block]\nMakes an IOTA transfer. If the message field is non-empty and value is 0, the transfer becomes a simple message transfer. You can send send both a value transfer with accompanying data in the message field. The message value is publicly visible, so do not send any sensitive data through it. The max value is `2187 trytes`, which is 6561 trits (or roughly 1312 bytes) per transaction. This means that if your message value is longer than 2187 trytes, it will be automatically added in a second transaction.\n\nThe returned value is the `tail`, which is the transaction hash of the transaction with index 0 in the bundle of the executed transfer.\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Max Value\",\n  \"body\": \"The maximum value which you can transfer in a single transfer is `3812798742493`.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you want to send data via the message field, make sure that you encode it into Trytes.\",\n  \"title\": \"FOR MESSAGES\"\n}\n[/block]","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T19:53:31.208Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":18,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"transfer","sync_unique":"","title":"transfer","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

posttransfer


Body Params

command:
required
stringtransfer
seed:
required
string
Seed from which the transfer will be made and the specified value subtracted.
address:
required
string
Recipient's address.
value:
required
string
The value to be sent. The maximum value to be sent is 3812798742493.
message:
required
string
Message value which will be added to the transaction. Can be left empty. If you add a message value, make sure to encode it.
securityLevel:
required
integer1
The security level of the transaction.
minWeightMagnitude:
required
integer13
Weight of PoW. Default value is 13.
[block:callout] { "type": "danger", "body": "This API command will be removed soon", "title": "Soon Removed" } [/block] Makes an IOTA transfer. If the message field is non-empty and value is 0, the transfer becomes a simple message transfer. You can send send both a value transfer with accompanying data in the message field. The message value is publicly visible, so do not send any sensitive data through it. The max value is `2187 trytes`, which is 6561 trits (or roughly 1312 bytes) per transaction. This means that if your message value is longer than 2187 trytes, it will be automatically added in a second transaction. The returned value is the `tail`, which is the transaction hash of the transaction with index 0 in the bundle of the executed transfer. [block:callout] { "type": "danger", "title": "Max Value", "body": "The maximum value which you can transfer in a single transfer is `3812798742493`." } [/block] [block:callout] { "type": "info", "body": "If you want to send data via the message field, make sure that you encode it into Trytes.", "title": "FOR MESSAGES" } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "danger", "body": "This API command will be removed soon", "title": "Soon Removed" } [/block] Makes an IOTA transfer. If the message field is non-empty and value is 0, the transfer becomes a simple message transfer. You can send send both a value transfer with accompanying data in the message field. The message value is publicly visible, so do not send any sensitive data through it. The max value is `2187 trytes`, which is 6561 trits (or roughly 1312 bytes) per transaction. This means that if your message value is longer than 2187 trytes, it will be automatically added in a second transaction. The returned value is the `tail`, which is the transaction hash of the transaction with index 0 in the bundle of the executed transfer. [block:callout] { "type": "danger", "title": "Max Value", "body": "The maximum value which you can transfer in a single transfer is `3812798742493`." } [/block] [block:callout] { "type": "info", "body": "If you want to send data via the message field, make sure that you encode it into Trytes.", "title": "FOR MESSAGES" } [/block]
{"__v":0,"_id":"57c75e18eba84d0e007d0085","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"replayTransfer\", \"transaction\": \"BXMNQGX9FGRCWDYNGBNKOBVRZKHWNDZQSX9OVWMVRMMJIGLMBEIMZIMEKDZBFIPBYALKOQHAUZM9Z9999\"}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'replayTransfer',\n    'transaction': 'BXMNQGX9FGRCWDYNGBNKOBVRZKHWNDZQSX9OVWMVRMMJIGLMBEIMZIMEKDZBFIPBYALKOQHAUZM9Z9999'\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': 'replayTransfer',\n  'transaction': 'BXMNQGX9FGRCWDYNGBNKOBVRZKHWNDZQSX9OVWMVRMMJIGLMBEIMZIMEKDZBFIPBYALKOQHAUZM9Z9999'\n}\n\nvar options = {\n  url: 'http://localhost:14265',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/json'\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"}]},"method":"post","params":[{"_id":"577d63ba6172c720001283c4","ref":"","in":"body","required":true,"desc":"","default":"replayTransfer","type":"string","name":"command"},{"_id":"577d63ba6172c720001283c3","ref":"","in":"body","required":true,"desc":"Hash of the transaction to be replayed.","default":"","type":"string","name":"transaction"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"neighbors\":7\n}","name":""},{"status":400,"language":"json","code":"{\n\t\"error\":\"The transfer is not replayable.\"\n}","name":""}]},"settings":"","url":"/"},"body":"Replay a previous transfer. Reason for doing this is either because your neighbors have not broadcast your transactions or because your transactions are left unconfirmed after a certain period of time (reason for that could be because you validated a subtangle with invalid transactions, thus your transfer will not be validated by other nodes).\n\nReplaying a transfer will completely redo the Proof of Work and newly position it in the Tangle.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-07-06T20:02:02.498Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":19,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"replaytransfer","sync_unique":"","title":"replayTransfer","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postreplayTransfer


Body Params

command:
required
stringreplayTransfer
transaction:
required
string
Hash of the transaction to be replayed.
Replay a previous transfer. Reason for doing this is either because your neighbors have not broadcast your transactions or because your transactions are left unconfirmed after a certain period of time (reason for that could be because you validated a subtangle with invalid transactions, thus your transfer will not be validated by other nodes). Replaying a transfer will completely redo the Proof of Work and newly position it in the Tangle.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Replay a previous transfer. Reason for doing this is either because your neighbors have not broadcast your transactions or because your transactions are left unconfirmed after a certain period of time (reason for that could be because you validated a subtangle with invalid transactions, thus your transfer will not be validated by other nodes). Replaying a transfer will completely redo the Proof of Work and newly position it in the Tangle.
{"__v":0,"_id":"57c7ffd05754fa1700b12212","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"curl http://localhost:14265 \\\n  -X POST \\\n  -H 'Content-Type: application/json' \\\n  -d '{\"command\": \"pullTransactions\", \"hashes\": [\"RVORZ9SIIP9RCYMREUIXXVPQIPHVCNPQ9HZWYKFWYWZRE9JQKG9REPKIASHUUECPSQO9JT9XNMVKWYGVAZETAIRPTM\"]}'"},{"language":"python","code":"import urllib2\nimport json\n\ncommand = {\n    'command': 'pullTransactions',\n    'hashes': ['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"},{"language":"javascript","code":"var request = require('request');\n\nvar command = {\n  'command': 'pullTransactions',\n  'hashes': ['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"}]},"method":"post","params":[{"_id":"577d46d7aa701f0e00382593","ref":"","in":"body","required":true,"desc":"","default":"pullTransactions","type":"string","name":"command"},{"_id":"577d46d7aa701f0e00382592","ref":"","in":"body","required":true,"desc":"List of hashes to request","default":"","type":"array_string","name":"hashes"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{\"error\": \"'command' parameter has not been specified\"}","name":""}]},"settings":"","url":"/"},"body":"Request a set of transactions from your neighbors. This API call does not return anything, but if a neighbor has the transaction locally they will send it to you.","category":"57c75e17eba84d0e007d0067","createdAt":"2016-09-01T10:15:44.375Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":999,"parentDoc":null,"project":"573f1056804f901700a9e07b","slug":"pulltransactions","sync_unique":"","title":"pullTransactions","type":"post","updates":[],"user":"573f104a176bea2b000e9699","version":"57c75e17eba84d0e007d0063","childrenPages":[]}

postpullTransactions


Body Params

command:
required
stringpullTransactions
hashes:
required
array of strings
List of hashes to request
Request a set of transactions from your neighbors. This API call does not return anything, but if a neighbor has the transaction locally they will send it to you.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Request a set of transactions from your neighbors. This API call does not return anything, but if a neighbor has the transaction locally they will send it to you.