{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper", "description": "Get Amazon product reviews by ASIN or product URL. Each row has the rating, title, full text, author, date, country, verified-purchase badge, helpful votes and review photos. Amazon shows signed-out visitors about 8 reviews per product, so that is what comes back. $2.00 per 1,000 reviews.", "version": "0.1", "x-build-id": "v517WrRZygfFKJMkL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~amazon-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-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/dami_studio~amazon-reviews-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-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/dami_studio~amazon-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-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", "properties": { "products": { "title": "Product URLs or ASINs", "type": "array", "description": "Amazon product URLs or 10-character ASINs. This review-only actor does not scrape product catalog or search results.", "default": [], "items": { "type": "string" } }, "marketplace": { "title": "Amazon marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "ca" ], "type": "string", "description": "Amazon marketplace for plain ASIN inputs. Only amazon.com and amazon.ca return reviews. A run on co.uk, de, fr, it or es comes back with a BLOCKED row instead, so read the README before planning one.", "default": "com" }, "maxProducts": { "title": "Maximum products", "minimum": 1, "maximum": 10, "type": "integer", "description": "Hard limit on unique products per run. Keeping this small makes review costs predictable.", "default": 3 }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Upper bound on reviews kept per product. Amazon shows roughly 8 reviews per product to signed-out visitors, so values above that simply keep whatever it served.", "default": 20 }, "deadlineSecs": { "title": "Run deadline (seconds)", "minimum": 10, "maximum": 150, "type": "integer", "description": "Actor-side wall-clock deadline, independent of the Apify timeout. An uncharged diagnostic is returned when it is reached.", "default": 90 }, "enableProxyFallback": { "title": "Enable one proxy retry", "type": "boolean", "description": "Leave this off for almost every run. Switched on, the run retries one page that fails or comes back without its reviews, through your own proxy servers if you add them below. Without any, that retry usually returns the product page with no reviews on it. The product is then reported as BLOCKED rather than as having none.", "default": false }, "enableResidentialFallback": { "title": "Enable one proxy retry (deprecated name)", "type": "boolean", "description": "Deprecated alias of \"Enable one proxy retry\", kept so existing saved inputs keep working. It switches on the same single retry, so use the other switch in new runs.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only used for the one retry above, and only when it is switched on. Proxy servers of your own, if you enter any, are used exactly as given.", "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 }, "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 } } } } } } } } } }