⚠ Cookies are disabled in your web browser. Several features will not work until they are enabled. Please adjust your web browser's security settings before proceeding.

Webservice API V1 Documentation

A webservice API that allow clients to programmatically retrieve information about tournaments and their rosters.

HTTP Response Status Codes

200 OK
The request was successful. The Content-Type is application/json. A JSON document is in the response body.
406 NOT ACCEPTABLE
Either the requested URL did not include the .json endpoint suffix, or the HTTP request did not include an Accept header with application/json.
429 Too Many Requests
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.

HTTP Request Headers

Accept
Set this code application/json. Alternatively, clients can instead use the .json endpoint suffix.

Tournaments

Retrieve all public tournaments.
URL https://chessreg.com/api/v/1/tournaments.json
HTTP Method GET
Example GET /api/v/1/tournaments.json HTTP/1.1
Host: chessreg.com

Roster

Retrieve a tournament's roster.
URL https://chessreg.com/api/v/1/tournaments/{tournament}/roster.json
HTTP Method GET
Example GET /api/v/1/tournaments/gk613/roster.json HTTP/1.1
Host: chessreg.com
Please send bug reports, questions, and feedback to tobin@chessreg.com.