ArkEcosystem Elixir Client v0.1.0 ArkEcosystem.Client.API.One.Accounts View Source
Documentation for ArkEcosystem.Client.API.One.Accounts
Link to this section Summary
Functions
Get an account
Get all accounts
Get the balance of an account
Get the total amount of accounts
Get the delegates of an account
Get the delegate fee of an account
Get the public key of an account
Get the top accounts
Link to this section Functions
Link to this function
account(client, address)
View Source
account(Tesla.Client.t(), String.t()) :: ArkEcosystem.Client.response()
Get an account.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.account(client, "DQCZQzibtABoggT9ygSzFNQ3A7PJyxttPP")
{:ok,
%ArkEcosystem.Client.API.One.Models.Account{
address: "DQCZQzibtABoggT9ygSzFNQ3A7PJyxttPP",
balance: "2164427163870",
multisignatures: [],
public_key: "02d21954fb256662f82560cdced947af040e5190d9a08e65ee29443090499b22ec",
second_public_key: nil,
second_signature: 0,
u_multisignatures: [],
unconfirmed_balance: "2164427163870",
unconfirmed_signature: 0
}}
Link to this function
all(client, parameters \\ [])
View Source
all(Tesla.Client.t(), Keyword.t()) :: ArkEcosystem.Client.response()
Get all accounts
Examples
iex> ArkEcosystem.Client.API.One.Accounts.all(client, [limit: 30, offset: 10])
// TODO
Link to this function
balance(client, address)
View Source
balance(Tesla.Client.t(), String.t()) :: ArkEcosystem.Client.response()
Get the balance of an account.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.balance(client, "DQCZQzibtABoggT9ygSzFNQ3A7PJyxttPP")
{:ok,
%{
"balance" => "2164627163870",
"success" => true,
"unconfirmedBalance" => "2164627163870"
}}
Link to this function
count(client)
View Source
count(Tesla.Client.t()) :: ArkEcosystem.Client.response()
Get the total amount of accounts.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.count(client)
{:ok,
%{
"count" => 841,
"success" => true
}}
Link to this function
delegates(client, address, parameters \\ [])
View Source
delegates(Tesla.Client.t(), String.t(), Keyword.t()) :: ArkEcosystem.Client.response()
Get the delegates of an account.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.delegates(client, "DFAVFGgkpYc4hrvUNZRf9Tpi7irWeKexLc")
{:ok,
[
%ArkEcosystem.Client.API.One.Models.Delegate{
address: "DQCZQzibtABoggT9ygSzFNQ3A7PJyxttPP",
approval: 0.09,
missedblocks: 1748,
producedblocks: 3469,
productivity: 66.49,
public_key: "02d21954fb256662f82560cdced947af040e5190d9a08e65ee29443090499b22ec",
rate: 17,
username: "arkoar.group",
vote: "12385839821762"
}
]}
Link to this function
fee(client)
View Source
fee(Tesla.Client.t()) :: ArkEcosystem.Client.response()
Get the delegate fee of an account.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.fee(client)
{:ok, %{"fee" => 2500000000, "success" => true}}
Link to this function
publickey(client, address)
View Source
publickey(Tesla.Client.t(), String.t()) :: ArkEcosystem.Client.response()
Get the public key of an account.
Examples
iex> ArkEcosystem.Client.API.One.Accounts.publickey(client, "DQCZQzibtABoggT9ygSzFNQ3A7PJyxttPP")
{:ok, "02d21954fb256662f82560cdced947af040e5190d9a08e65ee29443090499b22ec"}
Link to this function
top(client, parameters \\ [])
View Source
top(Tesla.Client.t(), Keyword.t()) :: ArkEcosystem.Client.response()
Get the top accounts
Examples
iex> ArkEcosystem.Client.API.One.Accounts.top(client, [limit: 30, offset: 10])
{:ok,
%{
"accounts" => [
%{
"address" => "DGihocTkwDygiFvmg6aG8jThYTic47GzU9",
"balance" => "11499593562120633",
"publicKey" => "024c8247388a02ecd1de2a3e3fd5b7c61ecc2797fa3776599d558333ef1802d231"
},
...
],
"success" => true
}}