Examples

Initialization

import Client

let conn = Connection(host: "http://127.0.0.1:4003/api")

Blocks

This service API grants access to the blocks resource. A block is a signed set of transactions created by a delegate and permanently committed to the ARK blockchain.

It is not possible to POST a block through the public API. Relay Nodes accept only blocks posted by a delegate at the correct time through the internal API.

List All Blocks

let blocks = Blocks(connection: conn)

var response: [String: Any]?

blocks.transactions(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Retrieve a Block

let blocks = Blocks(connection: conn)

var response: [String: Any]?

blocks.get(id: "validBlockId", completionHandler: { (response) in
    response = res
    print(response)
})

>>> {'data': {'id': 'validBlockId' ... }}

List All Transactions of a Block

let blocks = Blocks(connection: conn)

var response: [String: Any]?

blocks.transactions(id: "validBlockId", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Search All Blocks

let blocks = Blocks(connection: conn)

var response: [String: Any]?

blocks.search(body: ["generatorPublicKey": "validPublicKey"], completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 100, ... }}

Delegates

The client SDK can be used to query the delegate resource.

A delegate is a regular wallet that has broadcasted a registration transaction, acquired a sufficient number of votes, and has a Relay Node configured to forge new blocks through a forger module. At any time only 51 delegates are active. They are cost-efficient miners running the ARK network.

Voters are wallets which have broadcasted a vote transaction on a delegate. A vote remains active until an un-vote transaction is sent (it does not have to be recast unless a wallet wishes to change from delegate). Voting for a delegate does not give the delegate access to the wallet nor does it lock the coins in it.

List All Delegates

let delegates = Delegates(connection: conn)

var response: [String: Any]?

delegates.all(limit: 20, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 20, ... }}

Retrieve a Delegate

let delegates = Delegates(connection: conn)

var response: [String: Any]?

delegates.get(byName: "delegateName", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'username': 'delegateName', ... }}

List All Blocks of a Delegate

let delegates = Delegates(connection: conn)

var response: [String: Any]?

delegates.blocks(byName: "delegateName", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 100, ... }}

List All Voters of a Delegate

let delegates = Delegates(connection: conn)

var response: [String: Any]?

delegates.voters(byName: "delegateName", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Node

The ARK network consists of different anonymous nodes (servers), maintaining the public ledger, validating transactions and blocks and providing APIs. The node resource allows for querying the health and configurations of the node used by the instantiated client.

Retrieve the Configuration

let node = Node(connection: conn)

var response: [String: Any]?

node.configuration(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'nethash': '6e84d08bd299ed97c212c886c98a57e36545c8f5d645ca7eeae63a8bd62d8988', ... }}

Retrieve the Status

let node = Node(connection: conn)

var response: [String: Any]?

node.status(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'synced': True, 'now': 6897158, 'blocksCount': -1}}

Retrieve the Syncing Status

let node = Node(connection: conn)

var response: [String: Any]?

node.syncing(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'syncing': False, 'blocks': -1, 'height': 6897160, 'id': '12905037940821862953'}}

Retrieve the Node Fees

let node = Node(connection: conn)

var response: [String: Any]?

node.fees(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {"meta":{"days":7, ...}}

Peers

Each node is connected to a set of peers, which are Relay or Delegate Nodes as well. The peers resource provides access to all peers connected to our node.

Peers have made their Public API available for use; however for mission-critical queries and transaction posting you should use a node which is under your control. We provide a guide to setting up a Relay Node here.

List All Peers

let peers = Peers(connection: conn)

var response: [String: Any]?

peers.all(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 100, ... }}

Retrieve a Peer

let peers = Peers(connection: conn)

var response: [String: Any]?

peers.status(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'count': 20, ... }} # Need to changes

Transactions

The heart of any blockchain is formed by its transactions; state-altering payloads signed by a wallet. Most likely you will be querying for transactions most often, using the transaction resource.

A transaction is the only object which may be posted by a non-delegate. It requires a signature from a wallet containing a sufficient amount of ARK.

Create a Transaction

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.create(body: [transaction], completionHandler: { (res) in
    response = res
    print(response)
})

>>> ...

Retrieve a Transaction

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.get(id: "validTransactionId", completionHandler: { (res) in
    response = res
    print(response)
})

>>> ...

List All Transactions

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.all(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List All Unconfirmed Transactions

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.allUnconfirmed(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Get Unconfirmed Transaction

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.getUnconfirmed(id: "validTransactionId", completionHandler: { (res) in
    response = res
    print(response)
})

>>> ...

Search Transactions

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.search(body: ["amount": 100000], completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List Transaction Types

let transactions = Transactions(connection: conn)

var response: [String: Any]?

transactions.types(completionHandler: { (res) in
    response = res
    print(response)
})

>>> {"data":{...}}

Votes

A vote is a transaction sub-type, where the asset field contains a votes object and the transaction.type is 3.

List All Votes

let votes = Votes(connection: conn)

var response: [String: Any]?

votes.all(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Retrieve a Vote

let votes = Votes(connection: conn)

var response: [String: Any]?

votes.get(id: "validVoteId", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {...}}

Wallets

The wallet resource provides access to:

Wallets.
Incoming and outgoing transactions per wallet.
Each wallet’s votes.

Retrieve All Wallets

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.all(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Retrieve a Wallet

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.all(byAddress: "validWalletAddress", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'data': {'address': 'validWalletAddress' ... }}

List All Transactions of a Wallet

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.transactions(byAddress: "validWalletAddress", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List All Received Transactions of a Wallet

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.receivedTransactions(byAddress: "validWalletAddress", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List All Sent Transactions of a Wallet

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.sentTransactions(byAddress: "validWalletAddress", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List All Votes of a Wallet

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.votes(byAddress: "validWalletAddress", completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

List All Top Wallets

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.top(limit: 10, completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Search All Wallets

let wallets = Wallets(connection: conn)

var response: [String: Any]?

wallets.all(body: ["balance": 0], completionHandler: { (res) in
    response = res
    print(response)
})

>>> {'meta': {'count': 10, ... }}

Previous API Documentation

Last updated 3 months ago

Edit Page

#Guidelines

#Typescript

#PHP

#Python

#Java

#Go

#C++

#Frameworks

#Deprecated

#.NET

#Elixir

#Ruby

#Rust

#Swift

#Examples

#Initialization

#Blocks

#List All Blocks

#Retrieve a Block

#List All Transactions of a Block

#Search All Blocks

#Delegates

#List All Delegates

#Retrieve a Delegate

#List All Blocks of a Delegate

#List All Voters of a Delegate

#Node

#Retrieve the Configuration

#Retrieve the Status

#Retrieve the Syncing Status

#Retrieve the Node Fees

#Peers

#List All Peers

#Retrieve a Peer

#Transactions

#Create a Transaction

#Retrieve a Transaction

#List All Transactions

#List All Unconfirmed Transactions

#Get Unconfirmed Transaction

#Search Transactions

#List Transaction Types

#Votes

#List All Votes

#Retrieve a Vote

#Wallets

#Retrieve All Wallets

#Retrieve a Wallet

#List All Transactions of a Wallet

#List All Received Transactions of a Wallet

#List All Sent Transactions of a Wallet

#List All Votes of a Wallet

#List All Top Wallets

#Search All Wallets

Guidelines

Typescript

PHP

Python

Java

Go

C++

Frameworks

Deprecated

.NET

Elixir

Ruby

Rust

Swift