Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tezos Voting API

The Voting API from Tezos — 14 operation(s) for voting.

Tezos Voting API is one of 34 APIs that Tezos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Voting. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 14 operations across 14 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 1.17.1.

Requests are made against a single base URL, https://api.tzkt.io.

14 operations 14 paths 12 schemas 14 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.17.1
Base URL
https://api.tzkt.io/v1
Resource Areas
1

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 14 GET. Each is listed below with its method, path, parameters, and response codes.

Voting 14
GET
/v1/voting/proposals/count
Get proposals count
Voting_GetProposalsCount → 200
GET
/v1/voting/proposals
Get proposals
Voting_GetProposals 6 params → 200
GET
/v1/voting/proposals/{hash}
Get proposal by hash
Voting_GetProposalByHash 1 param → 200
GET
/v1/voting/periods
Get voting periods
Voting_GetPeriods 7 params → 200
GET
/v1/voting/periods/{index}
Get voting period by index
Voting_GetPeriod 1 param → 200
GET
/v1/voting/periods/current
Get current voting period
Voting_GetCurrentPeriod → 200
GET
/v1/voting/periods/{index}/voters
Get period voters
Voting_GetPeriodVoters 5 params → 200
GET
/v1/voting/periods/{index}/voters/{address}
Get period voter
Voting_GetPeriodVoter 2 params → 200
GET
/v1/voting/periods/current/voters
Get current period voters
Voting_GetPeriodVoters2 4 params → 200
GET
/v1/voting/periods/current/voters/{address}
Get current period voter
Voting_GetPeriodVoter2 1 param → 200
GET
/v1/voting/epochs
Get voting epochs
Voting_GetEpochs 4 params → 200
GET
/v1/voting/epochs/{index}
Get voting epoch by index
Voting_GetEpoch 1 param → 200
GET
/v1/voting/epochs/current
Get current voting epoch
Voting_GetCurrentEpoch → 200
GET
/v1/voting/epochs/latest_voting
Get latest voting
Voting_GetLatestVoting → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are VotingPeriod (23 properties), Proposal (9 properties), Int32Parameter (8 properties), VotingEpoch (8 properties). Each schema is shown below with its type and property counts.

VotingPeriod
object
23 properties
Alias
object
2 properties
SortParameter
object
2 properties
Proposal
object
9 properties
EpochStatusParameter
object
4 properties
VoterStatusParameter
object
4 properties
ProtocolParameter
object
4 properties
OffsetParameter
object
3 properties
VoterSnapshot
object
3 properties
VotingEpoch
object
8 properties
Int32Parameter
object
8 properties
SelectParameter
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tezos-voting-api-openapi.yml Raw ↑

Other APIs Tezos publishes across the network.

TzKT Accounts API
TzKT Blocks API
TzKT Operations API
TzKT Contracts API
TzKT Big Maps API
TzKT Tokens API
TzKT Delegations and Staking API
TzKT Governance API
TzKT Protocols API
TzKT WebSocket API
Tezos Accounts API
Tezos BigMaps API