REST API Documentation
HTTP Response Status Codes
200 OK |
The request was successful. A JSON document is in the response body. |
429 Too Many Requests |
When the client has exceeded the maximum number of requests permitted over a period of time. The client should examine the Retry-After header to know when to re-try. The response body is empty. |
500 Internal Server Error |
An internal server error occurred. |
Endpoints
The following endpoints are available in the API:
List All Events
Retrieve all public events.
URL | https://chessreg.com/api/v1/events |
Method | GET |
Example |
GET https://chessreg.com/api/v1/events
|
Describe Event
Retrieve information about a specific event.
URL | https://chessreg.com/api/v1/events/:eventName |
Method | GET |
Example |
There are no open events at the moment
|
List Players Registered for Event
Retrieve a list of all players registered for an event.
URL | https://chessreg.com/api/v1/events/:eventName/players |
Method | GET |
Example |
There are no open events at the moment
|
Please send questions and feedback to tobin@chessreg.com.