Xbox Live
API actions for the Xbox Live integration.
Xbox Live
Retrieve Xbox Live player info, friends, activity, and achievements.
Get player profile
Retrieve a player's Xbox Live profile by gamertag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
gamertag | string | Yes | The Xbox Live gamertag to look up. |
Response
{
"profile": {}
}List friends
List the friends of an Xbox player.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
xuid | string | Yes | The Xbox user ID to list friends for. |
limit | number | No | Maximum number of friends to return. |
Response
{
"friends": [
{}
]
}List recent activity
Retrieve recent Xbox Live activities for a user.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
xuid | string | Yes | The Xbox user ID to fetch activity for. |
limit | number | No | Maximum number of activities to return. |
Response
{
"activities": [
{}
]
}List game achievements
List a player's achievements for a specific game.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
xuid | string | Yes | The Xbox user ID that owns the achievements. |
title_id | string | Yes | The ID of the game to list achievements for. |
include_unlocked | boolean | No | Set to true to include achievements that are already unlocked. Defaults to true. |
Response
{
"achievements": [
{}
]
}