#API Documentation

• ARK C++ Client v1.4.1

#Ark::Client::Connection

#Connection()

1#include <arkClient.h>
2 
3Ark::Client::Connection<Ark::Client::Api> connection(const char\* newIP, int newPort);

Configure an API Connection

#Parameters

#Ark::Client::api::Blockchain

#get()

1#include <arkClient.h>
2 
3std::string getBlockchain = connection.api.blockchain.get();

Get Blockchain info, (height, id, supply)

#Return Value

std::string

#Ark::Client::api::Blocks

#all()

1#include <arkClient.h>
2 
3std::string allBlocks = connection.api.blocks.all(const char\* const query);

Get all blocks.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string getBlock = connection.api.blocks.get(const char\* const blockId);

Get a block by the given id.

#Parameters

#Return Value

std::string

#first()

1#include <arkClient.h>
2 
3std::string getFirst = connection.api.blocks.first();

Get the first block forged.

#Return Value

std::string

#last()

1#include <arkClient.h>
2 
3std::string getLast = connection.api.blocks.last();

Get the last block forged.

#Return Value

std::string

#transactions()

1#include <arkClient.h>
2 
3std::string blockTxs = connection.api.blocks.transactions(const char\* const blockId);

Get all transactions by the given block.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string results = connection.api.blocks.search(
4        const std::map<std::string, std::string>& bodyParameters,
5        const char\* const query);

Filter all blocks by the given parameters.

#Parameters

#Return Value

std::string

#Ark::Client::api::Bridgechains

#all()

1#include <arkClient.h>
2 
3std::string allBridgechains = connection.api.bridgechains.all(const char\* const query);

Get all Bridgechains.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string getBridgechain = connection.api.bridgechains.get(const char\* const bridgechainId);

Get a Bridgechain by a given bridgechainId.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string results = connection.api.bridgechains.search(
4        const std::map<std::string, std::string>& bodyParameters,
5        const char\* const query);

Filter all Bridgechains by the given parameters.

#Parameters

#Return Value

std::string

#Ark::Client::api::Businesses

#all()

1#include <arkClient.h>
2 
3std::string allBusinesses = connection.api.businesses.all(const char\* const query);

Get all Businesses.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string getBridgechain = connection.api.businesses.get(const char\* const businessId);

Get a Business by a given businessId.

#Parameters

#Return Value

std::string

#bridgechains()

1#include <arkClient.h>
2 
3std::string getBusinessBridgechains = connection.api.businesses.bridgechains(const char\* const businessId, const char\* const query);

Get a Business by a given businessId.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string results = connection.api.businesses::search(
4        const std::map<std::string, std::string>& bodyParameters,
5        const char\* const query);

Filter all Businesses by the given parameters.

#Parameters

#Return Value

std::string

#Ark::Client::api::Delegates

#all()

1#include <arkClient.h>
2 
3std::string allDelegates = connection.api.delegates.all(const char\* const query);

Get all Delegates.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string delegate = connection.api.delegates.get(const char\* const identifier);

Get a delegate by the given id.

#Parameters

#Return Value

std::string

#blocks()

1#include <arkClient.h>
2 
3std::string allBlocks = connection.api.delegates.blocks(const char\* const identifier, const char\* const query);

Get all blocks for the given delegate.

#Parameters

#Return Value

std::string

#voters()

1#include <arkClient.h>
2 
3std::string allBlocks = connection.api.delegates.voters(const char\* const identifier, const char\* const query);

Get all voters for the given delegate.

#Parameters

#Return Value

std::string

#Ark::Client::api::Locks

#all()

1#include <arkClient.h>
2 
3std::string allLocks = connection.api.locks.all(const char\* const query);

Get all Locks.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string lock = connection.api.locks.all(const char\* const lockId);

Get a Lock by the given id.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string results = connection.api.locks.search(
4        const std::map<std::string, std::string>& bodyParameters,
5        const char\* const query);

Filter all Locks by the given parameters.

#Parameters

#Return Value

std::string

#unlocked()

1#include <arkClient.h>
2 
3std::string results = connection.api.locks.unlocked(std::string& jsonIds, const char\* const query);

Filter all Locks by the given parameters.

#Parameters

#Return Value

std::string

#Ark::Client::api::Node

#configuration()

1#include <arkClient.h>
2 
3std::string nodeConfig = connection.api.node.configuration();

Get the node configuration.

#Return Value

std::string

#crypto()

1#include <arkClient.h>
2 
3std::string nodeCrypto = connection.api.node.crypto();

Get the node crypto.

#Return Value

std::string

#fees()

1#include <arkClient.h>
2 
3std::string nodeFees = connection.api.node.fees(const char\* const query);

Get the node fees.

