Latest revision as of 13:04, 25 March 2024

NASPA provides a RESTful API that is extended as needed to accommodate the needs of developers.

General information

All endpoints begin with the prefix https://www.scrabbleplayers.org/rest/v1

Data is returned as a JSON hash. If an error occurred, the hash will look like: {"error_code":"not-yet","error_text":"unimplemented"}, and can be recognized by the presence of the error_code key. The error_code key will not change once assigned; the error_text might be subject to occasional editing.

Authentication

Some endpoints require authentication. To access these in a POST request, specify a valid NASPA ID as username, and corresponding password as password.

Endpoints

Here is an incomplete list of currently supported endpoints.

Players

/players/naspaid

return a hash of public information about the player whose alphanumeric NASPA ID is naspaid

Tournaments

/tourney/nnn

return a hash of information about the tournament whose numeric id is nnn

/tourney?status=pending

return a hash with key tourneys having a value of a list of hashes each providing data about a rated tournament that is pending (valid results not yet received)

/tourney/nnn/submit

submit rating data for the tournament whose numeric id is nnn (requires authentication, endpoint not fully implemented as of 2024-03-25)