https://www.scrabbleplayers.org/wiki/index.php?action=history&feed=atom&title=RESTful_APIRESTful API - Revision history2026-04-05T07:05:25ZRevision history for this page on the wikiMediaWiki 1.29.0https://www.scrabbleplayers.org/wiki/index.php?title=RESTful_API&diff=19368&oldid=prevCM000003: Created page with "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://w..."2024-03-25T17:04:12Z<p>Created page with "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://w..."</p>
<p><b>New page</b></p><div>NASPA provides a '''RESTful API''' that is extended as needed to accommodate<br />
the needs of developers.<br />
<br />
== General information ==<br />
<br />
All endpoints begin with the prefix https://www.scrabbleplayers.org/rest/v1<br />
<br />
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.<br />
<br />
== Authentication ==<br />
<br />
Some endpoints require authentication. To access these in a POST request,<br />
specify a valid NASPA ID as username, and corresponding password as password.<br />
<br />
== Endpoints ==<br />
<br />
Here is an incomplete list of currently supported endpoints.<br />
<br />
=== Players ===<br />
<br />
; /players/''naspaid''<br />
: return a hash of public information about the player whose alphanumeric NASPA ID is ''naspaid''<br />
<br />
=== Tournaments ===<br />
<br />
; /tourney/''nnn''<br />
: return a hash of information about the tournament whose numeric id is ''nnn'' <br />
; /tourney?status=pending<br />
: 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)<br />
; /tourney/''nnn''/submit<br />
: submit rating data for the tournament whose numeric id is ''nnn'' (requires authentication, endpoint not fully implemented as of 2024-03-25)</div>CM000003