Game Pass API

This project provides a quick and easy way to get a list of all games currently available on Xbox Game Pass on a given platform (Console, PC or through EA Play) in a given region.

Using the configuration file, the type and format of many properties can be customized, from simply getting the game's names all the way to fetching store prices at the moment of the request.

Take a look at the section below to learn how to use the configuration file, or take a look at the examples and work from there.

Run npm install to install the required dependencies first.

Following this, create a config.json file in the root directory of the project and fill it with your desired configuration.

After providing the config.json configuration file, you can run the script using

node index.js

You will find the resulting data in the created output folder.

Unsure how it works? Take a look at the examples for some inspiration.

The project provides an extensive JSON validation schema for the required configuration file, which offers guidance on the possible properties that can be extracted from the API, as well as options for formatting the resulting data.

Are you missing a property? Feel free to open an issue and I will see what I can do. Alternatively, fork the repository and open a Pull Request.

The schema can be found in the config.schema.json file and used within your config.json by adding the following property:

"$schema": "config.schema.json"

NOTE: The script will test your provided config.json against this schema, so make sure your configuration is valid.

The following is a list of all configuration items, their defaults and the values they can take.

If a given property is not present in the configuration file, it will automatically be assumed to have a value of false (or equivalent, depending on the property type).

"productDescription": {
	"enabled": true,
	"preferShort": false
}

"imageTypes": {
	"TitledHeroArt": -1,
	"SuperHeroArt": -1,
	"Logo": -1,
	"Poster": -1,
	"Screenshot": -1,
	"BoxArt": -1,
	"Hero": -1,
	"BrandedKeyArt": -1,
	"FeaturePromotionalSquareArt": -1
}

"releaseDate": {
	"enabled": true,
	"format": "date"
}

"userRating": {
	"enabled": true,
	"aggregationInterval": "AllTime",
	"format": "percentage"
}

"pricing": {
	"enabled": true,
	"priceTypes": [
		"ListPrice",
		"MSRP",
		"WholesalePrice"
	],
	"missingPricePolicy": "useZero"
}

If you would like to know the Steam App ID's for the games you own on Steam, Epic Games or GOG, you can use the Steam App ID Finder to do just that.

You can then use the Notion Steam API Integration to automatically add information about those games to your Notion database.

Alternatively, you can use the JSON to Notion tool to directly create a new page in your Notion database for each game extracted using the Game Pass API - this tool works with any kind of JSON file!

If you have any question, feedback or feature requests, feel free to open an issue.