Expand description
§Steam Web API Rust SDK
steam-webapi-rust-sdk is a set of utility functions to access Steam Web API.
In order to use this library make sure to set STEAM_WEB_API_KEY system environment variable.
The library itself tries to minimize number of networks calls through the caching relevant responses to the ‘steam-webapi-cache’ folder.
There is already prebuilt cache for all steam apps, in order to use it, simply clone steam-webapi-cache into the root folder of your project.
Modules§
- idota2match_
570 - iplayer_
service - isteam_
apps - isteam_
news - isteam_
user - isteam_
user_ stats - store_
steampowered_ com - util
Functions§
- convert_
32bit_ account_ id_ to_ 64bit - Converts given 32 bit Steam account id to 64 bit
- convert_
64bit_ account_ id_ to_ 32bit - Converts given 64 bit Steam account id to 32 bit
- get_
app_ details - Retrieves details for the given app id. It will make an API call to Steam and cache response. It may return an error if API responded with error response. As an example it may be exceeding the limit of calls from one IP address or if the response contains not valid UTF-8 characters. Usually Steam API allows 200 requests from single IP address within 5 minutes range.
- get_
app_ list - Retrieves list of apps available on Steam. Each item consists of 2 fields: appid and name
- get_
badges - Retrieves a Steam account’s badges and badge XP progress.
- get_
cached_ app_ details - Retrieves details for the given app id from the local cache. It may return an error if requested resource is absent, malformed or not readable from local cache.
- get_
cached_ app_ list - Retrieves list of apps available on Steam. First tries to get it from local cache. Each item consists of 2 fields: appid and name
- get_
cached_ dota2_ match_ details - Retrieves match details for the given Dota2 match id from the local cache. It may return an error if requested resource is absent, malformed or not readable from local cache.
- get_
dota2_ heroes - Retrieves the list of all Dota2 heroes.
- get_
dota2_ league_ listing - Retrieves the list of Dota2 leagues.
- get_
dota2_ live_ league_ games - Retrieves currently live Dota2 league games.
- get_
dota2_ match_ details - Retrieves match details for the given Dota2 match id. It will make an API call to Steam and cache the response.
- get_
dota2_ match_ history - Retrieves list of matches from Dota2
- get_
dota2_ team_ info_ by_ team_ id - Retrieves Dota2 team info, paginated by team id.
- get_
friend_ list - Retrieves a Steam account’s friend list. Returns an error if the profile’s friends list is not public.
- get_
global_ achievement_ percentages_ for_ app - Retrieves the global completion percentage for each achievement of a given app. Does not require a Steam Web API key.
- get_
news_ for_ app - Retrieves news items for a given app. Does not require a Steam Web API key.
- get_
number_ of_ current_ players - Retrieves the current number of players in-game for a given app. Does not require a Steam Web API key.
- get_
owned_ games - Retrieves the games a Steam account owns, and optionally their playtime.
- get_
player_ achievements - Retrieves a Steam account’s achievement status for a given app. Returns an error if the account’s stats for the game aren’t public.
- get_
player_ bans - Retrieves VAC/game/community ban status for up to 100 SteamIDs.
- get_
player_ summaries - Retrieves public profile summaries (up to 100 SteamIDs per call) via
ISteamUser/GetPlayerSummaries. - get_
recently_ played_ games - Retrieves games played by a Steam account in the last two weeks.
- get_
schema_ for_ game - Retrieves the stat and achievement schema (names, display names, descriptions) for a given app.
- get_
steam_ level - Retrieves a Steam account’s Steam level.
- get_
user_ stats_ for_ game - Retrieves a Steam account’s stats and achievements for a given app.
- resolve_
vanity_ url - Resolves a Steam Community vanity URL (e.g.
steamcommunity.com/id/<vanity>) to a 64-bit SteamID.