friends

Search for a player by gamertag

Look up a player's profile by their gamertag. Returns profile settings including gamertag, gamerscore, avatar, bio, and more.

get/v2/friends/search

Request

Base URL
https://api.xbl.io
Auth
API key in header X-Authorization
TypeScript
https://skmtc.dev/xbl/apis/openxbl-api/docs/v2/friends/search/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

gtstring

Response

Player profile information

contentunknown required

codeinteger required

HTTP status code from the upstream API. Common values: 200 (success), 400 (bad request), 401 (unauthorized), 404 (not found), 410 (deprecated/gone), 429 (rate limited), 500 (server error)

Example response

{
  "code": 200
}

Changes

No recorded changes to this operation across all 2 revisions of this API.