Elections API
GitHub
  • Open Knowledge Belgium - Elections API
  • API
    • API
      • Entities
      • Groups
      • Lists
      • Candidates
    • Format I
    • Format R
  • More information
    • Types
    • Levels
    • Categories of voters
Powered by GitBook
On this page
  • Get candidates
  • Get candidates by list
  • Get candidates by group
  • Get candidates by entity

Was this helpful?

  1. API
  2. API

Candidates

PreviousListsNextFormat I

Last updated 5 years ago

Was this helpful?

Get candidates

GET https://api.elections.openknowledge.be/candidates/:year/:type[/:id]

This endpoint allows you to get information about candidates. If you need a list of available elections types, see Types.

Path Parameters

Name
Type
Description

year

integer

Year of the elections.

type

string

Type of the elections (see Types).

id

integer

ID of the candidate.

Query Parameters

Name
Type
Description

test

boolean

Use test data instead of real data.

Get candidates by list

GET https://api.elections.openknowledge.be/candidates/:year/:type/list/:list

This endpoint allows you to get information about candidates filtered by list. If you need a list of available elections types, see Types.

Path Parameters

Name
Type
Description

year

integer

Year of the elections.

type

string

Type of the elections (see Types).

list

integer

ID of the list.

Query Parameters

Name
Type
Description

test

boolean

Use test data instead of real data.

final

boolean

Use final test data instead of intermediate test data.

Get candidates by group

GET https://api.elections.openknowledge.be/candidates/:year/:type/group/:group

This endpoint allows you to get information about candidates filtered by group. If you need a list of available elections types, see Types.

Path Parameters

Name
Type
Description

year

integer

Year of the elections.

type

string

Type of the elections (see Types).

group

integer

ID of the group.

Query Parameters

Name
Type
Description

test

boolean

Use test data instead of real data.

final

boolean

Use final test data instead of intermediate test data.

Get candidates by entity

GET https://api.elections.openknowledge.be/candidates/:year/:type/entity/:entity

This endpoint allows you to get information about candidates filtered by entity. If you need a list of available elections types, see Types.

Path Parameters

Name
Type
Description

year

integer

Year of the elections.

type

string

Type of the elections (see Types).

entity

integer

ID of the entity.

Query Parameters

Name
Type
Description

test

boolean

Use test data instead of real data.

final

boolean

Use final test data instead of intermediate test data.

Types
Types
Types
Types