GET: /proposal

ProposalRequest

The request to the Proposal API can specify a number of filters, such as which ids to retrieve information about or state of proposals.

TypeKeyDescription

uint32

page

Page of pagination

uint32

limit

Limit of pagination

ProposalResponse

The Proposal API returns a list of proposals that match the given filters on the request in descending order by proposal_id.

TypeKeyDescription

Struct

metadata

Metadata on request. See ProposalMetadata

repeated Proposal

data

The list of Proposal (see Proposal below)

ProposalMetadata

TypeKeyDescription

uint32

page

Page of pagination

uint32

limit

Limit of pagination

uint32

totalItem

Total amount of items

uint32

totalPage

Total amount of pages for given limit

Proposal

TypeKeyDescription

uint32

id

Unique id for looking up a proposal

string

description

A description of the actions the proposal will take if successful

bytes

targets

The address to send the calldata to

string

values

The value of ETH to send with the transaction

string

signatures

The function signature of the function to call at the target address

string

call_datas

The encoded argument data for the action

Struct

params

Parameters

uint32

created_Block

Created block number

string

created_tx_Hash

Created transaction hash

uint32

created_timestamp

Created block timestamp

uint32

start_block

Started block number

string

start_tx_hash

Started transaction hash

uint32

start_timestamp

Started block timestamp

uint32

cancel_block

Canceled block number

string

cancel_tx_hash

Canceled transaction hash

uint32

cancel_timestamp

Canceled block timestamp

uint32

end_block

End block number

string

end_tx_hash

End transaction hash

uint32

end_timestamp

End block timestamp

uint32

queued_block

Queued block number

string

queued_tx_hash

Queued transaction hash

uint32

queued_timestamp

Queued block timestamp

uint32

executed_block

Executed block number

string

executed_tx_hash

Executed transaction hash

uint32

executed_timestamp

Executed block timestamp

bytes

for_votes

Votes for

bytes

against_votes

Votes against

bytes

proposer

Proposer address

uint32

eta

eta

string

forVotes

The number of votes in support of the proposal

string

againstVotes

The number of votes in opposition to this proposal

uint32

canceled

Set 1 if canceled

uint32

executed

Set 1 if executed

string

state

State of "Pending", "Active", "Canceled", "Defeated", "Succeeded", "Queued", "Expired", "Executed"

uint32

voter_count

Voter count

Timestamp

created_at

Creation timestamp

Timestamp

updated_at

Update timestamp

uint32

expired_timestamp

Expire timestamp

string

title

Title

Last updated