Methods for reading Steam user reviews.
Use this interface to get a dump of the reviews on an application in Steam. It replaces
below.
This is a Service interface, methods in this interface should be called with the
parameter.
.
| Name | Type | Required | Description |
|---|
| key | string | | (Optional) Steamworks Web API publisher authentication key. Pass a key associated with the app to get the higher rate limit. |
| appid | uint32 | ✔ | App to get reviews for. |
| filter | int32 | | IUserReviewsService#EUserReviewsAppReviewsFilter. Sort order of the results. Defaults to k_EUserReviewsAppReviewsFilter_Helpful, which widens day_range until it finds results, so it will always return reviews. If paging through all the reviews with cursor, use Recent or Updated to eventually receive an empty list. |
| languages | string[] | | API language codes to return reviews in (see Languages Supported on Steam). Empty means english; "all" means every language. Example usage: languages[0]='english', languages[1]='french', etc. |
| day_range | uint32 | | Only used by the Helpful filter. Number of days back from today to look for reviews. Defaults to 30, max 365; 0 means no limit. |
| cursor | string | | Cursor to paginate through the results. Set to '*' or omit for the first request, then pass the cursor value returned in the previous response. Cursor values may contain characters that need to be URL-encoded. |
| review_type | int32 | | IUserReviewsService#EUserReviewsReviewType. Defaults to k_EUserReviewsReviewType_All. |
| purchase_type | int32 | | IUserReviewsService#EUserReviewsPurchaseType. Defaults to k_EUserReviewsPurchaseType_Steam. |
| num_per_page | uint32 | | Number of reviews to return per page. Defaults to 20, max 100. |
| filter_offtopic_activity | bool | | By default, off-topic reviews (aka "Review Bombs") are filtered out. Pass false to include them. See here. |
| display_language | string | | API language code for review_score_desc in the response. Defaults to english. |
| use_review_quality | bool | | Helpful filter only. Ranks reviews that Steam has judged to be low quality (ASCII art, memes, off-topic, uninformative, vote farming) below the others. Defaults to true. If false, the Helpful filter sorts by weighted_vote_score and, unless day_range is 0, only returns reviews with a score of at least 0.5 and at least one helpful vote. |
| date_range_start | uint32 | | Unix timestamp. Only return reviews created at or after this time. Ignored unless date_range_end is also set. |
| date_range_end | uint32 | | Unix timestamp. Only return reviews created at or before this time. Ignored unless date_range_start is also set. |
| date_range_exclude | bool | | If true, exclude reviews inside the date range instead of returning only them. |
| playtime_min_hours | uint32 | | Only return reviews whose author had at least this many hours in the app when the review was written. |
| playtime_max_hours | uint32 | | Only return reviews whose author had at most this many hours in the app when the review was written. |
| primarily_steam_deck | bool | | Only return reviews whose author had played more than half their time on Steam Deck when the review was written. |
| hardware_os | string | | Only return reviews written on hardware with this operating system. |
| hardware_cpu | string | | Only return reviews written on hardware with this CPU. |
| hardware_gpu | string | | Only return reviews written on hardware with this GPU. |
| hardware_device_type | string | | Only return reviews written on this type of device. |
Gets a page of public reviews for an app.
This method does not require a key, and anonymous responses may be cached for up to 10 minutes. Calls without a key associated with the app share a lower rate limit; a rate-limited call returns HTTP 429.
| Name | Type | Description |
|---|
| query_summary | {message} | Totals for the query. num_reviews is the number of reviews on this page. The score fields (review_score, review_score_desc, total_positive, total_negative, total_reviews) are only returned on the first page, and only when review_type is k_EUserReviewsReviewType_All. |
| reviews | {message}[] | The reviews on this page. See below. |
| cursor | string | Pass this as cursor to get the next page. |
| day_range_used | uint32 | Helpful filter only. The day range actually searched. Can be wider than day_range when the requested range had no reviews; 0 means no limit. |
| total_matching | uint32 | Total number of reviews that match the query. |
| Name | Type | Description |
|---|
| recommendationid | uint64 | Unique ID of the review. |
| author | {message} | See below. |
| language | string | API language code the review was written in. |
| review | string | Text of the review. |
| timestamp_created | uint32 | Unix timestamp when the review was created. |
| timestamp_updated | uint32 | Unix timestamp when the review was last updated. |
| voted_up | bool | True if this is a positive review. |
| votes_up | uint32 | Number of users who found this review helpful. |
| votes_funny | uint32 | Number of users who found this review funny. |
| weighted_vote_score | float | Helpfulness score. |
| comment_count | uint32 | Number of comments posted on this review. |
| steam_purchase | bool | True if the author purchased the app on Steam. |
| received_for_free | bool | True if the author checked the box saying they got the app for free. |
| written_during_early_access | bool | True if the review was written while the app was in Early Access. |
| developer_response | string | Text of the developer's response, if any. |
| timestamp_dev_responded | uint32 | Unix timestamp when the developer responded. |
| primarily_steam_deck | bool | True if the author played primarily on Steam Deck when the review was written. |
| refunded | bool | True if the author was refunded for the app. |
| hardware | {message} | The hardware the author chose to show on the review, if any. See below. |
is deprecated. GetAppReviews takes the same filters, with these differences:
These are enums which are defined for use with IUserReviewsService.
How to sort the results of GetAppReviews.
