{
"openapi": "3.0.1",
"info": {
"title": "Steam Review & Sentiment Analyzer",
"description": "Scrape Steam game reviews and get a ready-made sentiment report: Steam score, recent vs lifetime trend, review-bomb detection, per-language sentiment, positivity by playtime and top complaint keywords. Also exports full reviews, monthly review history and user reviews. No login.",
"version": "0.0",
"x-build-id": "JX6CJ9tV0leI2ZBPP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/fanndev~steam-review-sentiment-analyzer/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-fanndev-steam-review-sentiment-analyzer",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/fanndev~steam-review-sentiment-analyzer/runs": {
"post": {
"operationId": "runs-sync-fanndev-steam-review-sentiment-analyzer",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/fanndev~steam-review-sentiment-analyzer/run-sync": {
"post": {
"operationId": "run-sync-fanndev-steam-review-sentiment-analyzer",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "What to extract",
"enum": [
"summary",
"reviews",
"history",
"languages",
"userReviews"
],
"type": "string",
"description": "summary: one sentiment report per game. reviews: every review with its text. history: positive/negative counts per month and per day for the last 30 days, with review-bomb flags. languages: score per review language. userReviews: all reviews a Steam user has published.",
"default": "summary"
},
"apps": {
"title": "Games",
"type": "array",
"description": "Steam app IDs, store/community URLs, or game names (a name is matched to the first Steam search result). Used by summary, reviews, history and languages.",
"items": {
"type": "string"
}
},
"steamUsers": {
"title": "Steam users",
"type": "array",
"description": "Profile URLs (steamcommunity.com/id/... or /profiles/...), SteamID64s or custom URL names. Used by userReviews. Private profiles return a 'private_profile' row.",
"items": {
"type": "string"
}
},
"maxReviewsPerApp": {
"title": "Max reviews per game / user",
"minimum": 1,
"type": "integer",
"description": "Cap for the reviews and userReviews modes. Steam serves 100 reviews per request, so 1,000 reviews = 10 requests.",
"default": 500
},
"sortBy": {
"title": "Review order",
"enum": [
"recent",
"updated",
"all"
],
"type": "string",
"description": "Newest first is the only order that walks the WHOLE review history. 'Most helpful' is limited by Steam to reviews posted in the last Most-helpful window days.",
"default": "recent"
},
"language": {
"title": "Review language",
"enum": [
"all",
"english",
"schinese",
"tchinese",
"russian",
"brazilian",
"portuguese",
"spanish",
"latam",
"german",
"french",
"japanese",
"koreana",
"polish",
"turkish",
"italian",
"ukrainian",
"czech",
"thai",
"vietnamese",
"indonesian",
"dutch",
"swedish",
"danish",
"finnish",
"norwegian",
"hungarian",
"romanian",
"greek",
"bulgarian",
"arabic"
],
"type": "string",
"description": "Only reviews written in this language (reviews mode and the summary's review sample). Text sentiment is computed for English reviews only.",
"default": "all"
},
"purchaseType": {
"title": "Purchase type",
"enum": [
"all",
"steam",
"non_steam_purchase"
],
"type": "string",
"description": "Steam's store score counts Steam purchases only; key buyers can add 10-40% more reviews.",
"default": "all"
},
"reviewType": {
"title": "Positive / negative",
"enum": [
"all",
"positive",
"negative"
],
"type": "string",
"description": "Reviews mode only.",
"default": "all"
},
"startDate": {
"title": "Reviews posted from",
"type": "string",
"description": "YYYY-MM-DD. With 'Newest first' the scan stops as soon as it passes this date, so incremental runs are cheap."
},
"endDate": {
"title": "Reviews posted until",
"type": "string",
"description": "YYYY-MM-DD, inclusive."
},
"minPlaytimeHours": {
"title": "Min playtime (hours)",
"minimum": 0,
"type": "integer",
"description": "Only reviews whose author had at least this many hours in the game when reviewing."
},
"maxPlaytimeHours": {
"title": "Max playtime (hours)",
"minimum": 0,
"type": "integer",
"description": "Only reviews written with at most this many hours played."
},
"helpfulDayRange": {
"title": "Most-helpful window (days)",
"minimum": 1,
"maximum": 365,
"type": "integer",
"description": "Only for 'Most helpful' order. Steam caps it at 365.",
"default": 365
},
"includeOffTopicReviews": {
"title": "Include off-topic review activity",
"type": "boolean",
"description": "Steam hides reviews from periods it flagged as off-topic (review bombs). Turn on to include them.",
"default": false
},
"textSentiment": {
"title": "Text sentiment score",
"type": "boolean",
"description": "Adds a VADER sentiment score to each English review and flags reviews whose text contradicts their thumbs up/down.",
"default": true
},
"sampleSize": {
"title": "Summary: reviews to analyse",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Summary mode reads this many newest reviews to compute playtime, Steam Deck, refund and keyword breakdowns. 0 = totals and trend only.",
"default": 300
},
"languages": {
"title": "Summary / languages: language list",
"type": "array",
"description": "Languages to break down. Empty = 11 biggest languages for summary, all 30 for the languages mode.",
"items": {
"type": "string"
}
},
"country": {
"title": "Store country",
"type": "string",
"description": "Two-letter country code for prices and name search.",
"default": "us"
},
"maxConcurrency": {
"title": "Parallel games",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many games/users are processed in parallel. Without a proxy they share one IP and one rate-limit budget, so more parallelism does not speed things up.",
"default": 3
},
"maxRetries": {
"title": "Max retries per request",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Retries per request on rate limits, server errors or network failures, with exponential backoff.",
"default": 8
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Steam has no bot wall but rate-limits each IP (~46 review requests/min). A proxy gives every game its own IP and swaps it on a rate limit, so big jobs finish much faster. Without one the actor still works, just paced.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}