Get Super Representative List
1. Overview & Typical Use
Returns a list of super representatives, partners, and candidates, including vote counts, block production info, commission ratios, and other detailed data.
- Typical use: super representative leaderboard display, voting reference, block production efficiency analysis.
- When not to use: to query real-time voting details for a single super representative, use “Get Super Representative Current Vote Info”; to query an account’s voting activity, use “Get Account Vote List”.
2. Endpoint & Authentication
GET /api/pagewitness
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
witnesstype | integer | No | 0 | Return type: 0 all, 1 super representatives (top 27), 2 partners (28–127), 3 candidates |
start | integer | No | 0 | Start index |
limit | integer | No | 500 | Page size |
sort | integer | No | 0 | Sort direction: 0 ascending, 1 descending |
sortField | string | No | — | Sort field: votes, latestBlock, producedTotal, missedTotal, producePercentage, annualizedRate, brokerage, voterBrokerage |
4. Response
Fields
Top-level
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
total | integer | Required | Total number of super representatives | — |
data | array | Required | Super representative record array, see below | — |
lastBlock | object | Required | Latest block info, see below | — |
lastBlock object
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
hash | string | Required | Block hash | — |
confirmed | boolean | Required | Whether confirmed | — |
number | integer | Required | Block height | — |
size | integer | Required | Block size | bytes |
timestamp | integer | Required | Block timestamp | Unix timestamp in milliseconds |
parentHash | string | Required | Parent block hash | — |
witnessAddress | string | Required | Address of the SR that produced this block | — |
nrOfTrx | integer | Required | Number of transactions in the block | — |
txTrieRoot | string | Required | Transaction trie root hash | — |
witnessId | integer | Required | SR ID of the block producer (0 for non-SRs) | — |
data[] element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
address | string | Required | Super representative address | — |
name | string | Required | Name | — |
url | string | Required | Official website URL | — |
producer | boolean | Required | Whether an active block-producing node | — |
votes | integer | Required | Current cycle vote count | — |
lastCycleVotes | integer | Required | Previous cycle vote count | — |
realTimeVotes | integer | Required | Real-time vote count | — |
changeVotes | integer | Required | Vote change amount | — |
votesPercentage | number | Required | Vote share | Percentage % |
brokerage | number | Required | SR commission ratio | Percentage % |
voterBrokerage | number | Required | Voter dividend ratio | Percentage % |
annualizedRate | string | Required | Annualized yield | Percentage % |
latestBlockNumber | integer | Required | Latest produced block height | — |
latestSlotNumber | integer | Optional | Latest slot number | — |
producedTotal | integer | Required | Cumulative blocks produced | — |
producedTrx | integer | Optional | Cumulative TRX rewards produced | — |
missedTotal | integer | Required | Cumulative missed blocks | — |
producePercentage | number | Required | Block production efficiency | Percentage % |
version | integer | Required | Node version number | — |
witnessType | integer | Required | Node type: 1 super representative, 2 partner, 3 candidate | — |
ranking | integer | Required | Current ranking | — |
logoUrl | string | Optional | Logo URL | — |
index | integer | Required | Index within the current page (starting from 1) | — |
totalOutOfTimeTrans | integer | Required | Cumulative out-of-time transactions | — |
lastWeekOutOfTimeTrans | integer | Required | Last week’s out-of-time transactions | — |
changedBrokerage | boolean | Required | Whether the commission was ever modified | — |
lowestBrokerage | integer | Required | Historical lowest voter dividend ratio | Percentage % |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
- Empty result is not an error: returns
200+data: []when no matching records are found, which is a normal response.
Last updated on: