Delegates

Delegates are regular wallets (addresses) which have registered themselves eligible to become a Delegate by a registration transaction. If a Delegate is among the top 51 highest voted (by staked ARK), it may run a forging Node, which produces a single block per round, awarding the Delegate 2 ARK + any transaction fees included in that block.

Genesis Delegates are the initial, virtualized Delegates. They were not registered nor voted in, and in the ARK mainnet has been replaced by actual Delegates a long time ago.

Endpoints

List All Delegates

You can obtain all Delegates through this paginated API. Note that all registered Delegates are returned in this response, not just the top 51 forging Delegates. If a Delegate Node is offline, it is still returned through this API; as the delegate resource is not concerned with the actual nodes, only with the on-chain registrations and wallets.

Endpoint

GET

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name orderBy
Description
The column and order by which the resources will be sorted.
Required No
Example
Name username
Description
The username of the delegate to be retrieved.
Required No
Example
Name address
Description
The address of the delegate to be retrieved.
Required No
Example
Name publicKey
Description
The public key of the delegate to be retrieved.
Required No
Example
Name votes
Description
The votes of the delegate to be retrieved.
Required No
Example
Name votes.from
Description
The minimum votes of the delegates to be retrieved.
Required No
Example
Name votes.to
Description
The maximum votes of the delegates to be retrieved.
Required No
Example
Name isResigned
Description
The resignation status of the delegate to be retrieved.
Required No
Example
Name blocks.produced
Description
The number of produced blocks of the delegate to be retrieved.
Required No
Example
Name blocks.produced.from
Description
The minimum number of produced blocks of the delegate to be retrieved.
Required No
Example
Name blocks.produced.to
Description
The minimum number of produced blocks of the delegate to be retrieved.
Required No
Example
Name blocks.last.id
Description
The last produced block id of the delegate to be retrieved.
Required No
Example
Name blocks.last.height
Description
The last produced block height of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.epoch
Description
The last produced block epoch timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.epoch.from
Description
The minimum last produced block epoch timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.epoch.to
Description
The maximum last produced block epoch timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.unix
Description
The last produced block unix timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.unix.from
Description
The minimum last produced unix epoch timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.unix.to
Description
The maximum last produced unix epoch timestamp of the delegate to be retrieved.
Required No
Example
Name blocks.last.timestamp.human
Description
The last produced block timestamp of the delegate to be retrieved.
Required No
Example
Name production.approval
Description
The production approval rate of the delegate to be retrieved.
Required No
Example
Name production.approval.from
Description
The minimum production approval rate of the delegate to be retrieved.
Required No
Example
Name production.approval.to
Description
The maximum production approval rate of the delegate to be retrieved.
Required No
Example
Name forged.fess
Description
The forged fees of the delegate to be retrieved.
Required No
Example
Name forged.fess.from
Description
The minimum forged fees of the delegate to be retrieved.
Required No
Example
Name forged.fess.to
Description
The maximum forged fees of the delegate to be retrieved.
Required No
Example
Name forged.rewards
Description
The forged rewards of the delegate to be retrieved.
Required No
Example
Name forged.rewards.from
Description
The minimum forged rewards of the delegate to be retrieved.
Required No
Example
Name forged.rewards.to
Description
The maximum forged rewards of the delegate to be retrieved.
Required No
Example
Name forged.total
Description
The forged fees and rewards of the delegate to be retrieved.
Required No
Example
Name forged.total.from
Description
The minimum forged fees and rewards of the delegate to be retrieved.
Required No
Example
Name forged.total.to
Description
The maximum forged fees and rewards of the delegate to be retrieved.
Required No
Example

Retrieve a Delegate

You can query for a specific delegate by username, address, and public key; thus the following queries will result in an identical response. Note that public keys are always known for delegates, as they have previously transmitted a registration transaction. This is not the case for regular wallets.

Endpoint

GET

Path Parameters

Name address
Description
The address of the delegate to be retrieved.
Required No
Example 1
Name publicKey
Description
The public key of the delegate to be retrieved.
Required No
Example 1
Name username
Description
The username of the delegate to be retrieved.
Required No
Example 1

List All Voters of a Delegate

Obtaining the voters of a Delegate is trivial as well. This endpoint returns active voters. To acquire historical voters, it is better to query the database directly.

Endpoint

GET

Path Parameters

Name delegateAddress
Description
The address of the delegate to be retrieved.
Required No
Example 1
Name delegatePublicKey
Description
The public key of the delegate to be retrieved.
Required No
Example 1
Name delegateUsername
Description
The username of the delegate to be retrieved.
Required No
Example 1
Name address
Description
The address of the voter to be retrieved.
Required No
Example
Name publicKey
Description
The public key of the voter to be retrieved.
Required No
Example
Name balance
Description
The balance of the voter to be retrieved.
Required No
Example 1
Name balance.from
Description
The minimum balance of the voter to be retrieved.
Required No
Example 1
Name balance.to
Description
The maximum balance of the voter to be retrieved.
Required No
Example 1
Name nonce
Description
The nonce of the voter to be retrieved.
Required No
Example 1
Name nonce.from
Description
The minimum nonce of the voter to be retrieved.
Required No
Example 1
Name nonce.to
Description
The maximum nonce of the voter to be retrieved.
Required No
Example 1

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name orderBy
Description
The column and order by which the resources will be sorted.
Required No
Example

List All Blocks of a Delegate

The delegate resource allows you to obtain blocks from a specific Delegate. This is the equivalent of searching for blocks using the generatorPublicKey.

Endpoint

GET

Path Parameters

Name delegateAddress
Description
The address of the delegate to be retrieved.
Required No
Example 1
Name delegatePublicKey
Description
The public key of the delegate to be retrieved.
Required No
Example 1
Name delegateUsername
Description
The username of the delegate to be retrieved.
Required No
Example 1

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column and order by which the resources will be sorted.
Required No
Example
2021 © ARK.io | All rights reserved An ARK.io Product