API Documentation

Warning

WARNING! This package is deprecated and is no longer maintained and supported.

ArkEcosystem.Client.API.Api

Api()

1public Api(HttpClient client)

Class Constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Api

ArkEcosystem.Client.API.Blocks

Blocks()

1public Blocks(HttpClient client)

Blocks class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Blocks

All()

1public Response<List<Block>> All(Dictionary<string, string> parameters = null)

List All Blocks.

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Block>>

AllAsync()

1public async Task<Response<List<Block>>> AllAsync(Dictionary<string, string> parameters = null)

List All Blocks.

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Block>>>

Show()

1public Response<Block> Show(string id)

Retrieve a Block

Parameters

Type Name Required Description
string id Yes Block ID

Return Value

Response<Block>

ShowAsync()

1public async Task<Response<Block>> ShowAsync(string id)

Retrieve a Block

Parameters

Type Name Required Description
string id Yes Block ID

Return Value

Task<Response<Block>>

Transactions()

1public Response<List<Transaction>> Transactions(string id, Dictionary<string, string> parameters = null)

List All Transactions of a Block

Parameters

Type Name Required Description
string id Yes Block ID
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

TransactionsAsync()

1public async Task<Response<List<Transaction>>> TransactionsAsync(string id, Dictionary<string, string> parameters = null)

List All Transactions of a Block

Parameters

Type Name Required Description
string id Yes Block ID
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

Search()

1public Response<List<Block>> Search(Dictionary<string, string> parameters = null)

Search All Blocks

Parameters

Type Name Required Description
Dictionary parameters No Search parameters

Return Value

Response<List<Block>>

SearchAsync()

1public async Task<Response<List<Block>>> SearchAsync(Dictionary<string, string> parameters = null)

Search All Blocks

Parameters

Type Name Required Description
Dictionary parameters No Search parameters

Return Value

Task<Response<List<Block>>>

ArkEcosystem.Client.API.Delegates

Delegates()

1public Delegates(HttpClient client)

Delegates class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Delegates

All()

1public Response<List<Delegate>> All(Dictionary<string, string> parameters = null)

List All Delegates

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

<List<Delegate>>

AllAsync()

1public async Task<Response<List<Delegate>>> AllAsync(Dictionary<string, string> parameters = null)

List All Delegates

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Delegate>>>

Show()

1public Response<Delegate> Show(string id)

Retrieve a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier

Return Value

Response<Delegate>

ShowAsync()

1public async Task<Response<Delegate>> ShowAsync(string id)

Retrieve a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier

Return Value

Task<Response<Delegate>>

Blocks()

1public Response<List<Block>> Blocks(string id, Dictionary<string, string> parameters = null)

List All Blocks of a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Block>>

BlocksAsync()

1public async Task<Response<List<Block>>> BlocksAsync(string id, Dictionary<string, string> parameters = null)

List All Blocks of a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Block>>>

Voters()

1public Response<List<Wallet>> Voters(string id, Dictionary<string, string> parameters = null)

List All Voters of a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Wallet>>

VotersAsync()

1public async Task<Response<List<Wallet>>> VotersAsync(string id, Dictionary<string, string> parameters = null)

List All Voters of a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Wallet>>>

ArkEcosystem.Client.API.Node

Node()

1public Node(HttpClient client)

Node class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Node

Configuration()

1public Response<NodeConfiguration> Configuration()

Retrieve the Configuration

Return Value

Response<NodeConfiguration>

ConfigurationAsync()

1public async Task<Response<NodeConfiguration>> ConfigurationAsync()

Retrieve the Configuration

Return Value

Task<Response<NodeConfiguration>>

Status()

1public Response<NodeStatus> Status()

Retrieve the Status

Return Value

Response<NodeStatus>

StatusAsync()

1public async Task<Response<NodeStatus>> StatusAsync()

Retrieve the Status

Return Value

Task<Response<NodeStatus>>

