Get Super Representative Current Vote Info
1. Overview & Typical Use
Returns the current vote details for a specified Super Representative, including real-time ranking, vote change, commission ratio, annualized yield, and vote trend chart data. When the address parameter is omitted, returns a global vote overview.
- Typical use: super representative details page, vote trend chart, commission history queries.
- When not to use: for an account’s vote distribution use “Get Account Vote List”; for all SR list use “Get Super Representative List”.
- Omitting
addressreturns a global overview — this is not an error; an invalid address returnsdata: null.
2. Endpoint & Authentication
GET /api/vote/witness
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | No | — | Super Representative address; omitting returns a global vote overview |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
status | string | Required | Request status code string; "1" on success | — |
code | integer | Required | HTTP status code; 200 on success | — |
message | string | Required | Request result description; "request ok" on success | — |
success | string | Required | Whether the request succeeded; value is "true" | — |
data | object | array | Optional | SR details; single object when address is provided; array of vote records when address is omitted; see below | — |
totalWitness | integer | Required | Total number of Super Representatives | — |
total | integer | Optional | Total SR count (when address is omitted) | — |
totalVotes | integer | Optional | Total network vote count (when address is omitted) | — |
fastestRise | object | Optional | SR with the fastest vote count increase (when address is omitted) | — |
maxVotesRise | object | Optional | SR with the largest vote increase (when address is omitted) | — |
changedBrokerage | boolean | Required | Whether the commission has ever been modified | — |
lowestBrokerage | integer | Required | Lowest voter dividend ratio | Percentage % |
brokerageChangeNum | integer | Required | Number of commission modifications | — |
brokerageHistory | array | Optional | Commission modification history (when address is provided); see below | — |
brokerageHistory[] elements
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
from | integer | Required | Voter dividend ratio before the modification | Percentage % |
to | integer | Required | Voter dividend ratio after the modification | Percentage % |
time | integer | Required | Modification timestamp | Seconds timestamp |
hash | string | Required | Modification transaction hash | — |
data object fields
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
address | string | Required | Super Representative address | — |
name | string | Required | Name | — |
url | string | Required | Official website URL | — |
hasPage | boolean | Optional | Whether a details page exists | — |
logoUrl | string | Optional | Logo URL | — |
lastRanking | integer | Required | Previous cycle ranking | — |
realTimeRanking | integer | Required | Real-time ranking | — |
lastCycleVotes | integer | Required | Previous cycle vote count | — |
realTimeVotes | integer | Required | Real-time vote count | — |
changeVotes | integer | Required | Vote change amount | — |
change_cycle | integer | Optional | Vote change within the current cycle | — |
votesPercentage | number | Required | Vote share | Percentage % |
lastCycleVotesPercentage | number | Required | Previous cycle vote share | Percentage % |
brokerage | number | Required | SR commission ratio | Percentage % |
voterBrokerage | number | Required | Voter dividend ratio | Percentage % |
annualizedRate | string | Required | Annualized yield | Percentage % |
producedTotal | integer | Required | Cumulative blocks produced | — |
producedEfficiency | number | Required | Block production efficiency | Percentage % |
blockReward | integer | Required | Block rewards | — |
version | integer | Optional | Node version number | — |
totalOutOfTimeTrans | integer | Optional | Cumulative out-of-time transactions | — |
lastWeekOutOfTimeTrans | integer | Optional | Last week’s out-of-time transactions | — |
changedBrokerage | boolean | Optional | Whether the commission has ever been modified (inside data object) | — |
lowestBrokerage | integer | Optional | Lowest commission ratio (inside data object) | — |
witnessType | integer | Required | Node type: 1 Super Representative, 2 partner, 3 candidate | — |
realtimeVoteLine | array | Optional | Real-time vote trend data (contains time/vote; when address is provided) | — |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
- Omitting
address: returns a global overview — this is a normal response, not an error. - Invalid address: returns
data: null— no HTTP error is thrown.
Last updated on: