Skip to main content
GET
/
service
/
xbox
Xbox Live Profile Lookup
curl --request GET \
  --url https://oathnet.org/api/service/xbox \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Request completed successfully",
  "data": {
    "username": "ethan",
    "id": "ethan",
    "avatar": "https://images.weserv.nl/?url=...",
    "meta": {
      "id": "2535419058108561",
      "meta": {
        "gamerscore": "45",
        "accounttier": "Silver",
        "xboxonerep": "GoodPlayer",
        "preferredcolor": "http://dlassets.xboxlive.com/...",
        "realname": "",
        "bio": "",
        "tenurelevel": "0",
        "location": ""
      },
      "username": "ethan",
      "avatar": "https://avatar-ssl.xboxlive.com/avatar/ethan/avatarpic-l.png",
      "cached_at": 1767647599005,
      "scraper_data": {
        "background_picture_url": "https://images.weserv.nl/...",
        "gamerscore": 45,
        "games_played": 30,
        "game_history": []
      }
    },
    "_meta": {
      "user": {
        "plan": "Pro"
      }
    }
  }
}
Look up Xbox/Microsoft profile information using a Gamertag.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Query Parameters

​
xbl_id
string
required

Xbox Live gamertag or XUID

​
search_id
string

Response

200 - application/json

Xbox profile

​
success
boolean
​
message
string
​
data
object