Home | SDKs

API Documentation

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

ArkEcosystem.Client.API.Api

Api()

public Api(HttpClient client)

Class Constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Api

ArkEcosystem.Client.API.Blocks

Blocks()

public Blocks(HttpClient client)

Blocks class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Blocks

All()

public Response> All(Dictionary parameters = null)

List All Blocks.

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Block>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

List All Blocks.

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Block>>>

Show()

public Response Show(string id)

Retrieve a Block

Parameters

Type Name Required Description
string id Yes Block ID

Return Value

Response<Block>

ShowAsync()

public async Task> ShowAsync(string id)

Retrieve a Block

Parameters

Type Name Required Description
string id Yes Block ID

Return Value

Task<Response<Block>>

Transactions()

public Response> Transactions(string id, Dictionary 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()

public async Task>> TransactionsAsync(string id, Dictionary 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()

public Response> Search(Dictionary parameters = null)

Search All Blocks

Parameters

Type Name Required Description
Dictionary parameters No Search parameters

Return Value

Response<List<Block>>

SearchAsync()

public async Task>> SearchAsync(Dictionary 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()

public Delegates(HttpClient client)

Delegates class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Delegates

All()

public Response> All(Dictionary parameters = null)

List All Delegates

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

<List<Delegate>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

List All Delegates

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Delegate>>>

Show()

public Response Show(string id)

Retrieve a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier

Return Value

Response<Delegate>

ShowAsync()

public async Task> ShowAsync(string id)

Retrieve a Delegate

Parameters

Type Name Required Description
string id Yes Delegate identifier

Return Value

Task<Response<Delegate>>

Blocks()

public Response> Blocks(string id, Dictionary 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()

public async Task>> BlocksAsync(string id, Dictionary 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()

public Response> Voters(string id, Dictionary 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()

public async Task>> VotersAsync(string id, Dictionary 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()

public Node(HttpClient client)

Node class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Node

Configuration()

public Response Configuration()

Retrieve the Configuration

Return Value

Response<NodeConfiguration>

ConfigurationAsync()

public async Task> ConfigurationAsync()

Retrieve the Configuration

Return Value

Task<Response<NodeConfiguration>>

Status()

public Response Status()

Retrieve the Status

Return Value

Response<NodeStatus>

StatusAsync()

public async Task> StatusAsync()

Retrieve the Status

Return Value

Task<Response<NodeStatus>>

Syncing()

public Response Syncing()

Retrieve the Syncing Status

Return Value

Response<NodeSyncing>

SyncingAsync()

public async Task> SyncingAsync()

Retrieve the Syncing Status

Return Value

Task<Response<NodeSyncing>>

ArkEcosystem.Client.API.Peers

Peers()

public Peers(HttpClient client)

Peers class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Peers

All()

public Response> All()

List All Peers

Return Value

Response<List<Peer>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

List All Peers

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Peer>>>

Show()

public Response Show(string ip)

Retrive a Peer

Parameters

Type Name Required Description
string ip Yes IP address

Return Value

Response<Peer>

ShowAsync()

public async Task> ShowAsync(string ip)

Retrive a Peer

Parameters

Type Name Required Description
string ip Yes IP address

Return Value

Task<Response<Peer>>

ArkEcosystem.Client.API.Transactions

Transactions()

public Transactions(HttpClient client)

Transactions class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Transactions

Create()

public Response Create(Dictionary parameters)

Create a Transaction

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Response<Transaction>

CreateAsync()

public async Task> CreateAsync(Dictionary parameters)

Create a Transaction

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Task<Response<Transaction>>

Show()

public Response Show(string id)

Retrieve a Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Response<Transaction>

ShowAsync()

public async Task> ShowAsync(string id)

Retrieve a Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Task<Response<Transaction>>

All()

public Response> All(Dictionary parameters = null)

List All Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

List All Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

AllUnconfirmed()

public Response> AllUnconfirmed(Dictionary parameters = null)

List All Unconfirmed Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Transaction>>

AllUnconfirmedAsync()

public async Task>> AllUnconfirmedAsync(Dictionary parameters = null)

List All Unconfirmed Transactions

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Task<Response<List<Transaction>>>

ShowUnconfirmed()

public Response> ShowUnconfirmed(string id)

Get Unconfirmed Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Response<List<Transaction>>

ShowUnconfirmedAsync()

public async Task>> ShowUnconfirmedAsync(string id)

Get Unconfirmed Transaction

Parameters

Type Name Required Description
string id Yes Transaction ID

Return Value

Task<Response<List<Transaction>>>

Search()

public Response> Search(Dictionary parameters)

Search Transactions

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Response<List<Transaction>>

SearchAsync()

public async Task>> SearchAsync(Dictionary parameters)

Search Transactions

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Task<Response<List<Transaction>>>

Types()

public Response Types()

List Transaction Types

Return Value

Response<TransactionTypes>

TypesAsync()

public async Task> TypesAsync()

List Transaction Types

Return Value

Task<Response<TransactionTypes>>

ArkEcosystem.Client.API.Votes

Votes()

public Votes(HttpClient client)

Votes class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Clients

Return Value

Votes

All()

public Response> All(Dictionary parameters = null)

List All Votes

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Response<List<Transaction>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

List All Votes

Parameters

Type Name Required Description
Dictionary parameters Yes Query parameters

Return Value

Task<Response<List<Transaction>>>

Show()

public Response Show(string id)

Retrieve a Vote

Parameters

Type Name Required Description
string id Yes Vote ID

Return Value

Response<Transaction>

ShowAsync()

public async Task> 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()

public Wallets(HttpClient client)

Wallets class constructor.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Wallets

All()

public Response> All(Dictionary parameters = null)

Retrieve All Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query Parameters

Return Value

Response<List<Wallet>>

AllAsync()

public async Task>> AllAsync(Dictionary parameters = null)

Retrieve All Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query Parameters

Return Value

Task<Response<List<Wallet>>>

Show()

public Response Show(string id)

Retrieve a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier

Return Value

Response<Wallet>

ShowAsync()

public async Task> ShowAsync(string id)

Retrieve a Wallet

Parameters

Type Name Required Description
string id Yes Wallet identifier

Return Value

Task<Response<Wallet>>

Transactions()

public Response> Transactions(string id, Dictionary 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()

public async Task>> TransactionsAsync(string id, Dictionary 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()

public Response> ReceivedTransactions(string id, Dictionary 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()

public async Task>> ReceivedTransactionsAsync(string id, Dictionary 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()

public Response> SentTransactions(string id, Dictionary 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()

public async Task>> SentTransactionsAsync(string id, Dictionary 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()

public Response> Votes(string id, Dictionary 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()

public async Task>> VotesAsync(string id, Dictionary 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()

public Response> Search(Dictionary parameters)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Response<List<Wallet>>

SearchAsync()

public async Task>> SearchAsync(Dictionary parameters)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters Yes Search parameters

Return Value

Task<Response<List<Wallet>>>

Top()

public Response> Top(Dictionary parameters = null)

List All Top Wallets

Parameters

Type Name Required Description
Dictionary parameters No Query parameters

Return Value

Response<List<Wallet>>

TopAsync()

public async Task>> TopAsync(Dictionary 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()

public Connection(HttpClient client)

Constructor of the Connection class.

Parameters

Type Name Required Description
HttpClient client Yes Client

Return Value

Connection

ArkEcosystem.Client.ConnectionManager

Connect()

public 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()

public void Disconnect(string name = null)

Disconnect from given connection.

Parameters

Type Name Required Description
string name No Connection name

Return Value

void

Connection()

public IConnection Connection(string name = null)

Get a connection instance.

Parameters

Type Name Required Description
string name No Connection name

Return Value

IConnection

GetDefaultConnection()

public string GetDefaultConnection()

Get the default connection name.

Return Value

string

SetDefaultConnection()

public void SetDefaultConnection(string name)

Set the default connection name.

Parameters

Type Name Required Description
string name No Connection name

Return Value

void

GetConnections()

public Dictionary GetConnections()

Return all of the created connections.

Return Value

Dictionary<string, IConnection>


2020 © ARK.io | All rights reserved | An ARK.io Product