Sign in
Voting

Get voting periods

Returns a list of voting periods.

get/v1/voting/periods

Query parameters

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filter by level of the first block of the period.

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filter by level of the last block of the period.

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filters by voting epoch

fieldsstring[] nullable

Fields selection mode (optional, i.e. select.fields=balance is the same as select=balance).
Specify a comma-separated list of fields to include into response.

Example: ?select=address,balance => [ { "address": "asd", "balance": 10 } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance => [ [ "asd", 10 ] ].

Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.

ascstring nullable

Ascending sort mode (optional, i.e. sort.asc=id is the same as sort=id).
Specify a field name to sort by.

Example: ?sort=balance.

descstring nullable

Descending sort mode.
Specify a field name to sort by descending.

Example: ?sort.desc=id.

Sorts voting periods by specified field. Supported fields: id (default).

elinteger nullable

Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.

Example: ?offset=100.

pginteger nullable

Page offset mode.
Skips page * limit elements. This is a classic pagination.

Example: ?offset.pg=1.

crinteger nullable

Cursor offset mode.
Skips all elements with the cursor before (including) the specified value. Cursor is a field used for sorting, e.g. id. Avoid using this offset mode with non-unique or non-sequential cursors such as amount, balance, etc.

Example: ?offset.cr=45837.

Specifies which or how many items should be skipped

limitinteger

Maximum number of items to return

Response

indexinteger

Index of the voting period, starting from zero

epochinteger

Index of the voting epoch, starting from zero

firstLevelinteger

The height of the block in which the period starts

startTimestring date-time

The timestamp of the block in which the period starts

lastLevelinteger

The height of the block in which the period ends

endTimestring date-time

The timestamp of the block in which the period ends

kindstring required

Kind of the voting period: proposal - delegates can submit protocol amendment proposals using the proposal operation exploration - bakers (delegates) may vote on the top-ranked proposal from the previous Proposal Period using the ballot operation testing - If the proposal is approved in the Exploration Period, the testing (or 'cooldown') period begins and bakers start testing the new protocol promotion - delegates can cast one vote to promote or not the tested proposal using the ballot operation adoption - after the proposal is actually accepted, the ecosystem has some time to prepare to the upgrade

statusstring required

Status of the voting period: active - means that the voting period is in progress no_proposals - means that there were no proposals during the voting period no_quorum - means that there was a voting but the quorum was not reached no_supermajority - means that there was a voting but the supermajority was not reached no_single_winner - means that there were multiple winning proposals with the same voting power success - means that the period was finished with positive voting result

dictatorstring required

Status of the governance dictator: none - means that there were no actions by the dictator abort - means that the epoch was aborted by the dictator reset - means that the period was reset by the dictator submit - means that the dictator submitted a proposal

totalBakersinteger

The number of bakers on the voters list

totalVotingPowerinteger

Total voting power of bakers on the voters list

upvotesQuorumnumber double nullable

Upvotes quorum percentage (only for proposal period)

proposalsCountinteger nullable

The number of proposals injected during the voting period (only for proposal period)

topUpvotesinteger nullable

This is how many upvotes (proposal operations) the most upvoted proposal has (only for proposal period)

topVotingPowerinteger nullable

This is how much voting power the most upvoted proposal has (only for proposal period)

ballotsQuorumnumber double nullable

Ballots quorum percentage (only for exploration and promotion periods)

supermajoritynumber double nullable

Supermajority percentage (only for exploration and promotion periods)

yayBallotsinteger nullable

The number of the ballots with "yay" vote (only for exploration and promotion periods)

yayVotingPowerinteger nullable

Total voting power of the ballots with "yay" vote (only for exploration and promotion periods)

nayBallotsinteger nullable

The number of the ballots with "nay" vote (only for exploration and promotion periods)

nayVotingPowerinteger nullable

Total voting power of the ballots with "nay" vote (only for exploration and promotion periods)

passBallotsinteger nullable

The number of the ballots with "pass" vote (only for exploration and promotion periods)

passVotingPowerinteger nullable

Total voting power of the ballots with "pass" vote (only for exploration and promotion periods)

Changes

No recorded changes to this endpoint across all 1 revision of this API.