SteamStorefrontAPI/README.md
2018-08-19 11:00:07 +02:00

39 lines
1.6 KiB
Markdown

# SteamStorefrontAPI
[![nuget](https://img.shields.io/nuget/v/SteamStorefrontAPI.svg)](https://www.nuget.org/packages/SteamStorefrontAPI)
The SteamStorefrontAPI is a .NET wrapper for the steam storefront api which is exposed via Steam Big Picture. The API is not officially available or documented, all data in this library was either compiled by trial and error from the [inofficial api documentation](https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI), and is therefore provided as-is.
## Usage examples
```cs
using SteamStorefrontAPI;
using SteamStorefrontAPI.Classes;
static async Task Examples()
{
// Get details for SteamApp with ID 443790
SteamApp steamApp1 = await AppDetails.GetAsync(460810);
// Get details for SteamApp with ID 443790 for region US
SteamApp steamApp2 = await AppDetails.GetAsync(322330, "US");
// Get details for Package with ID 68179 for region
PackageInfo package1 = await PackageDetails.GetAsync(68179);
// Get details for Package with ID 68179 for region JP
PackageInfo package2 = await PackageDetails.GetAsync(68179, "JP");
// Get a list of featured games
FeaturedApps featured = await Featured.GetAsync();
// Get a list of featured games for region DE
FeaturedApps featured2 = await Featured.GetAsync("DE");
// Get a list of featured games grouped by category
List<FeaturedCategory> featuredCategories = await FeaturedCategories.GetAsync();
// Get a list of featured games grouped by category for region US
List<FeaturedCategory> featuredCategories2 = await FeaturedCategories.GetAsync("DE");
}
```