API Documentation

ArkEcosystem.Client

new()

1def new(opts)

Shortcut to ArkEcosystem.Client.Connection.new/1

Parameters

Type Name Required Description
Keyword.t() opts Yes Query parameters

Return Value

Tesla.Client.t

get()

1def get(client, url, opts \\ [])

Shortcut to Tesla.get/4

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() url Yes Endpoint
Keyword.t() opts No Query parameters

Return Value

response()

patch()

1def patch(client, url, body, opts \\ [])

Alias for put/4

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() url Yes Endpoint
any() body Yes …
Keyword.t() opts No Query parameters

Return Value

response()

post()

1def post(client, url, body, opts \\ [])

Shortcut to Tesla.post/4

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() url Yes Endpoint
any() body Yes …
Keyword.t() opts No Query parameters

Return Value

response()

put()

1def put(client, url, body, opts \\ [])

Shortcut to Tesla.put/4

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() url Yes Endpoint
any() body Yes …
Keyword.t() opts No Query parameters

Return Value

response()

ArkEcosystem.Client.Connection

new()

1def new(%{
2 host: host
3 })
4when is_bitstring(host)

Create a new Connection class instance.

Parameters

Type Name Required Description
Map.t * Yes Config map

Return Value

Tesla.Client.t

ArkEcosystem.Client.API.Blocks

list()

1def list(client, parameters \\ [])

Get all blocks.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, id)

Get a block by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Block ID

Return Value

ArkEcosystem.Client.response()

transactions()

1def transactions(client, id, parameters \\ [])

Get all transactions by the given block.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Block ID
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

search()

1def search(client, parameters)

Filter all blocks by the given parameters.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters Yes Search parameters

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Delegates

list()

1def list(client, parameters \\ [])

Get all accounts.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters Yes Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, id)

Get a delegate by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Delegate identifier

Return Value

ArkEcosystem.Client.response()

blocks()

1def blocks(client, id, parameters \\ [])

Get all blocks for the given delegate.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Delegate identifier
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

voters()

1def voters(client, id, parameters \\ [])

Get all voters for the given delegate.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Delegate identifier
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Node

configuration()

1def configuration(client)

Get the node configuration.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client

Return Value

ArkEcosystem.Client.response()

status()

1def status(client)

Get the node status.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client

Return Value

ArkEcosystem.Client.response()

syncing()

1def syncing(client)

Get the node syncing status.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Peers

all()

1def list(client, parameters \\ [])

Get all peers.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, ip)

Get a peer by the given IP address.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() ip Yes IP address

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Transactions

create()

1def create(client, parameters)

Create a new transaction.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, id)

Get a transaction by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Transaction ID

Return Value

ArkEcosystem.Client.response()

list()

1def list(client, parameters \\ [])

Get all transactions.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

list_unconfirmed()

1def list_unconfirmed(client, parameters \\ [])

Get all unconfirmed transactions.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

get_unconfirmed()

1def get_unconfirmed(client, id)

Get an unconfirmed transaction by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Transaction ID

Return Value

ArkEcosystem.Client.response()

search()

1def search(client, parameters)

Filter all transactions by the given parameters.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Search parameters

Return Value

ArkEcosystem.Client.response()

types()

1def types(client)

Get a list of valid transaction types.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Votes

list()

1def list(client, parameters \\ [])

Get all votes.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, id)

Get a vote by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Vote ID

Return Value

ArkEcosystem.Client.response()

ArkEcosystem.Client.API.Wallets

list()

1def list(client, parameters \\ [])

Get all wallets.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

show()

1def show(client, id)

Get a wallet by the given id.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Wallet identifier

Return Value

ArkEcosystem.Client.response()

transactions()

1def transactions(client, id, parameters \\ [])

Get all transactions for the given wallet.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Wallet identifier
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

received_transactions()

1def received_transactions(client, id, parameters \\ [])

Get all transactions received by the given wallet.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Wallet identifier
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

sent_transactions()

1def sent_transactions(client, id, parameters \\ [])

Get all transactions sent by the given wallet.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Wallet identifier
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

votes()

1def votes(client, id)

Get all votes by the given wallet.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
String.t() id Yes Wallet identifier

Return Value

ArkEcosystem.Client.response()

top()

1def top(client, parameters \\ [])

Get all wallets sorted by balance in descending order.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

search()

1def search(client, parameters)

Filter all wallets by the given parameters.

Parameters

Type Name Required Description
Tesla.Client.t() client Yes Client
Keyword.t() parameters No Query parameters

Return Value

ArkEcosystem.Client.response()

Last updated 3 years ago
Edit Page
Share: