{
  "openapi": "3.0.1",
  "info": {
    "title": "Steam Game Reviews & Playtime Extractor",
    "description": "Pull Steam customer reviews for any game by URL or name, with thumbs up/down verdicts, reviewer playtime, helpfulness votes, and language filters.",
    "version": "1.0",
    "x-build-id": "GxuUpYbrzkiWxwZa1"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~steam-game-reviews-and-playtime-extractor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-steam-game-reviews-and-playtime-extractor",
        "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/dataspryva~steam-game-reviews-and-playtime-extractor/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-steam-game-reviews-and-playtime-extractor",
        "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/dataspryva~steam-game-reviews-and-playtime-extractor/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-steam-game-reviews-and-playtime-extractor",
        "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": "Mode",
            "enum": [
              "reviews",
              "gameSummary"
            ],
            "type": "string",
            "description": "reviews = one row per review; gameSummary = one row per game with metadata and overall score.",
            "default": "reviews"
          },
          "appIds": {
            "title": "Steam App IDs",
            "type": "array",
            "description": "Numeric app IDs, store URLs, community review URLs, or old appreviews URLs. Example: 1174180 or https://store.steampowered.com/app/1174180/",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Steam Game URLs (legacy)",
            "type": "array",
            "description": "Steam store page URLs for the games to scrape. Merged with appIds.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "gameNames": {
            "title": "Game Names",
            "type": "array",
            "description": "Search Steam by name. An exact case-insensitive title match is preferred over the first search result.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxReviews": {
            "title": "Max Reviews per Game",
            "minimum": 0,
            "maximum": 1000000,
            "type": "integer",
            "description": "Reviews to collect per game. Use 0 for every matching review (hard safety cap 1,000,000 per game).",
            "default": 50
          },
          "maxGames": {
            "title": "Max Games",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap the merged game list. Use 0 for no cap.",
            "default": 0
          },
          "reviewType": {
            "title": "Review Type",
            "enum": [
              "all",
              "positive",
              "negative"
            ],
            "type": "string",
            "description": "Filter reviews by recommendation verdict.",
            "default": "all"
          },
          "language": {
            "title": "Language",
            "enum": [
              "all",
              "english",
              "german",
              "french",
              "spanish",
              "latam",
              "portuguese",
              "brazilian",
              "russian",
              "schinese",
              "tchinese",
              "japanese",
              "koreana",
              "turkish",
              "italian",
              "dutch",
              "polish",
              "thai",
              "vietnamese",
              "indonesian",
              "bulgarian",
              "czech",
              "danish",
              "finnish",
              "greek",
              "hungarian",
              "norwegian",
              "romanian",
              "swedish",
              "ukrainian"
            ],
            "type": "string",
            "description": "Steam language code for review text. Select All Languages to include every language.",
            "default": "all"
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "recent",
              "helpful",
              "updated",
              "funny"
            ],
            "type": "string",
            "description": "recent and updated walk the full history; helpful is a ranked sample inside the helpfulness window; funny is also ranked and not exhaustive.",
            "default": "recent"
          },
          "helpfulWithinDays": {
            "title": "Helpful Window (days)",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Only for sortBy=helpful: rank reviews from the last 1-365 days. Use recent for full history.",
            "default": 30
          },
          "purchaseType": {
            "title": "Purchase Type",
            "enum": [
              "all",
              "steam",
              "nonSteamPurchase"
            ],
            "type": "string",
            "description": "Whether the reviewer acquired the game through Steam, outside Steam, or either.",
            "default": "all"
          },
          "minPlaytimeHours": {
            "title": "Minimum Playtime (hours)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Minimum hours played at the time of review. Use 0 for no minimum.",
            "default": 0
          },
          "maxPlaytimeHours": {
            "title": "Maximum Playtime (hours)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Maximum hours played at the time of review. Use 0 for no maximum.",
            "default": 0
          },
          "steamDeckOnly": {
            "title": "Steam Deck Only",
            "type": "boolean",
            "description": "Only reviews written while playing primarily on a Steam Deck.",
            "default": false
          },
          "includeOffTopic": {
            "title": "Include Off-Topic Reviews",
            "type": "boolean",
            "description": "Include reviews Steam hides as off-topic review-bomb activity. Off by default, matching the store.",
            "default": false
          },
          "useReviewQuality": {
            "title": "Use Review Quality Ranking",
            "type": "boolean",
            "description": "Only for sortBy=helpful: rank low-quality reviews lower.",
            "default": true
          },
          "reviewsFromDate": {
            "title": "Reviews From (YYYY-MM-DD)",
            "type": "string",
            "description": "Include reviews created on or after this UTC date."
          },
          "reviewsToDate": {
            "title": "Reviews To (YYYY-MM-DD)",
            "type": "string",
            "description": "Include reviews created on or before this UTC date."
          },
          "includeGameDetails": {
            "title": "Attach Game Details",
            "type": "boolean",
            "description": "mode=reviews: attach game metadata, price and overall review summary to every review row.",
            "default": false
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}