Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.44 KB

README.md

File metadata and controls

36 lines (21 loc) · 1.44 KB
Raw

WCIF

The official specification of the WCA Competition Interchange Format.

Implementation notes

Currently the WCA website implements most of the specification. The WCIF data for the given competition can be obtained via the following endpoints:

Public endpoint

https://worldcubeassociation.org/api/v0/competitions/:competition_id/wcif/public

Publicly available (with the confidential attributes stripped out). Note: the data may be cached up to 5 minutes.

Authorized endpoint

https://worldcubeassociation.org/api/v0/competitions/:competition_id/wcif

Restricted to competition managers. Additionally, a PATCH request allows for saving the data (currently a significant subset of it).

Note on WCA Live

In order to get up-to-date live results in the WCIF data, make sure you Synchronize on WCA Live. This action makes WCA Live save the data back to the WCA website, making it available for you when requesting one of the WCIF endpoints.

Limitations

  • Currently the WCA website returns Person#registrantId of null for people without a registration (e.g. non-participating organizer).
  • Currently the WCA website does not implement the following attributes: Event#competitorLimit, Round#scrambleSets, Activity#scrambleSetId

Examples

There are many applications using the WCIF format already. Those include the ones listed on the Score tools page.