GET: /proposal/:proposalId

GET: /proposal/:proposalId

ProposalResponse

The API response provides detailed governance proposal data for the specified proposal ID.

Response Structure

Type
Key
Description

Struct

metadata

Metadata on the request (empty for this request)

Struct

data

Proposal details (see Proposal below)

Proposal Object

A detailed structure representing a governance proposal.

Type
Key
Description

uint32

id

Unique ID for the proposal

string

description

Description of proposed actions

bytes

targets

Address receiving calldata

string

values

ETH value sent with the transaction

string

signatures

Function signature for execution

string

call_datas

Encoded function arguments

Struct

params

Additional parameters

uint32

created_Block

Block number where proposal was created

string

created_tx_Hash

Transaction hash of proposal creation

uint32

created_timestamp

Timestamp of proposal creation

uint32

start_block

Block number when voting starts

string

start_tx_hash

Transaction hash of vote initiation

uint32

start_timestamp

Timestamp of vote initiation

uint32

cancel_block

Block number of cancellation (if applicable)

string

cancel_tx_hash

Transaction hash of cancellation

uint32

cancel_timestamp

Timestamp of cancellation

uint32

end_block

Block number when voting ends

string

end_tx_hash

Transaction hash of vote conclusion

uint32

end_timestamp

Timestamp of vote conclusion

uint32

queued_block

Block number when proposal was queued

string

queued_tx_hash

Transaction hash of queueing

uint32

queued_timestamp

Timestamp when proposal was queued

uint32

executed_block

Block number when proposal was executed

string

executed_tx_hash

Transaction hash of execution

uint32

executed_timestamp

Timestamp of execution

bytes

for_votes

Number of votes in favor

bytes

against_votes

Number of votes against

bytes

proposer

Address of the proposer

uint32

eta

Estimated execution time

string

forVotes

String representation of votes in favor

string

againstVotes

String representation of votes against

uint32

canceled

1 if canceled, 0 otherwise

uint32

executed

1 if executed, 0 otherwise

string

state

Current proposal state (Pending, Active, Canceled, Defeated, Succeeded, Queued, Expired, Executed)

uint32

voter_count

Total number of voters

Timestamp

created_at

Proposal creation timestamp

Timestamp

updated_at

Proposal last updated timestamp

uint32

expired_timestamp

Timestamp when proposal expires

string

title

Proposal title

Usage Notes

  • Retrieving Proposal Details: Use this endpoint to fetch detailed information on a specific proposal using its unique proposal ID.

  • Tracking Proposal Progress: The response provides full lifecycle tracking, from proposal creation to execution or expiration.

  • Filtering by Proposal State: The state field can be used to filter and categorize proposals into active, executed, canceled, or expired states.

  • Proposal Monitoring: Voting activity and execution timestamps allow for real-time proposal tracking.

Last updated