Voting

Get proposals

Returns a list of protocol proposals.

get/v1/voting/proposals

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/voting/proposals
  • Auth
    none declared

Query parameters

eqstring nullable

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

Example: ?protocol=PsCARTHAGaz....

nestring nullable

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

Example: ?sender.ne=PsBabyM1eUX....

instring[] nullable

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

Example: ?sender.in=PsCARTHAGaz,PsBabyM1eUX.

nistring[] nullable

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

Example: ?sender.ni=PsCARTHAGaz,PsBabyM1eUX.

Filters proposals by hash

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

hashstring required

Hash of the proposal, which representing a tarball of concatenated .ml/.mli source files

firstPeriodinteger

The first voting period where the proposal was active

lastPeriodinteger

The last voting period where the proposal was active

epochinteger

The voting epoch where the proposal was active

upvotesinteger

The total number of upvotes (proposal operations)

votingPowerinteger

The total voting power of bakers, upvoted the proposal

statusstring required

Status of the proposal active - the proposal in the active state accepted - the proposal was accepted rejected - the proposal was rejected due to too many "nay" ballots skipped - the proposal was skipped due to the quorum was not reached

extrasunknown

Changes

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