Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Latest commit

 

History

History
117 lines (92 loc) · 3.3 KB

extended_api.rst

File metadata and controls

117 lines (92 loc) · 3.3 KB

Extended API Methods

The Extended API includes a number of "high level" commands to perform tasks such as sending and receiving transfers.

Note

Below you will find the documentation for both the synchronous and asynchronous versions of the Extebded API methods.

It should be made clear, that they do exactly the same IOTA related operations, accept the same arguments and return the same structures. Asynchronous API calls are non-blocking, so your application can do other stuff while waiting for the result from the network.

While synchronous API calls are regular Python methods, their respective asynchronous versions are Python coroutines. You can await their results, schedule them for execution inside and event loop and much more. PyOTA uses the built-in asyncio Python module for asynchronous operation. For an overview of what you can do with it, head over to this article.

broadcast_and_store

Iota.broadcast_and_store

AsyncIota.broadcast_and_store

broadcast_bundle

Iota.broadcast_bundle

AsyncIota.broadcast_bundle

find_transaction_objects

Iota.find_transaction_objects

AsyncIota.find_transaction_objects

get_account_data

Iota.get_account_data

AsyncIota.get_account_data

get_bundles

Iota.get_bundles

AsyncIota.get_bundles

get_inputs

Iota.get_inputs

AsyncIota.get_inputs

get_new_addresses

Iota.get_new_addresses

AsyncIota.get_new_addresses

get_transaction_objects

Iota.get_transaction_objects

AsyncIota.get_transaction_objects

get_transfers

Iota.get_transfers

AsyncIota.get_transfers

is_confirmed

Iota.is_confirmed

AsyncIota.is_confirmed

is_promotable

Iota.is_promotable

AsyncIota.is_promotable

is_reattachable

Iota.is_reattachable

AsyncIota.is_reattachable

prepare_transfer

Iota.prepare_transfer

AsyncIota.prepare_transfer

promote_transaction

Iota.promote_transaction

AsyncIota.promote_transaction

replay_bundle

Iota.replay_bundle

AsyncIota.replay_bundle

send_transfer

Iota.send_transfer

AsyncIota.send_transfer

send_trytes

Iota.send_trytes

AsyncIota.send_trytes

traverse_bundle

Iota.traverse_bundle

AsyncIota.traverse_bundle