Syncing()

1public Response<NodeSyncing> Syncing()

Retrieve the Syncing Status

Return Value

Response<NodeSyncing>

SyncingAsync()

1public async Task<Response<NodeSyncing>> SyncingAsync()

Retrieve the Syncing Status

Return Value

Task<Response<NodeSyncing>>

ArkEcosystem.Client.API.Peers

Peers()

1public Peers(HttpClient client)

Peers class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Peers

All()

1public Response<List<Peer>> All()

List All Peers

Return Value

Response<List<Peer>>

AllAsync()

1public async Task<Response<List<Peer>>> AllAsync(Dictionary<string, string> parameters = null)

List All Peers

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Peer>>>

Show()

1public Response<Peer> Show(string ip)

Retrieve a Peer

Parameters

Type Name Required Description
string ip Yes IP address

Return Value

Response<Peer>

ShowAsync()

1public async Task<Response<Peer>> ShowAsync(string ip)

Retrieve a Peer

Parameters

Type Name Required Description
string ip Yes IP address

Return Value

Task<Response<Peer>>

ArkEcosystem.Client.API.Transactions

Transactions()

1public Transactions(HttpClient client)

Transactions class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Transactions

Create()

1public Response<Transaction> Create(Dictionary<string, dynamic> parameters)

Create a Transaction

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Response<Transaction>

CreateAsync()

1public async Task<Response<Transaction>> CreateAsync(Dictionary<string, dynamic> parameters)

Create a Transaction

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Task<Response<Transaction>>

Show()

1public Response<Transaction> Show(string id)

Retrieve a Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Response<Transaction>

ShowAsync()

1public async Task<Response<Transaction>> ShowAsync(string id)

Retrieve a Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Task<Response<Transaction>>

All()

1public Response<List<Transaction>> All(Dictionary<string, string> parameters = null)

List All Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

AllAsync()

1public async Task<Response<List<Transaction>>> AllAsync(Dictionary<string, string> parameters = null)

List All Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

AllUnconfirmed()

1public Response<List<Transaction>> AllUnconfirmed(Dictionary<string, string> parameters = null)

List All Unconfirmed Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

AllUnconfirmedAsync()

1public async Task<Response<List<Transaction>>> AllUnconfirmedAsync(Dictionary<string, string> parameters = null)

List All Unconfirmed Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

ShowUnconfirmed()

1public Response<List<Transaction>> ShowUnconfirmed(string id)

Get Unconfirmed Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Response<List<Transaction>>

ShowUnconfirmedAsync()

1public async Task<Response<List<Transaction>>> ShowUnconfirmedAsync(string id)

Get Unconfirmed Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Task<Response<List<Transaction>>>

Search()

1public Response<List<Transaction>> Search(Dictionary<string, string> parameters)

Search Transactions

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Response<List<Transaction>>

SearchAsync()

1public async Task<Response<List<Transaction>>> SearchAsync(Dictionary<string, string> parameters)

Search Transactions

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Task<Response<List<Transaction>>>

Types()

1public Response<TransactionTypes> Types()

List Transaction Types

Return Value

Response<TransactionTypes>

TypesAsync()

1public async Task<Response<TransactionTypes>> TypesAsync()

List Transaction Types

Return Value

Task<Response<TransactionTypes>>

ArkEcosystem.Client.API.Votes

Votes()

1public Votes(HttpClient client)

Votes class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Clients

Return Value

Votes

All()

1public Response<List<Transaction>> All(Dictionary<string, string> parameters = null)

List All Votes

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Response<List<Transaction>>

AllAsync()

1public async Task<Response<List<Transaction>>> AllAsync(Dictionary<string, string> parameters = null)

List All Votes

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Task<Response<List<Transaction>>>

Show()

1public Response<Transaction> Show(string id)

Retrieve a Vote

Parameters

Type Name Required Description
string id Yes Vote ID

Return Value

Response<Transaction>

ShowAsync()

