API Documentation

Introduction to the xTimer API

xTimer API Documentation

The xTimer API enables you to remotely control your timer using scripts and tools. It offers both HTTP endpoints and a Socket.io endpoint for real-time updates.

API Endpoints

The API is divided into two main types of endpoints:

HTTP Endpoints

HTTP endpoints allow you to perform various operations on timers, rooms, and messages through standard REST API calls. These endpoints are great for integrating xTimer with other tools and services.

View HTTP Endpoints Documentation

The Socket.io endpoint provides real-time communication between your application and the xTimer server. It's ideal for building interactive applications that need to respond immediately to changes in timer status.

View Socket.io Endpoints Documentation

Authentication

All API requests must be authenticated using an API key. You can generate an API key from the timer controller page.

Rate Limits

To ensure fair usage of the API, there are rate limits in place. Exceeding these limits will result in temporary blocks. Please design your applications to handle these limits gracefully.

Example Use Cases

Integration with presentation software
Custom controller interfaces
Automated timer control for scheduled events
Digital signage integration
Broadcasting systems integration

For detailed documentation on specific endpoints, please refer to the respective sections.