获取提案列表
1. 概述与典型用途
返回链上治理提案列表,包括提案 ID、参数修改内容、状态、过期时间、审批与反对的超级代表列表等详细信息。
- 典型用途:治理提案列表展示、提案投票状态追踪、链参数变更历史查询。
- 何时不要用:查询链参数当前值用「获取链参数列表」。
limit范围为 [20, 200],超出范围返回错误。
2. 接口与鉴权
GET /api/proposal
Base URL 与鉴权见 公共网络与鉴权说明。
3. 请求
字段
| 参数 | 类型 | 必填 | 默认 | 说明 |
|---|---|---|---|---|
start | integer | 否 | 0 | 起始编号 |
limit | integer | 否 | 20 | 每页条目数,范围 [20, 200] |
address | string | 否 | — | 显示该地址是否为发起人或参与者 |
id | integer | 否 | — | 提案 ID |
state | string | 否 | — | 按提案状态过滤:PENDING、APPROVED、DISAPPROVED、CANCELED |
4. 响应
字段
顶层
| 字段 | 类型 | 是否必返 | 说明 |
|---|---|---|---|
total | integer | 必返 | 提案总数 |
data | array | 必返 | 提案记录数组,见下 |
data[] 元素
| 字段 | 类型 | 是否必返 | 说明 | 单位/精度 |
|---|---|---|---|---|
proposalId | integer | 必返 | 提案 ID | — |
proposalHash | string | 必返 | 提案哈希 | — |
proposer | object | 必返 | 发起人信息,见下 | — |
paramters | array | 必返 | 参数修改列表(含 key + value)(paramters 为 API 真实字段名,缺一个 a,非文档错) | — |
state | string | 必返 | 提案状态:PENDING/APPROVED/DISAPPROVED/CANCELED | — |
expirationTime | integer | 必返 | 过期时间 | 毫秒 ms |
createTime | integer | 必返 | 创建时间 | 毫秒 ms |
totalVotes | integer | 必返 | 总票数 | — |
validVotes | integer | 必返 | 有效票数 | — |
approveSelf | boolean | 必返 | 传入 address 时为该地址是否已审批,不传时为 false | — |
createSelf | boolean | 必返 | 传入 address 时为该地址是否为发起人,不传时为 false | — |
approvals | array | 必返 | 审批的超级代表列表,见下 | — |
veto | array | 必返 | 反对的超级代表列表 | — |
typeApprovals | object | 必返 | 按类型分组的审批列表(sr/partner/candidate),各数组元素结构同 proposer | — |
proposer 对象 / approvals[] 元素 / veto[] 元素 / typeApprovals.sr[] 元素(结构相同)
| 字段 | 类型 | 是否必返 | 说明 | 单位/精度 |
|---|---|---|---|---|
address | string | 必返 | 超级代表地址 | — |
name | string | 必返 | 名称 | — |
url | string | 必返 | 官网 URL | — |
producer | boolean | 必返 | 是否为活跃出块节点 | — |
votes | integer | 必返 | 当前投票数 | — |
votesPercentage | number | 必返 | 投票占比 | 百分比 % |
producedTotal | integer | 必返 | 累计出块数 | — |
missedTotal | integer | 必返 | 累计漏块数 | — |
producedTrx | integer | 必返 | 累计产生的 TRX 奖励 | sun |
producePercentage | number | 必返 | 出块效率 | 百分比 % |
latestBlockNumber | integer | 必返 | 最近出块高度 | — |
latestSlotNumber | integer | 必返 | 最新时隙号 | — |
5. 错误
HTTP 状态码见 公共错误说明。本接口要点:
limit范围限制:limit不在 [20, 200] 范围内时返回错误消息。- 空结果 ≠ 错误:无匹配提案时返回
200+data: [],属于正常响应。
最后更新于: