Skip to content

Steam API notes

Daniel Tran edited this page Feb 21, 2022 · 1 revision

QueryRewardItems

This repository makes extensive use of the QueryRewardItems endpoint provided by the Steam API. In conjunction with xPaw's Steam Web API Documentation, this is the current understanding of how this endpoint works:

  • Use this endpoint to access Points Shop information about a particular app or item type.
  • count is the maximum number of items returned by the response.
    • This cannot go below 100, and doing so will result in the value being reset back to 100.
    • This cannot exceed 1000, and doing so will result in an empty response from the Steam API.
  • If the response returns more than 1000 items, you can use the cursor parameter to read the "next page" of items.
    • All responses will provide a next_cursor property, which can be used as the value for the cursor parameter.
    • If the provided cursor value results in an empty response, it most likely indicates that you have reached the end of your query results.
  • appids[X] is the app ID you want to obtain Points Shop item information for, where X is an integer which is 0 or higher.
    • If the numbering sequence breaks, only the parameters before the sequencing break are included with the request. For example, a request with the appids[0] and appids[2] parameters will only include appids[0], since appids[1] has not been supplied.
    • If two appids[X] parameters use the same underlying ID, the response will not double up on items for that app.
    • If two appids[X] parameters use the different underlying ID's, the response will only consider the first value.
    • Supplying an app ID of a game that has been removed from Steam will always return an empty response. The cursor will also be set to *.
  • The full query URL can go up to about 8000 characters in (conservative) length. URL's that are too long will result in a Bad Request error from the Steam API.

GetAppList v2

These are notes about the current behaviour of the GetAppList v2 endpoint provided by the Steam API:

  • Use this endpoint to access the list of available apps on Steam, providing both app ID and name information.
  • The app list does not include app ID's that exclusively exist on the Points Shop (e.g. Lunar New Year 2022, whose app ID is 1880140).
  • The app list includes app ID's of games that have been removed from Steam and the Points Shop (e.g. The Wizard's Lair, whose app ID is 507360).
  • Distinguishing between a Points Shop exclusive app and an app that has been removed from Steam is incredibly difficult using only data from the Steam API.
Clone this wiki locally