{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper", "description": "Scrape Amazon product reviews for review monitoring — ratings, review text, verified purchase status, helpful votes, and review dates. Pair with Amazon price monitoring.", "version": "0.1", "x-build-id": "XHwobNh0qKtdbTIPT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~amazon-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-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/automation-lab~amazon-reviews-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-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/automation-lab~amazon-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-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": "⭐ ASINs or Product URLs", "maxItems": 50, "type": "array", "description": "List of Amazon ASINs (e.g. B08C1KN5J2) or full product URLs. Mix of both is supported — ASINs are extracted from URLs automatically. Safety cap: max 50 unique ASINs per run; split larger jobs into multiple runs for clearer progress and lower abort risk.", "items": { "type": "string" } }, "marketplace": { "title": "🌍 Amazon Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "JP", "IN", "AU" ], "type": "string", "description": "Which Amazon marketplace to scrape. Proxy country is set automatically to match the marketplace.", "default": "US" }, "maxReviewsPerProduct": { "title": "📊 Max Reviews per Product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of reviews to scrape per ASIN. Amazon embeds 8–14 reviews on each product page. The actor extracts all available reviews from the product page, then attempts pagination for more. Due to Amazon's anti-bot measures, most runs return 8–14 reviews per product. For large ASIN batches, keep this near the default and split jobs rather than starting multi-thousand review runs.", "default": 20 }, "sort": { "title": "🔀 Sort Order", "enum": [ "recent", "helpful" ], "type": "string", "description": "Sort reviews by most recent date or by most helpful votes.", "default": "recent" }, "filterByStars": { "title": "⭐ Filter by Star Rating", "enum": [ "all", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ], "type": "string", "description": "Only scrape reviews with a specific star rating, or positive/critical reviews.", "default": "all" }, "maxRequestRetries": { "title": "🔄 Max Retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of retry attempts for failed or blocked HTTP requests per page. Default is 2. Increasing this may help on spotty connections, but raises cost per failed run — the actor will also abort early if 2 consecutive pages are blocked regardless of this setting.", "default": 2 } } }, "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 } } } } } } } } } }