Get Vote List
1. Overview & Typical Use
Queries the voter list for a Super Representative (SR), or queries all SR votes cast by a specific account. Use the candidate and voter parameters to select the query dimension.
- Typical use: vote details page, SR voter analysis, account vote history.
- When not to use: for SR list use the Super Representative endpoints; for account details use “Get Account Detail”.
2. Endpoint & Authentication
GET /api/vote
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
candidate | string | No | — | SR address — use when querying the voter list for a specific SR |
voter | string | No | — | Voter address — use when querying the vote list for a specific voter |
start | integer | No | 0 | Starting offset |
limit | integer | No | 10 | Items per page |
sort | string | No | — | Sort order; defaults to descending by vote count |
count | string | No | — | When provided, returns the total count of results |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
code | integer | Required | Status code | — |
status | string | Required | Status description (e.g. "1") | — |
message | string | Required | Request result message (e.g. "request ok") | — |
total | integer | Required | Total number of vote records | — |
totalVotes | integer | Required | Total vote count | — |
data | array | Required | Vote record array; see below | — |
contractMap | object | Required | Address → boolean map of whether it is a contract (empty object when no contract addresses) | — |
contractInfo | object | Optional | Contract address → label info; present when querying SR candidate list (value schema below) | — |
contractInfo[<addr>] object schema (8 fields):
| Field | Type | Required | Description |
|---|---|---|---|
tag1 | string | Required | Primary label (project name / contract name / exchange name) |
tag1Url | string | Required | URL of the primary label (may be an empty string) |
name | string | Required | Formal contract / project name |
isToken | boolean | Required | Whether it is a token contract (true / false) |
vip | boolean | Required | Whether it is a VIP entity (true / false) |
risk | boolean | string | Required | Risk label; most endpoints return boolean, some return a string risk type (blacklist / fraud, etc.) |
publicTagDesc | string | Required | Public label description; empty string for most accounts |
publicTag | string | Optional | Public label (e.g. "USDT Token" / "Binance"); returned only for well-known entities or certain endpoints |
data[] elements
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
timestamp | string | Required | Vote time (ISO 8601 format, local time UTC+8, e.g. 2026-05-16T17:12:24.000+0800) | — |
voterAddress | string | Required | Voter address | — |
voterAddressTag | string | Optional | Voter address label | — |
voterPercentage | number | Required | For a voter query, votes / voterAvailableVotes; a candidate query may leave this unpopulated and return 0, which does not mean no votes were cast | Ratio from 0 to 1, rounded to 6 decimal places; multiply by 100 to display a percentage |
candidateAddress | string | Required | SR candidate address | — |
votes | integer | Required | Number of votes | — |
percentage | number | Required | Share of the SR’s total votes: votes / candidateTotalVotes | Ratio from 0 to 1, rounded to 6 decimal places; multiply by 100 to display a percentage |
candidateUrl | string | Required | SR website | — |
candidateName | string | Required | SR name | — |
candidateTotalVotes | integer | Required | Total votes received by the SR | — |
voterAvailableVotes | integer | Required | Total voting capacity of the voter, including votes already cast; a candidate query may leave this unpopulated and return 0, which does not mean no votes were cast | Votes |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
- Empty result is not an error: when an account has not voted,
200+data: []andtotalVotes: 0are returned, which is a normal response.