Skip to main content

Documentation Index

Fetch the complete documentation index at: https://rocks.docs.rive.wtf/llms.txt

Use this file to discover all available pages before exploring further.

Every API key is tied to one IP. To apply for a key, DM southctrl on Discord.
Use the endpoint path below, replace the required params, and send Authorization: Bearer YOUR_API_KEY.

Quick Start

1

Choose a gamertag

Use the Xbox gamertag you want to look up.
2

Call the player route

Send the request with your Bearer token.
3

Use the response

Read profile info and recent game activity from the result.
Good for gamertag lookup tools, player cards, and game activity dashboards.

Get Player Info

Get detailed information about an Xbox Live player by their gamertag, including recent game activity.

Endpoint

GET /api/xbox/{gamertag}

Path Parameters

gamertag
string
required
Xbox Live gamertag.

Example Request

cURL
curl -X GET "https://rocks.rive.wtf/api/xbox/MajorNelson" \
  -H "Authorization: Bearer YOUR_API_KEY"
JavaScript
const response = await fetch('https://rocks.rive.wtf/api/xbox/MajorNelson', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();
console.log(data);
Python
import requests

headers = {'Authorization': 'Bearer YOUR_API_KEY'}
response = requests.get(
    'https://rocks.rive.wtf/api/xbox/MajorNelson',
    headers=headers
)
print(response.json())

Example Response

{
  "gamertag": "Stevivor",
  "gamerscore": 821100,
  "games_played": 30,
  "avatar": "https://images-eds-ssl.xboxlive.com/image?url=wHwbXKif8cus8cso...",
  "recent_games": [
    {
      "title": "Star Trek: Voyager - Across the Unknown",
      "last_played": "Last played 1 day ago",
      "platforms": ["PC", "XboxSeries"],
      "cover": "http://store-images.s-microsoft.com/image/apps.2298...",
      "gs_earned": 545,
      "gs_total": 1000,
      "achievements": 39,
      "completion": 55.0
    },
    {
      "title": "Retro Rewind - Video Store Simulator",
      "last_played": "Last played 1 day ago",
      "platforms": ["Win32"],
      "cover": null,
      "gs_earned": null,
      "gs_total": null,
      "achievements": null,
      "completion": 0.0
    }
  ]
}

Response Fields

gamertag
string
The player’s Xbox Live gamertag as it appears on their profile.
gamerscore
integer
Total gamerscore earned by the player across all games.
games_played
integer
Number of games shown in the player’s recent activity (up to 30).
avatar
string
URL to the player’s Xbox Live avatar image.
recent_games
array
List of recently played games, ordered by most recently played.
Privacy settings on Xbox Live profiles may limit the data available. Some games — particularly non-store Win32 titles — will return null for cover, gs_earned, gs_total, and achievements.