GET: /voter/history/:address

GET: /voter/history/:address

VoterHistoryResponse

The API retrieves voting history details for a specified voter address, including all past proposal participation and voting actions.

Response Structure

Type	Key	Description
Struct	metadata	Metadata on request (see VoterHistoryMetadata)
repeated VoterHistoryRecord	data	List of voter history records (see VoterHistoryRecord)

VoterHistoryMetadata

Pagination metadata for voter history.

Type	Key	Description
uint32	page	Current page number
uint32	limit	Results per page
uint32	totalItem	Total number of voter history records
uint32	totalPage	Total number of pages for given limit

VoterHistoryRecord

A record containing details of a voter’s participation in a proposal.

Type	Key	Description
Any	voter	Voter details (see Voter)
Any	proposal	Proposal details (see Proposal)

Voter Object

A structure representing voter participation details.

Type	Key	Description
bytes	id	Unique voter ID
string	address	Voter's Ethereum address
uint32	has_voted	1 if voted, 0 otherwise
uint32	support	1 for yes, 0 for no
uint32	proposal_id	Proposal ID associated with the vote
uint32	block_number	Block number when the vote was cast
uint32	block_timestamp	Timestamp when the vote was recorded
Timestamp	created_at	Vote record creation timestamp
Timestamp	updated_at	Last update timestamp
string	votes	Number of votes cast by the voter

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 Voter History: Use this endpoint to fetch detailed participation records of a specific voter.

• Filtering by Proposal State: Voter records include information about active, executed, canceled, and expiredproposals.

• Tracking Individual Voting Activity: Each voter history record provides timestamps, block numbers, and proposal states.

• Monitoring Governance Engagement: Helps identify governance participation trends across different proposals.

By leveraging the Onyx Governance API endpoint, developers can efficiently track voter participation, analyze governance engagement, and integrate voter history into transparency dashboards.