#Parameters

#Return Value

std::string

#status()

1#include <arkClient.h>
2 
3std::string nodeStatus = connection.api.node.status();

Get the node status.

#Return Value

std::string

#syncing()

1#include <arkClient.h>
2 
3std::string nodeSyncing = connection.api.node.syncing();

Get the node syncing status.

#Return Value

std::string

#Ark::Client::api::Peers

#all()

1#include <arkClient.h>
2 
3std::string allPeers = connection.api.peers.all(const char\* const query);

Get all peers.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string allPeers = connection.api.peers.get(const char\* const ip);

Get a peer by the given IP address.

#Parameters

#Return Value

std::string

#Ark::Client::api::Rounds

#delegates()

1#include <arkClient.h>
2 
3std::string delegatesInRound = connection.api.rounds.delegates(const char\* const roundId);

Get all delegates in a given round.

#Parameters

#Return Value

std::string

#Ark::Client::api::Transactions

#send()

1#include <arkClient.h>
2 
3std::string sendResult = connection.api.transactions.send(std::string& jsonTransaction);

Post a new transaction to the network.

#Parameters

#Return Value

std::string

#all()

1#include <arkClient.h>
2 
3std::string allTransactions = connection.api.transactions.all(const char\* const query);

Get all transactions.

#Parameters

#Return Value

std::string

#allUnconfirmed()

1#include <arkClient.h>
2 
3std::string allUnconfirmed = connection.api.transactions.allUnconfirmed(const char\* const query);

Get all unconfirmed transactions.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string allUnconfirmed = connection.api.transactions.get(const char\* const identifier);

Get a transaction by the given id.

#Parameters

#Return Value

std::string

#getUnconfirmed()

1#include <arkClient.h>
2 
3std::string allUnconfirmed = connection.api.transactions.getUnconfirmed(const char\* const identifier);

Get an unconfirmed transaction by the given id.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string results = connection.api.transactions.search(const std::map<std::string, std::string> &bodyParameters, const char\* const query);

Filter all transactions by the given parameters.

#Parameters

#Return Value

std::string

#fees()

1#include <arkClient.h>
2 
3std::string allFees = connection.api.transactions.fees();

Get a list of fees for transaction types.

#Return Value

std::string

#types()

1#include <arkClient.h>
2 
3std::string allTypes = connection.api.transactions.types();

Get a list of valid transaction types.

#Return Value

std::string

#Ark::Client::api::Votes

#all()

1#include <arkClient.h>
2 
3std::string allVotes = connection.api.votes.all(const char\* const query);

Get all votes.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string getVote = connection.api.votes.get(const char\* const identifier);

Get a vote by the given id.

#Parameters

#Return Value

std::string

#Ark::Client::api::Wallets

#all()

1#include <arkClient.h>
2 
3std::string allWallets = connection.api.wallets.all(const char\* const query);

Get all wallets.

#Parameters

#Return Value

std::string

#get()

1#include <arkClient.h>
2 
3std::string getWallet = connection.api.wallets.get(const char\* const identifier);

Get a wallet by the given id.

#Parameters

#Return Value

std::string

#locks()

1#include <arkClient.h>
2 
3std::string walletLocks = connection.api.wallets.locks(const char\* const identifier, const char\* const query);

Get a wallets locks by the given id.

#Parameters

#Return Value

std::string

#transactions()

1#include <arkClient.h>
2 
3std::string walletLocks = connection.api.wallets.transactions(const char\* const identifier, const char\* const query);

Get all transactions for the given wallet.

#Parameters

#Return Value

std::string

#transactionsReceived()

1#include <arkClient.h>
2 
3std::string txsReceived = connection.api.wallets.transactionsReceived(const char\* const identifier, const char\* const query);

Get all transactions received by the given wallet.

#Parameters

#Return Value

std::string

#transactionsSent()

1#include <arkClient.h>
2 
3std::string txsSent = connection.api.wallets.transactionsSent(const char\* const identifier, const char\* const query);

Get all transactions sent by the given wallet.

#Parameters

#Return Value

std::string

#top()

1#include <arkClient.h>
2 
3std::string topWallets = connection.api.wallets.top(const char\* const query);

Get all wallets sorted by balance in descending order.

#Parameters

#Return Value

std::string

#votes()

1#include <arkClient.h>
2 
3std::string topWallets = connection.api.wallets.votes(const char\* const identifier, const char\* const query);

Get all votes by the given wallet.

#Parameters

#Return Value

std::string

#search()

1#include <arkClient.h>
2 
3std::string result = connection.api.wallets.search(const std::map<std::string, std::string> &bodyParameters, const char\* const query);

Filter all wallets by the given parameters.

#Parameters

#Return Value

std::string