Votes
A vote is a specific type of transaction (type 3). A wallet votes on a different wallet, which has registered itself eligible to become a Delegate. Wallets may vote for themselves.
Users are often confused by the voting mechanism and the fee associated with a vote. A Delegate does not receive ARK from their voters, nor is the number of blocks they produce proportional to their voting weight.
Endpoints
List All Votes
All voting transactions may be obtained through this API. This is the equivalent of transactions/search with the body parameter type: 3.
Endpoint
Query Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| page |
The number of the page that will be returned.
|
No | 1 |
| limit |
The number of resources per page.
|
No | 100 |
| offset |
The number of resources to be skipped.
|
No | |
| transform |
The structure of response to be retrieved.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
No |
| 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 by which the resources will be sorted.
|
| Required | No |
| Example |
Retrieve a Vote
Votes may be retrieved using their transaction ID. Note the asset field, which contains the votes object. The first character of each item in the array indicates if it was a vote: +, or unvote: -, followed by the public key of the Delegate.
Endpoint
Path Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| id |
The identifier of the vote to be retrieved.
|
No | beb8dd43c640f562704090159154b2742afba7eacada9e8edee447e34e7675c6 |
| Name | id |
| Description |
The identifier of the vote to be retrieved.
|
| Required | No |
| Example | beb8dd43c640f562704090159154b2742afba7eacada9e8edee447e34e7675c6 |