module RLS::REST
Direct including types
Defined in:
rls/error.crrls/mappings/rest.cr
rls/rest.cr
Constant Summary
-
API_BASE =
"https://api.rocketleaguestats.com/v1"
-
SSL_CONTEXT =
OpenSSL::SSL::Context::Client.new
-
USER_AGENT =
"rlscr (https://github.com/z64/rlscr, #{RLS::VERSION})"
Instance Method Summary
-
#leaderboard(playlist : RankedPlaylist)
Retrieves an array of 100 players sorted by their current season rating
-
#leaderboard(type : StatType)
Retrieves an array of 100 players sorted by their specified stat amount
-
#platforms
Returns the list of active platforms tracked by RLS
-
#player(id : String, platform : Platform = Platform::Steam)
Retrieves a single player by ID and
Platform
. -
#players(query : Array(BatchPlayersPayload))
Fetch up to 10 players with one request.
-
#players(*query)
Fetch up to 10 players with one request
-
#playlists
Returns the current list of playlists tracked by RLS
-
#request(method : String, path : String, headers : HTTP::Headers = HTTP::Headers.new, body : String | Nil = nil)
Make a request to the RLS API.
-
#search(display_name : String, page : UInt32 = 0_u32)
Search for players by display name.
-
#seasons
Returns the current list of seasons tracked by RLS
-
#tiers
Returns the current list of tiers for the current season
Instance Method Detail
Retrieves an array of 100 players sorted by their current season rating
Retrieves an array of 100 players sorted by their specified stat amount
Retrieves a single player by ID and Platform
. ID is a Steam ID, PSN
username, Xbox Gamertag, or Xbox XUID
Fetch up to 10 players with one request. See BatchPlayersPayload
Make a request to the RLS API. This method implements rate limiting (both preemptive and post-request) and will raise exceptions on bad requests.
Search for players by display name. See SearchResults