Get Proposal List
1. Overview & Typical Use
Returns the on-chain governance proposal list, including proposal ID, parameter modification content, status, expiration time, and the lists of approving and opposing super representatives.
- Typical use: governance proposal list display, proposal voting status tracking, chain parameter change history queries.
- When not to use: to query the current values of chain parameters, use “Get Chain Parameters List”.
- The
limitrange is [20, 200]; values outside this range return an error.
2. Endpoint & Authentication
GET /api/proposal
For Base URL and authentication, see Common Network & Authentication.
3. Request
Fields
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | integer | No | 0 | Start index |
limit | integer | No | 20 | Number of entries per page, range [20, 200] |
address | string | No | — | Shows whether this address is the proposer or a participant |
id | integer | No | — | Proposal ID |
state | string | No | — | Filter by proposal state: PENDING, APPROVED, DISAPPROVED, CANCELED |
4. Response
Fields
Top-level
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Required | Total number of proposals |
data | array | Required | Proposal record array, see below |
data[] element
| Field | Type | Required | Description | Unit/Precision |
|---|---|---|---|---|
proposalId | integer | Required | Proposal ID | — |
proposalHash | string | Required | Proposal hash | — |
proposer | object | Required | Proposer info, see below | — |
paramters | array | Required | Parameter modification list (contains key + value) (paramters is the API field name — upstream API typo missing one ‘a’, not a doc error) | — |
state | string | Required | Proposal state: PENDING / APPROVED / DISAPPROVED / CANCELED | — |
expirationTime | integer | Required | Expiration time | Unix timestamp in milliseconds |
createTime | integer | Required | Creation time | Unix timestamp in milliseconds |
totalVotes | integer | Required | Total votes | — |
validVotes | integer | Required | Valid votes | — |
approveSelf | boolean | Required | When address is provided: whether that address has approved; otherwise false | — |
createSelf | boolean | Required | When address is provided: whether that address is the proposer; otherwise false | — |
approvals | array | Required | List of approving super representatives, see below | — |
veto | array | Required | List of opposing super representatives | — |
typeApprovals | object | Required | Approvals grouped by type (sr / partner / candidate); each array element has the same structure as proposer | — |
proposer object / approvals[] element / veto[] element / typeApprovals.sr[] element (same structure)
| 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 vote count | — |
votesPercentage | number | Required | Vote share | Percentage % |
producedTotal | integer | Required | Cumulative blocks produced | — |
missedTotal | integer | Required | Cumulative missed blocks | — |
producedTrx | integer | Required | Cumulative TRX rewards produced | sun |
producePercentage | number | Required | Block production efficiency | Percentage % |
latestBlockNumber | integer | Required | Latest produced block height | — |
latestSlotNumber | integer | Required | Latest slot number | — |
5. Errors
For HTTP status codes, see Common Errors. Key points for this endpoint:
limitrange restriction: returns an error message whenlimitis outside the [20, 200] range.- Empty result is not an error: returns
200+data: []when no matching proposals are found, which is a normal response.
Last updated on: