Integrate Xbox services easily.

We provide you all the tools you need to get started.

Login with Xbox Live

Account

API reference for retrieving account information and seeing all possible account types and subtypes

Endpoints
/accountGet account information
/account/{xuids}Get account information for specified users
/search/{gamertag}Find other players by gamertag
/alertsGet user notifications
/generate/gamertagGenerate random gamertags

GET /account

Get account information

The account endpoint makes a request to the profile service for gamer pic, gamerscore, gamertag, account tier, Xbox One rep, preferred color, real name, bio, and location.

Response fields and example.

  • object

    Accounts object.

      id

      string

      The Xbox User ID (XUID) is a unique identifier for the user.

      string

      This value is the same as the Xbox User ID (XUID).

      object

      Array of key-value pairs for requested information.

        id

        string

        The key identifier for the supplied value.

        string

        The value for the specified key identifier.

      boolean

      Guest Users, also known as Sponsored Guests or Guest Accounts, allow players to interact with many Xbox Live services without needing to create a full Xbox Live account.

API Object

GET /account/{xuids}

Get account information for specified users

The account endpoint makes a request to the people hub service for gamer pic, gamerscore, gamertag, account tier, Xbox One rep, preferred color, real name, bio, and location.

Response fields and example.

API Object

GET /search/{gamertag}

Find other players by gamertag

This endpoint uses the people hub service to return 15 results for user detail, preferred color via gamertag.

Response fields and example.

API Object

GET /alerts

Get user notifications

This endpoint uses the comments service to return alerts.

Response fields and example.

API Object

POST /generate/gamertag

Generate random gamertags

This endpoint uses the user management service to generate random gamertags that are available.

Request fields and example.

API Object

Response fields and example.

API Object