> For the complete documentation index, see [llms.txt](https://docs.wiclax.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wiclax.com/en/networking/api.md).
# API
Wiclax provides an API that allows a third-party application to access the data of an event live, through HTTP requests.
Based on the principle of Rest APIs, the constitution of addresses for requests makes it possible to specify what data is requested. Responses are provided in standard JSON format.
{% hint style="info" %}
At the moment, this API only covers data consultation (read-only).
{% endhint %}
## Local network and Web
Access from the local network is available as soon as an event is opened in Wiclax.
**Web access** is available upon activation, and only if you have purchased the "*Web API Access*" option for the current license. Note that this access is not persistent, it is only available for the duration of a session where Wiclax remains open and the event file is edited.
In the case of web access, you will have to choose a login for the event - a simple free text that will be included in the addresses and that must ensure that no other user uses the same login at the same time. It also serves to keep access confidential.
In the case of the local network as well as via the web, access to the API is not protected by an authentication system.
## Tests and documentation
The entry point to discover the API is from the `G-Live / API` Rest menu.
The window that opens allows you to select the desired query parameters, and to discover the address to use to obtain them.
Since the JSON format is self-descriptive, this window is in itself a comprehensive documentation of the possibilities offered by the API. Preview responses can be copied and forwarded to a third-party correspondent prior to the race.
For example, locally:
`http://loclahost:5050/startlist/activerace`
returns the list of starters for the active race (aka focused race)
### Custom data fields
Good to know, any custom data field defined on the event will be exported within the JSON structures.
So you can handle any specific information required in the context. For example, could be a participant `Screen name`, which is not a built-in field in Wiclax.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.wiclax.com/en/networking/api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.