SRL API Documentation

== Entrants ==

INDEX   /entrants
    [not implemented]

GET     /entrants/:id
    :id is race id
    Returns list of players participating in a race

== Games ==

INDEX   /games
    Returns un-paged list of all races games

GET     /games/:id
    :id is game abbreviation
    Return details about a specific game

== Goals ==

INDEX   /goals
    [not implemented]

GET     /goals/:id
    :id is game abbreviation
    Returns most commonly races goals for a season
    QUERY STRING
        season      : :int      - The season of the top goals, or the active season if omitted

== Leaderboard ==

INDEX    /leaderboard
    Returns the leaderboard for common race statistics
    QUERY STRING
        page        : :int      - Page of data to return; 1 if omitted
        pageSize    : :int      - Size of paged data to return; 100 if omitted
        sortField   : :int      - Statistic to sort on; vaild stats are 15 - Overall skill, 1 - number of races, 8 - number of wins, 6 - time played, 3 - unique games played
        order       : :string   - Largest to smallest or vice-versa; ASC by default, DESC also acceptable

GET     /leaderboard/:id
    :id is game abbreviation
    Returns the trueskill leaderboard for a game in a season
    QUERY STRING
        season      : :int      - Id of season, active seasons if omitted

== Pastraces ==

INDEX   /pastraces
    Returns list of races from the past
    QUERY STRING
        page        : :int      - Page of data to return, 1 if omitted
        pageSize    : :int      - Size of page, 20 if omitted, 20 max
        season      : :int      - (optional) Id of the season in which the races took place
        game        : :string   - (optional) Abbreviation of the game for the races
        player      : :string   - (optional) Name of a player in the races
        seasongoal  : :int      - (optional) Id of the season featured goal for the race

GET     /pastraces/:id
    :id is the id of a specific past race
    Returns the details of an individual race

== Players ==

INDEX   /players
    [not implemented]

GET     /players/:id
    :id is the player's name
    Returns details about a specific player


== Races ==

INDEX   /races
    Returns a list of all currently active races

GET     /races/:id
    :id is the id of the active race
    QUERY STRING
        lower       : :string       - (optional) Any value here sets player name keys in json to lowercase
== Ratings ==

INDEX   /ratings
    Returns a random champion of a game (#1 ranked player)

GET     /ratings/:id
    :id is a player name
    Returns the ratings of all played games for a player


== Rules ==

INDEX   /rules
    [not implemented]

GET     /rules/:id
    :id is game abbreviation
    Returns the rules for racing a game


== Stat ==

INDEX   /stat
    Returns various statistics for overall, players, or games
    QUERY STRING
        player          : :string       - (optional) Name of the player to get stats for
        game            : :string       - (optional) Abbreviation of the game to get statistics for

GET     /stat/monthly
    Returns month-over-month statistics




== Streams ==

INDEX   /streams
    Returns a list of player names for a given list of stream names
    QUERY STRING
        channels        : :string       - Comma separated list of stream names

GET     /streams/:id
    :id is player name
    Returns the stream channel name of a player

There is also /youtube/:id and /twitter/:id for player names