{ "openapi": "3.0.1", "info": { "title": "Amazon Complete Reviews Scraper", "description": "Extract reviews from page 1 to the last.\n\nThis is a high-performance scraper designed to extract Amazon product reviews. Unlike standard scrapers, it supports persistent user sessions, allowing you to scrape all review pages until the very last review is reached, ensuring a 100% complete dataset.", "version": "0.0", "x-build-id": "CrcQ6oLVhBVn6pLrO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/autosoldier~amazon-complete-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-autosoldier-amazon-complete-reviews-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/autosoldier~amazon-complete-reviews-scraper/runs": { "post": { "operationId": "runs-sync-autosoldier-amazon-complete-reviews-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/autosoldier~amazon-complete-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-autosoldier-amazon-complete-reviews-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": [ "asin", "action" ], "properties": { "action": { "title": "Action", "enum": [ "get-top-reviews", "get-all-reviews" ], "type": "string", "description": "Select the scraping mode.", "default": "get-top-reviews" }, "asin": { "title": "Amazon ASIN", "minLength": 10, "maxLength": 10, "type": "string", "description": "The 10-character Amazon ASIN (e.g., B0F5YNX43T)." }, "paginate": { "title": "Auto-Paginate?", "type": "boolean", "description": "If true, the scraper will follow 'Next Page' until reviews run out or your spend limit is reached.", "default": false }, "page": { "title": "Starting Page", "minimum": 1, "type": "integer", "description": "Which page to start scraping from. Leave empty to start from the first page.", "default": 1 }, "max_pages": { "title": "Max Pages", "minimum": 1, "type": "integer", "description": "Optional: Maximum number of pages to scrape. Leave empty to scrape all available reviews." }, "sort_by": { "title": "Sort Reviews By", "enum": [ "recent", "helpful" ], "type": "string", "description": "How to sort reviews.", "default": "helpful" }, "country": { "title": "Marketplace Country", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "JP", "AU", "MX", "BR", "IN", "NL", "SE", "PL", "TR", "SG", "AE", "SA" ], "type": "string", "description": "Amazon marketplace to scrape (country code or domain). Defaults to US.", "default": "US" }, "section_auth": { "title": "Advanced / Authentication", "type": "string", "description": "Settings for persistent sessions and 'Get All Reviews' mode." }, "api_key": { "title": "Client API Key", "type": "string", "description": "Used to track sticky sessions across multiple runs." }, "cookies": { "title": "Authentication Cookies", "type": "array", "description": "Required ONLY for 'Get All Reviews'. Paste your JSON cookie list export here. You can use browser extensions like 'EditThisCookie' to export cookies from your logged-in Amazon session." } } }, "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 } } } } } } } } } }