https://github.com/jcxldn/xbl-web-api

[offline] A free, open source REST API for Xbox Live. Written in Python 3.7.
https://github.com/jcxldn/xbl-web-api

api api-wrapper python3 xboxlive

Last synced: about 1 year ago
JSON representation

[offline] A free, open source REST API for Xbox Live. Written in Python 3.7.

• Host: GitHub
• URL: https://github.com/jcxldn/xbl-web-api
• Owner: jcxldn
• License: mit
• Created: 2019-04-09T15:54:09.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-11T07:30:40.000Z (about 4 years ago)
• Last Synced: 2025-05-08T23:09:29.515Z (about 1 year ago)
• Topics: api, api-wrapper, python3, xboxlive
• Language: Python
• Homepage: https://xbl-api.prouser123.me/
• Size: 192 KB
• Stars: 25
• Watchers: 1
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# xbl-web-api

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Prouser123/xbl-web-api/build?logo=github&logoColor=white)

![Uptime Robot ratio (7 days)](https://img.shields.io/uptimerobot/ratio/7/m782558122-d298b8bb4b0d1c15272b7ddf)

[![coverage badge](https://img.shields.io/codecov/c/gh/prouser123/xbl-web-api.svg)](https://codecov.io/gh/Prouser123/xbl-web-api)

![python3 badge](https://img.shields.io/badge/python-3.10-blue.svg)

[Live Instance](https://xbl-api.prouser123.me/)

All routes return JSON unless otherwise specified.

## Routes

- `/titleinfo/`

  Get title information by its title ID.

- `/legacysearch/`

  Search the Xbox 360 Marketplace.

- `/gamertag/check/`

  Check if the specified gamertag is available or taken.

- `/usercolors/define///`

  Get an SVG representation of the defined colors.

- `/usercolors/get/xuid/`

  Get an SVG representation of the user's colors.

- `/usercolors/get/gamertag/`

  Get an SVG representation of the user's colors.

### Profiles

- `/profile/xuid/`

  Get a profile by the user's XUID.

- `/profile/gamertag`

  Get a profile by the user's gamertag.

- `/profile/settings/xuid/`

  Get profile settings (less data) by the user's XUID.

- `/profile/settings/gamertag/`

  Get profile settings (less data) by the user's gamertag.

### Friends

- `/friends/summary/xuid/`

  Get a user's friend summary (followers and following count) by their XUID.

- `/friends/summary/gamertag/`

  Get a user's friend summary (followers and following count) by their gamertag.

### Presence

- `/presence/xuid/`

  Get a user's presence (status) by their XUID.

- `/presence/gamertag/`

  Get a user's presence (status) by their gamertag.

### User Stats

- `/userstats/xuid//titleid/`

  Get a user's stats for a game by Title ID and user XUID.

- `/userstats/gamertag//titleid/`

  Get a user's stats for a game by Title ID and user gamertag.

### XUIDs

- `/xuid/`

  Get a user's XUID by their gamertag.

- `/xuid//raw`

  Get a user's XUID by their gamertag and return as text.

### Achievements

- `/achievements/1/recent/`

  Get the recent Xbox One achievements for a user XUID.

- `/achievements/360/recent/`

  Get the recent Xbox 360 achievements for a user XUID.

- `/achievements/1/titleprogress//`

  Get all achievements (both unlocked and locked) for an Xbox One user from their XUID and the game's Title ID.

- `/achievements/360/titleprogress/all//`

  Get all available achievements for an Xbox 360 user from their XUID and the game's Title ID.

- `/achievements/360/titleprogress/earned//`

  Get all earned / unlocked achievements for an Xbox 360 user from their XUID and the game's Title ID.

- `/achievements/1/titleprogress/detail///`

  Get the achievement details for an Xbox One user from their XUID, the game's SCID (Service Config ID) and an achievement ID.