Endpoints are where you access the API. Each endpoint has a specific URL associated with it, this is where you send your request to. Each API does something different, this page explains what each API does and what you can do with it. All endpoints specified here have three elements, a URL, what request methods can be used and which fields you can use in your request.
Each of these endpoints will tell you which fields you can access from there. For GET methods you can retrieve all of these fields and filter on all of these fields, you can find more on that in the request methods documentation. For POST and PUT requests each endpopint which fields can be written to and which cannot be written to. Additionally for POST requests it will specify if you need to supply it in your request in order to create a new object. For optional fields each endpoint will also show you the default value if you choose to not supply it.
Users
The users endpoints lets you get, update, create and remove users. This is useful for companies that want to manage their users automatically using internal systems or information. Users created this way will receive an e-mail where they can configure a password.
URL
https://app.steamdatasuite.com/api/user/
Allowed operations
Search, Create, Update, Delete
Fields
| Fields | Writable | Type | Default | Description |
|---|---|---|---|---|
| id | Forbidden | Integer | - | Identifier for this user. |
| username | Forbidden | String | - | Username of this user, will be set to the same as e-mail address. Used to login to Steam Data Suite. |
| Required | String | - | E-mail address of this user. Must be unique. | |
| first_name | Required | String | - | This users first name. |
| last_name | Required | String | - | This users last name. |
| is_admin | Optional | Boolean | False | If this user has admin rights or not. |
| usergroups_list | Optional | List[Integer] | [] | A list of IDs for user groups this user is part of. |
Permissions
This endpoints allows you to manage what users can view data from which games, this is managed through permission groups. This endpoints allows you to manage permission groups and which users/games belong to that group. A user can only view data from games in permission groups they belong to.
URL
https://app.steamdatasuite.com/api/permission/
Allowed operations
Search, Create, Update, Delete
Fields
| Fields | Writable | Type | Default | Description |
|---|---|---|---|---|
| id | Forbidden | Integer | - | Identifier for this permission group. |
| name | Required | String | - | Name of this usergroup for easier identification. Must be unique for each account. |
| is_admin_group | Forbidden | Boolean | False | A group containing all admin users, these users have access to all games in this account. To change if a user is an admin, use the User endpoint. There can only be one admin group and cannot be updated. |
| is_default_group | Forbidden | Boolean | False | Group where new users are automatically assigned to. There is only one default group. This group can be edited. |
| auto_assign | Optional | Boolean | False | Decides if newly added games are added to this group. |
| users_list | Optional | List[Integer] | [] | A list of IDs for users assigned to this group. |
| games_list | Optional | List[Integer] | [] | A list of IDs for games assigned to this group. This is not the steamid, but the internal ID. You can get this ID from the Games endpoint. |
Games
The games endpoint can be used for retrieving the internal ID of your games. This endpoint only returns you games. This ID can be used to manage permissions for users.
URL
https://app.steamdatasuite.com/api/owned-game/
Allowed operations
Search
Fields
| Fields | Type | Description |
|---|---|---|
| id | Integer | Identifier for this game. |
| steamid | Integer | SteamID of this game. |
| name | String | This games name. |
| type | String | What type of game this is, for example “game”, “DLC”, “demo”, “music”. |
| package_list | List | A list of package IDs that belong to this game. |
| item_list | String | A list of item IDs which belong to this game. |
Sales data
This endpoint can be used to query the sales data of packages and items that belong to your account. Information this endpoint provides only covers sales data, for data about wishlists and visibility, see the App data endpoint.
URL
https://app.steamdatasuite.com/api/sales-data/
Allowed operations
Search
Fields
| Fields | Type | Description |
|---|---|---|
| main_game_steamid | Integer | SteamID of the main game for this package/item. |
| game_steamid | Integer | SteamID of the game this belongs to. If this is the same as the main game SteamID, this is the main game. To change the what game this package/item belongs to, go to the games setup page and click the game you want to manage the package and items for. |
| package_id | Integer | Package ID of this package. This is empty when the sales record is not for a package but for an item. |
| item_id | Integer | Item ID of this package. This is empty if the sales record regards a package. |
| game_name | String | Name of the game this package/item belongs to. |
| units_sold_gross | Integer | Amount of package/item sales in this period, excluding key activations; free licences and does not account for returned units. |
| units_sold_net | Integer | Amount of sales for this package/item minus the amount of returned units. |
| units_returned | Integer | Amount of retuns/refunds for this package/item. |
| key_units_sold_gross | Integer | Amount of key activations for this package/item, this number does not account for returned/refunded units. |
| key_units_sold_net | Integer | Amount of key activations for this package/item minus the amount of returned units. |
| flg_units_gross | Integer | Amount of free linceses granted for this package/item. |
| flg_units_net | Integer | Amount of free linceses granted for this package/item. Accounting for revoked lincenses. |
| revenue_usd_gross | Decimal | Revenue for this package/item in USD, not accounting for tax or refunds. |
| revenue_usd_vat | Decimal | Tax paid over the revenue made for this package/item. |
| revenue_usd_net | Decimal | Revenue made by this package/item minus tax and refunds. |
| returned_usd | Decimal | Amount of USD refunded for this package/item. |
| date_range | String | A string of two dates seperated by a comma character. Can be used to filter for a specific date range. Cannot be queried, can only be used in a filter. Example: 2022-01-01,2022-12-31 |
App data
This endpoint can be used to query data on app level. Since sales are not available at app-level, you cannot query this information via this endpoint. To do this, see the Sales data endpoint.
URL
https://app.steamdatasuite.com/api/app-data/
Allowed operations
Search
Fields
| Fields | Type | Description |
|---|---|---|
| main_game_steamid | Integer | SteamID of the main game for this package/item. |
| game_steamid | Integer | SteamID of the game this belongs to. If this is the same as the main game SteamID, this is the main game. |
| game_name | String | Name of the game this package/item belongs to. |
| type | String | The type of app this record is for, can be Game, DLC, Music, Demo, etc. |
| impressions | Integer | Number of times a link to the storepage for this app was shown to a player. |
| visits | Integer | Number fo times a player visited the storepage for this app. |
| owner_impressions | Integer | Number of times an owner for this app has been shown a link to the storepage of this app. |
| owner_visits | Integer | Number of times an owner of this app visited the storepage of this app. |
| review_all_count_delta | Integer | The total amount of reviews that were added during the requested period for this app. |
| review_all_positive_count_delta | Integer | The total amount of positive reviews added during the requested period for this app. |
| review_all_count | Integer | Total amount of reviews during the end of the requested period. |
| review_all_positive_count | Integer | Total amount of positive reviews during the end of the requested period. |
| review_positive_share | Float | Review sentiment during the end of the requested period. |
| wishlist_additions | Integer | Number of wishlists added to this app during the requested time period. |
| wishlist_removals | Integer | Number of wishlists removed from this app during the requested time period. |
| wishlist_purchases | Integer | Amount of wishlists that resulted in a player buying this app for themselves. |
| wishlist_gifts | Integer | Amount of wishlists that resulted in a player gifting this app to another player. |
| net_wishlist_additions | Integer | Number od wishlist additions minus the number of removed wishlists. |
| wishlist_conversions | Integer | Amount of wishlists that converted to a purchase, the sum of wishlist gifts and purchases. |
| wishlist_balance | Integer | The total amount of outstanding wishlists for this app at the end of the requested period |
| dau | Integer | Average amount of daily active users during the requested period. |
| date_range | String | A string of two dates seperated by a comma character. Can be used to filter for a specific date range. Cannot be queried, can only be used in a filter. Example: "2022-01-01,2022-12-31" |
Game data
Games data returns the available data for a game, this excludes things like tags, features, etc. to keep this endpoint fast. This is mainly useful for getting current competitor data for Steam, like their estimated lifetime revenue, price, etc.
URL
https://app.steamdatasuite.com/api/game-data/
Allowed operations
Search
Fields
| Fields | Type | Description |
|---|---|---|
| steamid | Integer | SteamID of this game. |
| name | String | Name of this game. |
| type | String | What type of game this is, for example “game”, “DLC”, “demo”, “music”. |
| slug | String | URL-safe version of the game name. |
| storepage_url | String | URL to the steam storepage. |
| date_released | String | The initial release date of the game. Release dates in the past that are in early_access have been in early access since that date. Formatted like "DD-MM-YYYY". |
| early_access | Boolean | True if this game is currently in early access. |
| price_euro | Float | Game price in euro. |
| metacritic_url | String | URL to metacritic for this game. |
| website_url | String | URL to this games website. |
| support_url | String | URL to this games support website. |
| support_email | String | Email address to get support for this game. |
| thumbnail | String | URL to the thumbnail of this game. |
| description | Sring | Description of the game on the steam storepage. |
| followers | Integer | Current number of followers on steam for this game. |
| hubmembers | Integer | Current number of hubmembers on steam for this game. |
| review_all_count | Integer | Total number of reviews for this game. |
| popularity_rank | Integer | Number that represents how well the game performs. Closer to 0 is worse, 100 is the best. |
| estimated_sales | Integer | Estimated number of sales of this game for its total lifetime. |
| estimated_revenue | Integer | Estimated revenue for this game in dollars for its total lifetime. |
| estimated_wishlists | Integer | Estimated wishlist balance for this game. |
Game attributes
The game attributes endpoint allows you to get more in-depth data for a game, that includes information on current tags & features and allows allows you to get the SteamID of DLC for this game. Mainly, this endpoint can be user to filter out potential competitors more granularity.
URL
https://app.steamdatasuite.com/api/game-attribute/
Allowed operations
Search
Fields
| Fields | Type | Description |
|---|---|---|
| steamid | Integer | SteamID of this game. |
| name | String | Name of this game. |
| type | String | What type of game this is, for example “game”, “DLC”, “demo”, “music”. |
| type_list | List[String] | The types of the game, this includes the OS, if it is F2P and “coming soon” status. |
| feature_list | List[String] | List of features this game has, like multiplayer of controller support. |
| genre_list | List[String] | List of genres this game falls under. |
| tag_list | List[String] | List of tags assigned to this game on steam. |
| language_list | List[String] | Languages this game is available in. |
| dlc_steamid | List[String] | List of steamids for DLC of this game, can be used to find all DLC of this game. |