Guide
API and integrations
Connect a results tool, stats service, or your own scripts to your league site with a secure, general-purpose API.
Every league site has API v1 at /api/v1 on your own address. Any service or integration can use it: a results or stats tool, a club website, or a script someone on the committee writes.
Switching it on and creating keys
A super admin turns on Enable API v1 in Settings → API, then creates a key for each service. The secret is shown once, so copy it straight away. Only a scrambled copy is stored. Revoke a key at any time and that service stops working immediately. Give each service its own key and keep keys out of public places.
What a key can do
- read: competitions, fixtures, a match’s full scorecard, squads, standings, player stats, and a player search by name.
- results:write: check, submit, and finalise scorecards.
- squads:write: add a player to a squad. A name that looks like an existing player is flagged rather than added twice.
Results through the API
A scorecard sent through the API goes through the same checks as the website card. A check-only mode lists every problem without saving anything. A submitted card can be shown live, and finalising it updates the table and ratings, and moves the winner into the next round of a cup. Re-sending a finalised card that is identical changes nothing. A different card is refused, so a finished result is never overwritten by mistake. Void, bye, and walkover results are left to the league admin.
Built to be safe
- Each change carries a unique request key, so a repeated request is never saved twice.
- Each key has its own rate limit, set when the key is created.
- Every change made through the API is recorded.
- Errors come back as clear JSON messages.
The full reference, with every endpoint and an example of each, is in the built-in help in your admin area.