1public async Task<Response<Transaction>> ShowAsync(string id)

Retrieve a Vote

Parameters

Type Name Required Description
string id Yes Vote ID

Return Value

Task<Response<Transaction>>

ArkEcosystem.Client.API.Wallets

Wallets()

1public Wallets(HttpClient client)

Wallets class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Wallets

All()

1public Response<List<Wallet>> All(Dictionary<string, string> parameters = null)

Retrieve All Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query Parameters

Return Value

Response<List<Wallet>>

AllAsync()

1public async Task<Response<List<Wallet>>> AllAsync(Dictionary<string, string> parameters = null)

Retrieve All Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query Parameters

Return Value

Task<Response<List<Wallet>>>

Show()

1public Response<Wallet> Show(string id)

Retrieve a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier

Return Value

Response<Wallet>

ShowAsync()

1public async Task<Response<Wallet>> ShowAsync(string id)

Retrieve a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier

Return Value

Task<Response<Wallet>>

Transactions()

1public Response<List<Transaction>> Transactions(string id, Dictionary<string, string> parameters = null)

List All Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

TransactionsAsync()

1public async Task<Response<List<Transaction>>> TransactionsAsync(string id, Dictionary<string, string> parameters = null)

List All Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

ReceivedTransactions()

1public Response<List<Transaction>> ReceivedTransactions(string id, Dictionary<string, string> parameters = null)

List All Received Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

ReceivedTransactionsAsync()

1public async Task<Response<List<Transaction>>> ReceivedTransactionsAsync(string id, Dictionary<string, string> parameters = null)

List All Received Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

SentTransactions()

1public Response<List<Transaction>> SentTransactions(string id, Dictionary<string, string> parameters = null)

List All Sent Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

SentTransactionsAsync()

1public async Task<Response<List<Transaction>>> SentTransactionsAsync(string id, Dictionary<string, string> parameters = null)

List All Sent Transactions of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

Votes()

1public Response<List<Transaction>> Votes(string id, Dictionary<string, string> parameters = null)

List All Votes of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

VotesAsync()

1public async Task<Response<List<Transaction>>> VotesAsync(string id, Dictionary<string, string> parameters = null)

List All Votes of a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

Search()

1public Response<List<Wallet>> Search(Dictionary<string, string> parameters)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Response<List<Wallet>>

SearchAsync()

1public async Task<Response<List<Wallet>>> SearchAsync(Dictionary<string, string> parameters)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Task<Response<List<Wallet>>>

Top()

1public Response<List<Wallet>> Top(Dictionary<string, string> parameters = null)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Wallet>>

TopAsync()

1public async Task<Response<List<Wallet>>> TopAsync(Dictionary<string, string> parameters = null)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Wallet>>>

ArkEcosystem.Client.Connection

Connection()

1public Connection(HttpClient client)

Constructor of the Connection class.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Connection

ArkEcosystem.Client.ConnectionManager

Connect()

1public IConnection Connect(IConnection connection, string name = "main")

Constructor of the Connection class.

Parameters

Type Name Required Description
IConnection connection Yes Connection instance
string name No Connection name

Return Value

IConnection

Disconnect()

1public void Disconnect(string name = null)

Disconnect from given connection.

Parameters

Type Name Required Description
string name No Connection name

Return Value

void

Connection()

1public IConnection Connection(string name = null)

Get a connection instance.

Parameters

Type Name Required Description
string name No Connection name

Return Value

IConnection

GetDefaultConnection()

1public string GetDefaultConnection()

Get the default connection name.

Return Value

string

SetDefaultConnection()

1public void SetDefaultConnection(string name)

Set the default connection name.

Parameters

Type Name Required Description
string name No Connection name

Return Value

void

GetConnections()

1public Dictionary<string, IConnection> GetConnections()

Return all of the created connections.

Return Value

Dictionary<string, IConnection>

Last updated 6 months ago
Edit Page
Share: