{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper — All Stars, Date Filter", "description": "Scrape unlimited Amazon product reviews by ASIN with filters for star rating, verified purchase, date range, and media. Includes product metadata. Supports 11 Amazon marketplaces.", "version": "1.0", "x-build-id": "ccxwMUG4RJ9tT2vao" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/totaka~amazon-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-totaka-amazon-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/totaka~amazon-reviews-scraper/runs": { "post": { "operationId": "runs-sync-totaka-amazon-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/totaka~amazon-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-totaka-amazon-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": [ "asins" ], "properties": { "asins": { "title": "Amazon ASINs", "type": "array", "description": "List of Amazon ASIN codes to scrape reviews for (e.g. [\"B08N5WRWNW\", \"B0BX2K13KH\"]).", "items": { "type": "string" } }, "marketplace": { "title": "Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.es", "amazon.it", "amazon.ca", "amazon.co.jp", "amazon.com.au", "amazon.in", "amazon.com.br" ], "type": "string", "description": "Amazon marketplace to scrape reviews from." }, "maxReviewsPerAsin": { "title": "Max reviews per ASIN", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of reviews to scrape per ASIN." }, "sortBy": { "title": "Sort reviews by", "enum": [ "recent", "helpful" ], "type": "string", "description": "Sort reviews by most recent or most helpful." }, "filterByRating": { "title": "Filter by star rating (1-5, empty = all)", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only scrape reviews of this star rating (1-5). Leave empty for all ratings." }, "verifiedOnly": { "title": "Verified purchase only", "type": "boolean", "description": "Only scrape reviews marked as Verified Purchase.", "default": false }, "mediaOnly": { "title": "Media reviews only", "type": "boolean", "description": "Only scrape reviews that include photos or videos.", "default": false }, "since": { "title": "From date (YYYY-MM-DD)", "type": "string", "description": "Only collect reviews on or after this date (YYYY-MM-DD). Leave empty for no start date." }, "until": { "title": "To date (YYYY-MM-DD)", "type": "string", "description": "Only collect reviews on or before this date (YYYY-MM-DD). Leave empty for no end date." }, "includeSellerResponse": { "title": "Include seller responses", "type": "boolean", "description": "Extract seller/brand responses to reviews when available.", "default": true }, "amazonCookies": { "title": "Amazon session cookies (optional but recommended)", "type": "string", "description": "Paste your Amazon session cookies to bypass login wall. In Chrome: DevTools → Network → any amazon.com request → Request Headers → Cookie. Key cookies: session-id, ubid-main, at-main, x-main." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies strongly recommended to avoid Amazon blocking." } } }, "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 } } } } } } } } } }