User:Ath/WebAPI/GetPlayerSearch

From Team Fortress Wiki
Jump to: navigation, search

WARNING: This page is strictly a proposal only, and is not a real or supported API!

This method returns a list of player profiles which successfully matched to the passed search string.

This documentation is for version v0001 of GetPlayerSearch.

URL

http://api.steampowered.com/ITFItems_440/GetPlayerSearch/v0001/

Method-specific Parameters

Search
String in which to search with.
maxMatches
Number of successful matches to return. (Deafault (n), Max (n))

Status Codes

  • 1: OK. Data returned as specified below.
  • (n): No matches for the specified search string were found.

Result Data

A list of the matched players is returned, as follows:

results
An object containing an array sorted by relevance (descending) of
result
steamid
Player's 64-bit SteamID.
personaname
The player's persona name (display name).
avatar
The full URL of the player's 32x32px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.
avatarmedium
The full URL of the player's 64x64px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.
avatarfull
The full URL of the player's 184x184px avatar. If the user hasn't configured an avatar, this will be the default ? avatar.