{ "openapi": "3.0.1", "info": { "title": "Amazon Review Scraper - Ratings, Text, Verified, by ASIN", "description": "Extract Amazon reviews by ASIN: rating, full text, verified flag, reviewer, date, helpful votes, variant, plus aggregate rating and the 'Customers say' AI summary. Fast anonymous route needs no login. For more history use reviewDepth=deep with your own Amazon cookie (self-hosted).", "version": "0.1", "x-build-id": "z56SpuDHnTB5Z24qR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/renzomacar~amazon-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-renzomacar-amazon-reviews", "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/renzomacar~amazon-reviews/runs": { "post": { "operationId": "runs-sync-renzomacar-amazon-reviews", "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/renzomacar~amazon-reviews/run-sync": { "post": { "operationId": "run-sync-renzomacar-amazon-reviews", "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": "ASINs or product URLs", "type": "array", "description": "Amazon ASINs (e.g. 'B08N5WRWNW') or full product URLs. The ASIN is auto-extracted from URLs.", "items": { "type": "string" } }, "marketplace": { "title": "Amazon Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.com.mx", "amazon.com.br" ], "type": "string", "description": "Which Amazon domain to scrape reviews from.", "default": "amazon.com" }, "maxReviewsPerAsin": { "title": "Max reviews per ASIN", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of reviews to extract per ASIN. Amazon caps anonymous access at roughly 100 (10 pages) before requiring sign-in; the actor stops cleanly when Amazon gates further pages.", "default": 100 }, "sortBy": { "title": "Sort reviews by", "enum": [ "recent", "helpful" ], "type": "string", "description": "Order reviews by most recent or most helpful. With reviewDepth=\"fast\" the sort is applied locally over the ~13-review /dp/ medley; use reviewDepth=\"deep\" to sort across all reviews.", "default": "recent" }, "filterByStar": { "title": "Filter by star rating", "enum": [ "all", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ], "type": "string", "description": "Only return reviews matching this star filter. NOTE on depth: with reviewDepth=\"fast\" the filter is applied locally over the embedded /dp/ medley (~13 reviews), so it narrows that small universe (the run logs a FILTER_APPLIED_FAST warning showing how many matched). To filter across the product's FULL review set, use reviewDepth=\"deep\". 'Positive' = 4-5 stars, 'Critical' = 1-2 stars.", "default": "all" }, "reviewDepth": { "title": "Review depth", "enum": [ "fast", "deep" ], "type": "string", "description": "fast = anonymous scraper (~10-20 reviews/ASIN + aggregate rating + 'Customers say' AI summary, no login required). deep = paginate past the anonymous ceiling (up to ~100/ASIN per star filter) using YOUR OWN Amazon session cookie supplied in 'amazonCookies'. Deep needs a cookie; if 'deep' is selected without one, the run records a warning and falls back to fast.", "default": "fast" }, "maxConcurrency": { "title": "Max concurrent pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "Number of review pages to process in parallel. Lower is safer against bot detection.", "default": 3 }, "amazonCookies": { "title": "Amazon session cookies (optional, unlocks deep pagination)", "type": "string", "description": "OPTIONAL (enables reviewDepth=\"deep\"). Paste YOUR OWN logged-in Amazon Cookie header to page PAST the ~13-review anonymous ceiling (up to ~100/ASIN per star filter). Get it from DevTools -> Application -> Cookies -> https://www.amazon.com -> copy these into a single 'name=value; name=value' string: at-main, sess-at-main, session-id, session-id-time, session-token, ubid-main, x-main (lc-main and i18n-prefs optional). Leave EMPTY to use the free anonymous route (~10-20 reviews/ASIN). Cookies expire - if Amazon rejects them the run records a COOKIE_EXPIRED warning and falls back to the anonymous medley. This is YOUR session: use a throwaway Amazon account, never your primary login." } } }, "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 } } } } } } } } } }