Skip to content

Router endpoints ​

Base URL example: http://localhost:3000

MethodPathDescription
GET/healthProcess health + cache stats
GET/openapi.jsonOpenAPI document
GET/v1/versionExport version metadata
GET/v1/manifestBuild manifest
GET/v1/continentsContinents
GET/v1/countriesCountries
GET/v1/eventsEvents
GET/v1/competitionsCompetitions list / filters
GET/v1/competitions/:idCompetition, or collection for year/country/event tokens
GET/v1/championshipsChampionships (?type=)
GET/v1/championships/:idChampionship detail
GET/v1/personsPerson summaries
GET/v1/persons/:idPerson detail
GET/v1/ranks/:region/:type/:eventRankings
GET/v1/results/:competitionIdResults
GET/v1/results/:competitionId/:eventIdResults by event

Query parameters ​

/v1/competitions ​

ParamExampleMeaning
page / sizepage=2&size=50pagination
countryBEISO2
year2023year
month08YYYY-MM slice with year
day13full date slice
event333competitions that held the event

Collections ​

page and size work on championships, persons, ranks, and filtered competition collections.

Examples ​

bash
curl 'http://localhost:3000/v1/competitions?country=BE&year=2023'
curl 'http://localhost:3000/v1/persons/2012PARK03'
curl 'http://localhost:3000/v1/ranks/world/single/333?page=1&size=50'
curl 'http://localhost:3000/v1/results/WC2023/333'

Errors ​

json
{
  "error": {
    "code": "NOT_FOUND",
    "message": "person '2012NOPE01' not found",
    "resource": "person",
    "id": "2012NOPE01"
  }
}

Unofficial. Data owned and maintained by the World Cube Association (worldcubeassociation.org/export/results).