# Xbox API

> Xbox returns video game details, subscription availability, and discounts as a workflow and API.

Xbox’s Get game method looks up a game by name or store link and returns its details, prices, and subscription availability for a country. List game pass games returns catalog games for a selected list and platform; List deals returns sale games for a country and platform.

- Page: https://fous.com/workflows/xbox
- Handle: `@xbox`
- Category: [Entertainment](https://fous.com/workflows/category/entertainment)
- Source website: https://xbox.com
- Last verified: Sep 29, 2026
- Fous is not affiliated with Xbox.

## Methods

### Get game

Operation `get_game`, version 1. 1 credit per call.

Look up an Xbox or PC game by name or Xbox store link and get its store details, prices and Game Pass availability for a country. Prices may be unavailable for unpurchasable listings.

**Input**

| Field | Type | Required | Example | Description |
|---|---|---|---|---|
| `game` | string | yes | `"Forza Horizon 5"` | Game name or xbox.com game store link. Example: Forza Horizon 5. |
| `country` | string | no | `"Canada"` | Country name or two-letter code. Example: United States. |

**Input schema**

```json
{
  "type": "object",
  "required": [
    "game"
  ],
  "properties": {
    "game": {
      "type": "string",
      "description": "Game name or xbox.com game store link. Example: Forza Horizon 5.",
      "examples": [
        "Forza Horizon 5",
        "https://www.xbox.com/en-US/games/store/forza-horizon-5/9NNX1VVR3KNQ",
        "Minecraft"
      ]
    },
    "country": {
      "type": "string",
      "default": "United States",
      "description": "Country name or two-letter code. Example: United States.",
      "examples": [
        "Canada",
        "United Kingdom"
      ]
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "game": "Forza Horizon 5"
    },
    {
      "game": "https://www.xbox.com/en-US/games/store/forza-horizon-5/9NNX1VVR3KNQ",
      "country": "Canada"
    },
    {
      "game": "Minecraft",
      "country": "United Kingdom"
    }
  ]
}
```

**Output**

| Field | Type | Example | Description |
|---|---|---|---|
| `name` | string | `"Forza Horizon 5 Standard Edition"` | Game name. |
| `genres` | array |  | Game genres. |
| `developer` | string or null | `"Playground Games"` | Game developer. |
| `platforms` | array |  | Supported Xbox and PC platforms. |
| `publisher` | string or null | `"Xbox Game Studios"` | Game publisher. |
| `xbox_link` | string | `"https://www.xbox.com/en-US/games/store/forza-horizon-5-standard-edition/9nkx70bbcdrn"` | Game page link. |
| `age_rating` | string or null | `"ESRB Everyone"` | Local age rating. |
| `sale_price` | number or null | `23.99` | Discounted price when on sale, otherwise null. |
| `description` | string or null | `"Your Ultimate Horizon Adventure awaits! Explore the vibrant and ever-evolving open world landscapes of Mexico with limi` | Game description. |
| `star_rating` | number or null | `3.6` | Average star rating out of five. |
| `release_date` | string or null | `"2021-11-09"` | Release date in YYYY-MM-DD, or null if unavailable. |
| `currency_code` | string or null | `"USD"` | Currency for both prices, or null if no price is shown. |
| `regular_price` | number or null | `59.99` | Usual store price, or null if no public purchase price is shown. |
| `sale_end_date` | string or null | `"2026-09-30"` | Sale end date in YYYY-MM-DD, or null when unavailable. |
| `game_pass_plans` | array |  | Game Pass plans that include this game. |
| `cover_image_link` | string or null | `"https://store-images.s-microsoft.com/image/apps.49800.13718773309227929.bebdcc0e-1ed5-4778-8732-f4ef65a2f445.9ac09d39-0` | Cover image link. |
| `discount_percent` | number or null | `60.01` | Percentage off the regular price, or null when not on sale. |
| `store_product_id` | string | `"9NKX70BBCDRN"` | Xbox store product ID. |
| `number_of_ratings` | integer or null | `33708` | Number of customer ratings. |
| `included_in_game_pass` | boolean | `true` | Whether included in Game Pass. |

**Example input**

```json
{
  "game": "Forza Horizon 5"
}
```

**Example output**

```json
{
  "name": "Forza Horizon 5 Standard Edition",
  "genres": [
    "Racing & flying"
  ],
  "developer": "Playground Games",
  "platforms": [
    "Xbox Series X|S",
    "Xbox One",
    "PC"
  ],
  "publisher": "Xbox Game Studios",
  "xbox_link": "https://www.xbox.com/en-US/games/store/forza-horizon-5-standard-edition/9nkx70bbcdrn",
  "age_rating": "ESRB Everyone",
  "sale_price": 23.99,
  "description": "Your Ultimate Horizon Adventure awaits! Explore the vibrant and ever-evolving open world landscapes of Mexico with limitless, fun driving action in hundreds of the world’s greatest cars. ",
  "star_rating": 3.6,
  "release_date": "2021-11-09",
  "currency_code": "USD",
  "regular_price": 59.99,
  "sale_end_date": "2026-09-30",
  "game_pass_plans": [
    "Game Pass for Console",
    "PC Game Pass",
    "Game Pass Premium"
  ],
  "cover_image_link": "https://store-images.s-microsoft.com/image/apps.49800.13718773309227929.bebdcc0e-1ed5-4778-8732-f4ef65a2f445.9ac09d39-064d-466c-81ca-2f1b6f0b95c5",
  "discount_percent": 60.01,
  "store_product_id": "9NKX70BBCDRN",
  "number_of_ratings": 33708,
  "included_in_game_pass": true
}
```

### List deals

Operation `list_deals`, version 1. 1 credit per call.

List Xbox games currently on sale in a country, biggest discount first, with prices, sale end dates and Game Pass availability. Some sale end dates are unpublished; console includes Xbox One and Xbox Series X|S.

**Input**

| Field | Type | Required | Example | Description |
|---|---|---|---|---|
| `country` | string | no | `"United States"` | Country name or two-letter country code, for example United States or US. |
| `platform` | string | no | `"all"` | Which games to list, for example console. |
| `max_results` | integer | no | `50` | Most games to return, for example 50. |

**Input schema**

```json
{
  "type": "object",
  "properties": {
    "country": {
      "type": "string",
      "default": "United States",
      "description": "Country name or two-letter country code, for example United States or US.",
      "examples": [
        "United States",
        "Canada",
        "Germany"
      ]
    },
    "platform": {
      "enum": [
        "all",
        "console",
        "pc"
      ],
      "type": "string",
      "default": "all",
      "description": "Which games to list, for example console.",
      "examples": [
        "all",
        "pc",
        "console"
      ]
    },
    "max_results": {
      "type": "integer",
      "default": 50,
      "maximum": 200,
      "minimum": 1,
      "description": "Most games to return, for example 50.",
      "x-fous-developer": true,
      "examples": [
        50,
        30,
        55
      ]
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "country": "United States",
      "platform": "all",
      "max_results": 50
    },
    {
      "country": "Canada",
      "platform": "pc",
      "max_results": 30
    },
    {
      "country": "Germany",
      "platform": "console",
      "max_results": 55
    }
  ]
}
```

**Output**

| Field | Type | Example | Description |
|---|---|---|---|
| `deals` | array |  | Games currently on sale, biggest discount first. |
| `deals[].title` | string |  |  |
| `deals[].currency` | string |  |  |
| `deals[].xbox_link` | string |  |  |
| `deals[].sale_price` | number |  |  |
| `deals[].sale_end_date` | string or null |  |  |
| `deals[].original_price` | number |  |  |
| `deals[].discount_percent` | integer |  |  |
| `deals[].store_product_id` | string |  |  |
| `deals[].included_in_game_pass` | boolean |  |  |

### List game pass games

Operation `list_game_pass_games`, version 1. 1 credit per call.

List Xbox Game Pass games for console or PC, with details and store links, in Xbox’s catalog sequence (recent additions first for all games). Game Pass addition, arrival, and departure dates are not published in these lists, so those dates are null.

**Input**

| Field | Type | Required | Example | Description |
|---|---|---|---|---|
| `list` | string | no | `"recently_added"` | Which Game Pass list to see, for example recently_added. |
| `platform` | string | no | `"console"` | Where to play, for example console. |
| `max_results` | integer | no | `5` | Maximum number of games to return, for example 50. |

**Input schema**

```json
{
  "type": "object",
  "properties": {
    "list": {
      "enum": [
        "all",
        "recently_added",
        "leaving_soon",
        "coming_soon"
      ],
      "type": "string",
      "default": "recently_added",
      "description": "Which Game Pass list to see, for example recently_added.",
      "examples": [
        "recently_added",
        "leaving_soon",
        "coming_soon"
      ]
    },
    "platform": {
      "enum": [
        "console",
        "pc"
      ],
      "type": "string",
      "default": "console",
      "description": "Where to play, for example console.",
      "examples": [
        "console",
        "pc"
      ]
    },
    "max_results": {
      "type": "integer",
      "default": 50,
      "maximum": 500,
      "minimum": 1,
      "description": "Maximum number of games to return, for example 50.",
      "x-fous-developer": true,
      "examples": [
        5,
        50
      ]
    }
  },
  "additionalProperties": false,
  "examples": [
    {
      "list": "recently_added",
      "platform": "console",
      "max_results": 5
    },
    {
      "list": "leaving_soon",
      "platform": "pc",
      "max_results": 5
    },
    {
      "list": "coming_soon",
      "platform": "console",
      "max_results": 5
    }
  ]
}
```

**Output**

| Field | Type | Example | Description |
|---|---|---|---|
| `games` | array |  |  |
| `games[].name` | string | `"Mad King Redemption"` | Game title. |
| `games[].genres` | array |  | Genres listed for this game. |
| `games[].xbox_url` | string | `"https://www.xbox.com/en-US/games/store/mad-king-redemption/9N944N1WP67T"` | Xbox store page link. |
| `games[].publisher` | string or null | `"Secret Mission Games"` | Publisher name, if listed. |
| `games[].date_added` | string or null |  | Game Pass addition date when explicitly published; otherwise null. |
| `games[].leaving_date` | string or null |  | Game Pass departure date when explicitly published; otherwise null. |
| `games[].arriving_date` | string or null |  | Game Pass arrival date when explicitly published; otherwise null. |
| `games[].cover_image_url` | string or null | `"https://store-images.s-microsoft.com/image/apps.56038.13544556109351948.9c4c33b4-f6ce-4d2c-ac5f-3aa565d08d7d.42b5ee39-b` | Game cover image link, if listed. |
| `games[].store_product_id` | string | `"9N944N1WP67T"` | Xbox store product ID. |

**Example input**

```json
{
  "list": "recently_added",
  "platform": "console",
  "max_results": 5
}
```

**Example output**

```json
{
  "games": [
    {
      "name": "Mad King Redemption",
      "genres": [
        "Action & adventure",
        "Fighting"
      ],
      "xbox_url": "https://www.xbox.com/en-US/games/store/mad-king-redemption/9N944N1WP67T",
      "publisher": "Secret Mission Games",
      "date_added": null,
      "leaving_date": null,
      "arriving_date": null,
      "cover_image_url": "https://store-images.s-microsoft.com/image/apps.56038.13544556109351948.9c4c33b4-f6ce-4d2c-ac5f-3aa565d08d7d.42b5ee39-b724-4340-b34e-39af9df10075",
      "store_product_id": "9N944N1WP67T"
    },
    {
      "name": "Well Dweller",
      "genres": [
        "Action & adventure",
        "Platformer",
        "Role playing"
      ],
      "xbox_url": "https://www.xbox.com/en-US/games/store/well-dweller/9PLH7R84GJWP",
      "publisher": "Top Hat Studios, Inc.",
      "date_added": null,
      "leaving_date": null,
      "arriving_date": null,
      "cover_image_url": "https://store-images.s-microsoft.com/image/apps.40917.14313416011451880.0dc13654-082f-4832-844b-343ef39821bf.85739feb-1ce4-4fed-bc5a-cc6e3f5fb96a",
      "store_product_id": "9PLH7R84GJWP"
    },
    {
      "name": "Dune: Awakening",
      "genres": [
        "Action & adventure",
        "Role playing",
        "Shooter"
      ],
      "xbox_url": "https://www.xbox.com/en-US/games/store/dune-awakening/9PJ6FV3130QZ",
      "publisher": "Funcom",
      "date_added": null,
      "leaving_date": null,
      "arriving_date": null,
      "cover_image_url": "https://store-images.s-microsoft.com/image/apps.58998.14221973547534254.c9400a22-a0eb-4428-bc72-11e2270ad849.fcbce16e-22b4-4a1a-ae75-75fa207548b5",
      "store_product_id": "9PJ6FV3130QZ"
    }
  ]
}
```

## Quick start

Call the API with a Fous API key (`FOUS_API_KEY`). To create one, turn on Developer mode in Fous Studio, then open Keys & connections → API keys (https://app.fous.com/keys).

```bash
# First set your key: export FOUS_API_KEY='YOUR_FOUS_API_KEY'
: "${FOUS_API_KEY:?Set FOUS_API_KEY before running this example}"

curl 'https://api.fous.com/v1/query' \
  --fail-with-body --silent --show-error --max-time 120 \
  -H "Authorization: Bearer $FOUS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "api": "@xbox",
  "visibility": "public",
  "operation": "get_game",
  "version": 1,
  "input": {
    "game": "Forza Horizon 5"
  },
  "response": {
    "format": "json"
  }
}'
```

```python
# Save as fous.py and run with python3 fous.py. No packages needed.
# First set your key: export FOUS_API_KEY='YOUR_FOUS_API_KEY'
import json
import os
import urllib.error
import urllib.request

api_key = os.environ.get("FOUS_API_KEY")
if not api_key:
    raise RuntimeError("Set FOUS_API_KEY before running this example")

body = json.loads("{\n  \"api\": \"@xbox\",\n  \"visibility\": \"public\",\n  \"operation\": \"get_game\",\n  \"version\": 1,\n  \"input\": {\n    \"game\": \"Forza Horizon 5\"\n  },\n  \"response\": {\n    \"format\": \"json\"\n  }\n}")
request = urllib.request.Request(
    "https://api.fous.com/v1/query",
    data=json.dumps(body).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {api_key}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urllib.request.urlopen(request, timeout=120) as response:
        result = json.load(response)
except urllib.error.HTTPError as error:
    raise RuntimeError(f"HTTP {error.code}: {error.read().decode('utf-8', errors='replace')}") from error
if result.get("success") is False:
    raise RuntimeError(result.get("error", {}).get("message", "Request failed"))
print(json.dumps(result["data"]["output"], indent=2))
```

```typescript
// Save as fous.mts and run with npx tsx fous.mts.
// First set your key: export FOUS_API_KEY='YOUR_FOUS_API_KEY'
const apiKey = process.env.FOUS_API_KEY;
if (!apiKey) throw new Error("Set FOUS_API_KEY before running this example");

const response = await fetch("https://api.fous.com/v1/query", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  signal: AbortSignal.timeout(120_000),
  body: JSON.stringify({
  "api": "@xbox",
  "visibility": "public",
  "operation": "get_game",
  "version": 1,
  "input": {
    "game": "Forza Horizon 5"
  },
  "response": {
    "format": "json"
  }
}),
});
type ApiResult = { success: boolean; data?: { output: unknown }; error?: { message: string } };
const result: ApiResult = await response.json();
if (!response.ok || result.success === false) {
  throw new Error(result.error?.message ?? `HTTP ${response.status}`);
}
if (!result.data) throw new Error("Missing API response data");
console.log(result.data.output);
```

Or describe the data in plain language: send `{"api":"@xbox","prompt":"Describe the data you need, with every detail"}` to the same URL. Fous fills in the input, runs the method that fits and returns only the fields you asked for; `data.route.calls[].request` is the exact call it made. Routing is free; the run costs the same.

## Use cases

- Compare a game's prices and discounts by country.
- Check whether a game is included in a subscription plan.
- Browse subscription games by platform and list.
- Find discounted games for a country.
- Review game genres, ratings, platforms, and release dates.

## FAQ

### Is Fous affiliated with Xbox?

No. Fous is not affiliated with Xbox. This workflow reads the public xbox.com website and returns its data.

### How much does it cost?

Each run costs 1 credit. With pay-as-you-go, a credit costs 1¢; monthly plans cost less per credit.

### Do I need a Xbox account?

No. You only need a Fous account.

### How current is the data?

Fous gets the data from xbox.com when you run it; repeating the same request within a day may return the saved result. Fous checks this workflow automatically; it last passed a check on Sep 29, 2026.

### Is a game included in a subscription plan?

Get game returns whether the game is included and which plans include it.

### Which games are on sale in my country?

List deals returns games on sale in a country, ordered by discount, with prices and subscription availability.

### What games are available for console or PC?

List game pass games returns games for the selected list and platform, with details and store links.

## Related

- [Epic Games Store API](https://fous.com/workflows/epic-games-store.md): Epic Games Store provides current and upcoming free games, plus game details including country-specific prices and sales; free-game availability varies by country.
- [Steam API](https://fous.com/workflows/steam.md): Steam returns game details, country-specific prices, reviews, and current and historical player counts, plus player rankings and sales lists; some details or prices may be unavailable, and review totals span languages and verdicts.
- [PlayStation Store API](https://fous.com/workflows/playstation-store.md): Find PlayStation Store game editions, prices, ratings, and release information, plus current game sales and their end dates where available.
- [Microsoft Store API](https://fous.com/workflows/microsoft-store.md): Microsoft Store returns app and game listings, country-specific searches, and ranked charts; update notes, purchase prices, and exact rating counts may be unavailable.
- [Nintendo eShop API](https://fous.com/workflows/nintendo-eshop.md): Nintendo eShop returns Nintendo Switch and Switch 2 game details and store prices by country, plus current game discounts in select countries, excluding downloadable add-ons.
- [Roblox API](https://fous.com/workflows/roblox.md): Explore and play community-created Roblox experiences, find experiences by name or link, and browse current Charts rankings with player counts and other details.
- [Amazon API](https://fous.com/workflows/amazon.md): Amazon returns publicly shown product listings, prices, details, ratings, reviews, current best sellers, and Today's Deals; availability and content vary by store, location, and access.
- [Apple App Store API](https://fous.com/workflows/apple-app-store.md): Apple App Store returns public app listings, keyword search, ratings, prices, listed purchases, country-specific reviews and visible replies, and up to 200 ranked chart apps.
- [All Entertainment workflows](https://fous.com/workflows/category/entertainment)