Skip to content

Elections API

This guide provides an overview of the elections information that is available via the PlutoAPI.

The API can return certain data which can then be used on your website. Typically, your web developer will use the API to obtain certain information to display on your website.

For example, many Unions use the data available from the API to display certain candidates on your website before the voting period starts.

The API can also be used to return some specific statistics that you may wish to display on your website, such as the total number of votes per Activity.

Below is a broad list of the sort of information you can obtain via the API:

Statistics/Demographics

  • Total/unique votes per election
  • Overall vote percent
  • Individual election vote statistics
  • Vote statistics based on academic information, such as votes per college, level of study etc...
  • Vote statistics based on individual Activities/categories

Candidate Information

  • Ability to display specific candidates (previously limited so that only all or no candidates could be shown)
  • Retrieve responses to specific custom nomination fields (useful if you use custom fields instead of the standard 'manifesto' field)

Retrieving Specific Elections

You can also retrieve only certain elections based on specific parameters, e.g.:

  • Retrieve elections that are in their nomination period only
  • Retrieve elections that are in their voting period only
  • Retrieve elections within a specific category(s)

External developer documentation is available on GitHub here to provide further guidance on what information can be obtained via the API.

If you require any assistance, please do get in touch via ZenDesk and we shall be happy to help.

Created on 31st January 2025