Documentation

Using the API coudn't be simpler. The difference with our new API is that it requires Xbox LIVE authentication to get the data using your Xbox account. This means YOUR friends that have their privacy settings set to friends only can be seen by the API. It also means that we can get your exact data from the API.

Authentication

To connect to the API we need an Authentication header. This is sent as X-AUTH

An example of this is below. Note that if you're logged in we will display your API Key. This means you can copy it straight into your terminal

curl -s -H "X-AUTH: YOUR_AUTH_KEY_HERE" https://xapi.us/v2/accountxuid

Rate Limiting

API requests are limited on a per API Key basis.

When making a request to the API, your limit information will be returned in the headers. Below is an example of this; (If your logged in while viewing this, these are your live stats.)

curl -i -H "X-AUTH: YOUR_AUTH_KEY_HERE" https://xapi.us/v2/accountxuid


HTTP/1.1 200 OK
Date: Fri, 23 October 2020 11:51:29 UTC

Cache-Control: no-cache
Access-Control-Allow-Origin: *
Content-Type: application/json
X-RateLimit-Limit: 0
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 511

{"xuid":2533274813081462,"gamerTag":"djekl","gamertag":"djekl"}

Requesting data in a different language

The API has a default language of en-GB. If you wish to change this to your locale then simply send the correct language header for you using Accept-Language.

For example, if we wanted a users games in German (de-DE), we would send the following request.

curl -s -H "X-AUTH: YOUR_AUTH_KEY_HERE" -H "Accept-Language: de-DE" https://xapi.us/v2/2533274813081462/xboxonegames

Your current language header (sent via your browser) is en-US.

Sending Messages (Paid Subscription Required)

The message sending has been built into the api since the very start, however due to spam I initially had this locked to a few whitelisted users. I am happy to finally document this and allow all users to find out how to send messages, as promoted on the homepage.

An example of this can be done by sending the following JSON POST data.

{
    "to": [
        "2533274813081462"
    ],
    "message": "This is an example message sent via X API 😃"
}

With the following headers:

• X-Auth: YOUR_AUTH_KEY_HERE
• Content-Type: application/json

To the following endpoint: https://xapi.us/v2/messages

This will send me (djekl) a test message.

Posting to your Activity Feed

You can now post directly to your activity feed! This is just like you would inside the Xbox Applications, or on the Dashboard.

An example of this can be done by sending the following JSON POST data.

{
    "message": "This is an example message sent via X API 😃"
}

With the following headers:

• X-Auth: YOUR_AUTH_KEY_HERE
• Content-Type: application/json

To the following endpoint: https://xapi.us/v2/activity-feed

Pagination (continuationToken)

Looking to get more from a request apart from the initial results? Then what you are looking for is the continuationToken, this can be found in the response headers if its available.

An example of this can be done by looking at a users screenshots.

curl -H "X-AUTH: YOUR_AUTH_KEY_HERE" https://xapi.us/v2/2533274813081462/screenshots

You will see the following header (if the continuationToken is available):

• X-Continuation-Token: abcde_vwxyzZAAAAA2

You can then do put that into the URI to get the next set of results like so:

curl -H "X-AUTH: YOUR_AUTH_KEY_HERE" https://xapi.us/v2/2533274813081462/screenshots?continuationToken=abcde_vwxyzZAAAAA2

Available Endpoints

Below you will find a list of available endpoints with some example links too. If you're logged in you can click on them and see the response data available.