Voting

Get period voters

Returns voters from the voting period at the specified index.

get/v1/voting/periods/{index}/voters

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/voting/periods/{index}/voters
  • Auth
    none declared

Path parameters

indexinteger required

Voting period index starting from zero

Query parameters

eqstring nullable

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

Example: ?status=none.

nestring nullable

Not equal filter mode.
Specify a voter status to get items where the specified field is not equal to the specified value.

Example: ?status.ne=none.

instring[] nullable

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

Example: ?status.in=voted_yay,voted_nay.

nistring[] nullable

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

Example: ?status.ni=none,upvoted.

Filters voters by status (none, upvoted, voted_yay, voted_nay, voted_pass)

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 voters by specified field. Supported fields: id (default), votingPower.

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

votingPowerinteger

Baker's voting power

statusstring required

Voter's status: none - the voter did nothing upvoted - the voter upvoted at least one proposal voted_yay - the voter voted "yay" voted_nay - the voter voted "nay" voted_pass - the voter voted "pass"

Changes

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