class RLS::Client

• RLS::Client
• Reference
• Object

Overview

The client is the main utility for interacting with the RLS API. It abstracts your API key and caches certain hot API routes. See the REST module for a full description of the API.

client = RLS::Client.new("API_KEY")
puts client.player("76561198034606292") # => RLS::Player

By default, caching is enabled and is handled in memory with a collection of hashes. Cached objects have set expiry rules, and once objects expire the client will perform an HTTP request to update the cache.

If you want to disable caching:

client.player_cache = nil
client.leaderboard_cache = nil

Included Modules

• RLS::REST

Defined in:

Constructors

• .new(key : String)

Instance Method Summary

• #leaderboard(playlist : REST::RankedPlaylist)

  Retrieves an array of 100 players sorted by their current season rating

• #leaderboard(type : REST::StatType)

  Retrieves an array of 100 players sorted by their specified stat amount

• #leaderboard_cache : Memory::Leaderboard | Nil

  Cache for leaderboards, which are arrays of Player objects

• #leaderboard_cache=(leaderboard_cache : Memory::Leaderboard | Nil)

  Cache for leaderboards, which are arrays of Player objects

• #player(id : String, platform : Platform = Platform::Steam)

  Retrieves a single player by ID and Platform.

• #player_cache : Memory::Player | Nil

  Cache for Player objects

• #player_cache=(player_cache : Memory::Player | Nil)

  Cache for Player objects

• #players(query : Array(REST::BatchPlayersPayload))

  Fetch up to 10 players with one request.

Constructor Detail

Instance Method Detail