{
  "openapi": "3.0.1",
  "info": {
    "title": "Steam Scraper — Games, Prices, Reviews & Charts",
    "description": "Scrape the Steam store: search games, full game details, prices & discounts, user reviews with sentiment, top sellers / new releases / specials charts, and SteamSpy owner & player stats. Publisher leads (website, support email), monitoring mode, any storefront. No login, no key, no browser.",
    "version": "0.1",
    "x-build-id": "UXg7jB97vVZgpLrch"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~steam-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-steam-scraper",
        "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/scrapesage~steam-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-steam-scraper",
        "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/scrapesage~steam-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-steam-scraper",
        "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 scrape",
            "enum": [
              "search",
              "appDetails",
              "charts",
              "reviews"
            ],
            "type": "string",
            "description": "Pick a job. Search finds games by keyword (or browse all). App details pulls the full record for specific games. Charts lists top sellers / new releases / specials / coming soon. Reviews pulls user reviews with a sentiment summary.",
            "default": "search"
          },
          "searchTerms": {
            "title": "Search terms",
            "type": "array",
            "description": "Keywords to search the Steam store for, e.g. <code>roguelike</code>, <code>city builder</code>. One row per term. (Mode: Search.)",
            "items": {
              "type": "string"
            }
          },
          "appIds": {
            "title": "App IDs / store URLs",
            "type": "array",
            "description": "Numeric Steam app IDs (e.g. <code>730</code>, <code>292030</code>) or full store URLs (e.g. <code>https://store.steampowered.com/app/292030/</code>). Used by the App details and Reviews modes.",
            "items": {
              "type": "string"
            }
          },
          "collection": {
            "title": "Chart",
            "enum": [
              "top_sellers",
              "specials",
              "new_releases",
              "coming_soon"
            ],
            "type": "string",
            "description": "Which Steam chart to pull. (Mode: Charts.)",
            "default": "top_sellers"
          },
          "sortBy": {
            "title": "Sort search results by",
            "enum": [
              "relevance",
              "release_date",
              "reviews",
              "price_asc",
              "price_desc",
              "name"
            ],
            "type": "string",
            "description": "Ordering for the Search mode discovery results.",
            "default": "relevance"
          },
          "onlySpecials": {
            "title": "Only discounted games (Search)",
            "type": "boolean",
            "description": "In Search mode, return only games currently on sale. Leave Search terms empty with this on to browse ALL discounted games store-wide.",
            "default": false
          },
          "maxAppsPerQuery": {
            "title": "Max games per query",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Cap the number of games returned per search term or chart.",
            "default": 50
          },
          "fullDetails": {
            "title": "Enrich chart games with full details",
            "type": "boolean",
            "description": "For Charts, open each game for the complete record (full description, genres, categories, platforms, metacritic, release date, screenshots…). Off = a faster, lighter list (name, price, discount). Search always returns full records.",
            "default": true
          },
          "includeSteamSpy": {
            "title": "Include SteamSpy stats",
            "type": "boolean",
            "description": "Add SteamSpy enrichment to each full game record: estimated owners, peak concurrent players, average/median playtime, positive/negative votes and community tags — data the official store API does not expose.",
            "default": true
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "How many reviews to fetch per app (Mode: Reviews). Steam paginates 100 at a time via a cursor; set high to capture the full history.",
            "default": 100
          },
          "reviewsFilter": {
            "title": "Review order",
            "enum": [
              "recent",
              "updated",
              "all"
            ],
            "type": "string",
            "description": "How reviews are ordered. <code>recent</code> = newest first (best for monitoring), <code>updated</code> = recently updated, <code>all</code> = Steam's relevance ranking. (Mode: Reviews.)",
            "default": "recent"
          },
          "reviewLanguage": {
            "title": "Review language",
            "type": "string",
            "description": "Steam language code to filter reviews (e.g. <code>english</code>, <code>schinese</code>, <code>russian</code>), or <code>all</code> for every language. (Mode: Reviews.)",
            "default": "all"
          },
          "reviewType": {
            "title": "Review type",
            "enum": [
              "all",
              "positive",
              "negative"
            ],
            "type": "string",
            "description": "Limit reviews to positive, negative, or all. (Mode: Reviews.)",
            "default": "all"
          },
          "purchaseType": {
            "title": "Purchase type",
            "enum": [
              "all",
              "steam",
              "non_steam_purchase"
            ],
            "type": "string",
            "description": "Limit reviews to Steam purchasers, non-Steam (key) activations, or all. (Mode: Reviews.)",
            "default": "all"
          },
          "country": {
            "title": "Country / storefront",
            "type": "string",
            "description": "Two-letter country code (e.g. <code>us</code>, <code>gb</code>, <code>de</code>, <code>br</code>). Affects pricing and availability.",
            "default": "us"
          },
          "language": {
            "title": "Language",
            "type": "string",
            "description": "Steam language for store text (e.g. <code>en</code>, <code>de</code>, <code>french</code>). Affects descriptions, genres and category labels.",
            "default": "en"
          },
          "monitorMode": {
            "title": "Monitoring mode — only new records",
            "type": "boolean",
            "description": "Remember what was already returned and emit ONLY records not seen in previous runs (new games for a search/chart, or new reviews for an app). Pairs with Apify Schedules to track changes over time.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' ids for monitoring mode. Use a different name per tracked target/query to keep their histories separate.",
            "default": "steam-monitor"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Maximum parallel requests. Lower it if you hit rate limits on very large runs.",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Steam's public store endpoints have no hard anti-bot, so the default Apify proxy is plenty; rotating IPs avoids per-IP rate limits on large runs.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}