Method: HalcyonAPI::Client#players

Defined in:
lib/halcyon_api/client.rb

#players(player_name, *additional_player_names) ⇒ OpenStruct

Gets data about players (one or more)

Examples:

Search for a player

client = VaingloryAPI::Client.new('API_KEY', 'na')
client.players('player_name')

Search for multiple players

client = VaingloryAPI::Client.new('API_KEY', 'na')
client.players('player_name', 'player_name2')

Parameters:

  • player_name (String) —

    the in-game name (IGN) of a player

  • additional_player_names (String) —

    additional IGNs for search for

Returns:

  • (OpenStruct) —

    the response and metadata

See Also:



104
105
106
107
108
109
 
# File 'lib/halcyon_api/client.rb', line 104

def players(player_name, *additional_player_names)
  player_names  = [player_name].concat(additional_player_names)
  filter_params = { 'filter[playerNames]' => player_names.join(',') }

  get_request(shard_endpoint_uri('players', filter_params))
end