Skip to main content

This library has been deprecated and will no longer be updated. Please consider using the IOTA SDK, that will have the latest features and security updates.

Version: 2.0.1-rc.7


IOTA Client Library Overview

The library is designed to simplify how you connect and interact with nodes in the IOTA network. You can use it to generate addresses, send messages, sign and send transactions, and more.

Beyond establishing the initial connection to a node, has no state. Operations use only the data you pass during a call and have no effect on your software beyond returning a value. You are in complete control of the data flow in your application.

This stateless approach makes easy to use and understand. But since you are in full control of data management, you are also fully responsible for it, which could feel overwhelming if you handle complex or sensitive data. If you plan on managing funds in your application, take a look at our library instead.

Supported Languages

We implemented the library in Rust and prepared bindings for JavaScript, Python, and Java. Every binding is adjusted for the language's conventions and best practices. For example, Python developers avoid the Builder programming pattern, so our Python binding uses named constructor arguments. However, we never change the meaning behind our API, which is equally powerful no matter which language you choose.

Your Application In the IOTA Network

Your application communicates with either directly in Rust or through one of the language bindings. The library turns your requests into REST API calls and sends them to a node through the Internet. The node, in turn, interacts with the rest of an IOTA network, which could be the main operational network (mainnet) or a network for testing purposes (devnet).

Different nodes can run on different software, but they always expose the same interface to clients. For example, one node could be a Hornet node, and the other could be a different implementation of the core REST API, and they both would appear the same for any client.

A diagram that illustrates the text above. It has three layers: the application layer that includes and its bindings, communication layer (the Internet network), and IOTA network layer with nodes that operate on one of the IOTA networks.

API Design

The library exposes operations of two types. Clients interact with nodes by calling their REST API, and the first group of operations mirrors the available calls. When your program invokes such an operation, it directly translates it into a REST call to a node. See the node's REST API reference for a complete list of available endpoints.

Operations from the first group tend to be too atomic and basic to use conveniently. The second group provides you with higher-level helper functions. These functions represent an actual task and combine multiple basic operations internally.