Skip to content

API Endpoints

Grant Bartlett edited this page May 14, 2017 · 1 revision

API Endpoints

A list of the currently configured endpoints. This list is likely to change as development continues.

REST v1 API Endpoints

Prefix requests with api/v1/

General Endpoints
  • GET /ping to ensure that the server is online
Ladder Endpoints
  • POST /ladder/:game accepts gameres packet (via POST body) for the supplied :game
  • GET /ladder/:game will return the top 150 leaderboard players for the supplied :game
  • GET /ladder/:game/game/:gameId will return all data for a given :gameId
  • GET /ladder/:game/player/:player will return most data for given :player
Clan Endpoints
  • Not yet implemented *
User Authentication
  • GET /auth/token HTTP authentication using Account credentials Successful authentication of this endpoint will return an auth token for future requests.
User Account
  • GET /user/account Returns a list of player usernames linked to this account.
User Creation
  • POST /user/create using HTTP authentication Request requires email, password. Returns token.
Player Creation
  • POST /player/:username