iota-client 1.4.0

---
title: API Reference
description: Official IOTA Client Library Java API reference.
image: /img/logo/iota_mark_light.png
keywords:
- api
- Java
- param
- type
- endpoint
- builder
---
import Address from './api/Address.mdx'
import AddressDto from './api/AddressDto.mdx'
import AddressIndexRecorder from './api/AddressIndexRecorder.mdx'
import AddressPublicWrapper from './api/AddressPublicWrapper.mdx'
import AddressStringPublicWrapper from './api/AddressStringPublicWrapper.mdx'
import Api from './api/Api.mdx'
import BalanceAddressResponse from './api/BalanceAddressResponse.mdx'
import BrokerOptions from './api/BrokerOptions.mdx'
import Chain from './api/Chain.mdx'
import Client from './api/Client.mdx'
import ClientBuilder from './api/ClientBuilder.mdx'
import ClientException from './api/ClientException.mdx'
import ClientMessageBuilder from './api/ClientMessageBuilder.mdx'
import ClientMiner from './api/ClientMiner.mdx'
import Essence from './api/Essence.mdx'
import GetAddressBuilder from './api/GetAddressBuilder.mdx'
import GetAddressesBuilder from './api/GetAddressesBuilder.mdx'
import GetBalanceBuilderApi from './api/GetBalanceBuilderApi.mdx'
import GetMessageBuilder from './api/GetMessageBuilder.mdx'
import GossipDto from './api/GossipDto.mdx'
import HeartbeatDto from './api/HeartbeatDto.mdx'
import IndexPublicDto from './api/IndexPublicDto.mdx'
import IndexationPayload from './api/IndexationPayload.mdx'
import InfoResponse from './api/InfoResponse.mdx'
import Input from './api/Input.mdx'
import InputKind from './api/InputKind.mdx'
import LedgerInclusionStateDto from './api/LedgerInclusionStateDto.mdx'
import Message from './api/Message.mdx'
import MessageBuilder from './api/MessageBuilder.mdx'
import MessageId from './api/MessageId.mdx'
import MessageMetadata from './api/MessageMetadata.mdx'
import MessagePayload from './api/MessagePayload.mdx'
import MessagePayloadType from './api/MessagePayloadType.mdx'
import MessageWrap from './api/MessageWrap.mdx'
import MetricsDto from './api/MetricsDto.mdx'
import MigratedFundsEntry from './api/MigratedFundsEntry.mdx'
import MigratedFundsEntryDto from './api/MigratedFundsEntryDto.mdx'
import MilestoneId from './api/MilestoneId.mdx'
import MilestonePayload from './api/MilestonePayload.mdx'
import MilestonePayloadEssence from './api/MilestonePayloadEssence.mdx'
import MilestoneResponse from './api/MilestoneResponse.mdx'
import MilestoneSignature from './api/MilestoneSignature.mdx'
import MilestoneUtxoChangesResponse from './api/MilestoneUtxoChangesResponse.mdx'
import MqttEvent from './api/MqttEvent.mdx'
import MqttListener from './api/MqttListener.mdx'
import MqttManager from './api/MqttManager.mdx'
import MqttTopicManager from './api/MqttTopicManager.mdx'
import NativeAPI from './api/NativeAPI.mdx'
import NetworkInfo from './api/NetworkInfo.mdx'
import Node from './api/Node.mdx'
import NodeInfoWrapper from './api/NodeInfoWrapper.mdx'
import Output from './api/Output.mdx'
import OutputDto from './api/OutputDto.mdx'
import OutputKind from './api/OutputKind.mdx'
import OutputResponse from './api/OutputResponse.mdx'
import OutputsOptions from './api/OutputsOptions.mdx'
import PeerDto from './api/PeerDto.mdx'
import PreparedTransactionData from './api/PreparedTransactionData.mdx'
import PublicKey from './api/PublicKey.mdx'
import ReceiptDto from './api/ReceiptDto.mdx'
import ReceiptPayload from './api/ReceiptPayload.mdx'
import ReceiptPayloadDto from './api/ReceiptPayloadDto.mdx'
import ReferenceUnlock from './api/ReferenceUnlock.mdx'
import RegularEssence from './api/RegularEssence.mdx'
import Relation from './api/Relation.mdx'
import RustHex from './api/RustHex.mdx'
import RustLogging from './api/RustLogging.mdx'
import SecretKey from './api/SecretKey.mdx'
import Signature from './api/Signature.mdx'
import SignatureLockedDustAllowanceOutput from './api/SignatureLockedDustAllowanceOutput.mdx'
import SignatureLockedDustAllowanceOutputDto from './api/SignatureLockedDustAllowanceOutputDto.mdx'
import SignatureLockedSingleOutput from './api/SignatureLockedSingleOutput.mdx'
import SignatureLockedSingleOutputDto from './api/SignatureLockedSingleOutputDto.mdx'
import SignatureUnlock from './api/SignatureUnlock.mdx'
import Topic from './api/Topic.mdx'
import TopicEvent from './api/TopicEvent.mdx'
import TransactionId from './api/TransactionId.mdx'
import TransactionPayload from './api/TransactionPayload.mdx'
import TransactionPayloadBuilder from './api/TransactionPayloadBuilder.mdx'
import TreasuryInput from './api/TreasuryInput.mdx'
import TreasuryOutput from './api/TreasuryOutput.mdx'
import TreasuryOutputDto from './api/TreasuryOutputDto.mdx'
import TreasuryPayload from './api/TreasuryPayload.mdx'
import TreasuryResponse from './api/TreasuryResponse.mdx'
import UnlockBlock from './api/UnlockBlock.mdx'
import UnlockBlockKind from './api/UnlockBlockKind.mdx'
import UnlockBlocks from './api/UnlockBlocks.mdx'
import Util from './api/Util.mdx'
import UtxoInput from './api/UtxoInput.mdx'

## Address

<Address components={props.components} />

## AddressDto

<AddressDto components={props.components} />

## AddressIndexRecorder

<AddressIndexRecorder components={props.components} />

## AddressPublicWrapper

<AddressPublicWrapper components={props.components} />

## AddressStringPublicWrapper

<AddressStringPublicWrapper components={props.components} />

## Api

<Api components={props.components} />

## BalanceAddressResponse

<BalanceAddressResponse components={props.components} />

## BrokerOptions

<BrokerOptions components={props.components} />

## Chain

<Chain components={props.components} />

## Client

<Client components={props.components} />

## ClientBuilder

<ClientBuilder components={props.components} />

## ClientException

<ClientException components={props.components} />

## ClientMessageBuilder

<ClientMessageBuilder components={props.components} />

## ClientMiner

<ClientMiner components={props.components} />

## Essence

<Essence components={props.components} />

## GetAddressBuilder

<GetAddressBuilder components={props.components} />

## GetAddressesBuilder

<GetAddressesBuilder components={props.components} />

## GetBalanceBuilderApi

<GetBalanceBuilderApi components={props.components} />

## GetMessageBuilder

<GetMessageBuilder components={props.components} />

## GossipDto

<GossipDto components={props.components} />

## HeartbeatDto

<HeartbeatDto components={props.components} />

## IndexPublicDto

<IndexPublicDto components={props.components} />

## IndexationPayload

<IndexationPayload components={props.components} />

## InfoResponse

<InfoResponse components={props.components} />

## Input

<Input components={props.components} />

## InputKind

<InputKind components={props.components} />

## LedgerInclusionStateDto

<LedgerInclusionStateDto components={props.components} />

## Message

<Message components={props.components} />

## MessageBuilder

<MessageBuilder components={props.components} />

## MessageId

<MessageId components={props.components} />

## MessageMetadata

<MessageMetadata components={props.components} />

## MessagePayload

<MessagePayload components={props.components} />

## MessagePayloadType

<MessagePayloadType components={props.components} />

## MessageWrap

<MessageWrap components={props.components} />

## MetricsDto

<MetricsDto components={props.components} />

## MigratedFundsEntry

<MigratedFundsEntry components={props.components} />

## MigratedFundsEntryDto

<MigratedFundsEntryDto components={props.components} />

## MilestoneId

<MilestoneId components={props.components} />

## MilestonePayload

<MilestonePayload components={props.components} />

## MilestonePayloadEssence

<MilestonePayloadEssence components={props.components} />

## MilestoneResponse

<MilestoneResponse components={props.components} />

## MilestoneSignature

<MilestoneSignature components={props.components} />

## MilestoneUtxoChangesResponse

<MilestoneUtxoChangesResponse components={props.components} />

## MqttEvent

<MqttEvent components={props.components} />

## MqttListener

<MqttListener components={props.components} />

## MqttManager

<MqttManager components={props.components} />

## MqttTopicManager

<MqttTopicManager components={props.components} />

## NativeAPI

<NativeAPI components={props.components} />

## NetworkInfo

<NetworkInfo components={props.components} />

## Node

<Node components={props.components} />

## NodeInfoWrapper

<NodeInfoWrapper components={props.components} />

## Output

<Output components={props.components} />

## OutputDto

<OutputDto components={props.components} />

## OutputKind

<OutputKind components={props.components} />

## OutputResponse

<OutputResponse components={props.components} />

## OutputsOptions

<OutputsOptions components={props.components} />

## PeerDto

<PeerDto components={props.components} />

## PreparedTransactionData

<PreparedTransactionData components={props.components} />

## PublicKey

<PublicKey components={props.components} />

## ReceiptDto

<ReceiptDto components={props.components} />

## ReceiptPayload

<ReceiptPayload components={props.components} />

## ReceiptPayloadDto

<ReceiptPayloadDto components={props.components} />

## ReferenceUnlock

<ReferenceUnlock components={props.components} />

## RegularEssence

<RegularEssence components={props.components} />

## Relation

<Relation components={props.components} />

## RustHex

<RustHex components={props.components} />

## RustLogging

<RustLogging components={props.components} />

## SecretKey

<SecretKey components={props.components} />

## Signature

<Signature components={props.components} />

## SignatureLockedDustAllowanceOutput

<SignatureLockedDustAllowanceOutput components={props.components} />

## SignatureLockedDustAllowanceOutputDto

<SignatureLockedDustAllowanceOutputDto components={props.components} />

## SignatureLockedSingleOutput

<SignatureLockedSingleOutput components={props.components} />

## SignatureLockedSingleOutputDto

<SignatureLockedSingleOutputDto components={props.components} />

## SignatureUnlock

<SignatureUnlock components={props.components} />

## Topic

<Topic components={props.components} />

## TopicEvent

<TopicEvent components={props.components} />

## TransactionId

<TransactionId components={props.components} />

## TransactionPayload

<TransactionPayload components={props.components} />

## TransactionPayloadBuilder

<TransactionPayloadBuilder components={props.components} />

## TreasuryInput

<TreasuryInput components={props.components} />

## TreasuryOutput

<TreasuryOutput components={props.components} />

## TreasuryOutputDto

<TreasuryOutputDto components={props.components} />

## TreasuryPayload

<TreasuryPayload components={props.components} />

## TreasuryResponse

<TreasuryResponse components={props.components} />

## UnlockBlock

<UnlockBlock components={props.components} />

## UnlockBlockKind

<UnlockBlockKind components={props.components} />

## UnlockBlocks

<UnlockBlocks components={props.components} />

## Util

<Util components={props.components} />

## UtxoInput

<UtxoInput components={props.components} />