{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper — Product Reviews, Ratings & Insights", "description": "Scrape Amazon product reviews at scale. Extract review text, ratings, verified purchase status, helpfulness votes, and reviewer info. Filter by star rating and sort order. Multi-domain support.", "version": "1.0", "x-build-id": "BjjmhsOpvB48l1330" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~amazon-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-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/junipr~amazon-reviews-scraper/runs": { "post": { "operationId": "runs-sync-junipr-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/junipr~amazon-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-junipr-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": { "asins": { "title": "Product ASINs", "type": "array", "description": "Amazon product ASINs to scrape reviews for (e.g. \"B0D5CRCWXC\"). 10-character alphanumeric identifiers found in Amazon product URLs.", "items": { "type": "string" }, "default": [ "B0D5CRCWXC" ] }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Direct Amazon product URLs. The ASIN will be extracted automatically from each URL. Use this instead of ASINs if you already have product links.", "items": { "type": "string" }, "default": [] }, "maxReviews": { "title": "Max Reviews Per Product", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of reviews to extract per product. Amazon caps visible reviews at approximately 500.", "default": 100 }, "filterRating": { "title": "Filter by Rating", "enum": [ "all", "5", "4", "3", "2", "1", "positive", "critical" ], "type": "string", "description": "Filter reviews by star rating. Use 'positive' for 4-5 stars, 'critical' for 1-3 stars, or a specific star number.", "default": "all" }, "filterVerified": { "title": "Verified Purchases Only", "type": "boolean", "description": "Only extract reviews marked as verified purchases.", "default": false }, "sortBy": { "title": "Sort By", "enum": [ "recent", "helpful", "top_reviews" ], "type": "string", "description": "Sort order for reviews. 'recent' shows newest first, 'helpful' shows most helpful first.", "default": "recent" }, "dateFrom": { "title": "Date From", "type": "string", "description": "Only extract reviews after this date (YYYY-MM-DD format). Leave empty for no date filter.", "default": "" }, "dateTo": { "title": "Date To", "type": "string", "description": "Only extract reviews before this date (YYYY-MM-DD format). Leave empty for no date filter.", "default": "" }, "searchKeyword": { "title": "Search Keyword", "type": "string", "description": "Search within reviews for a specific keyword or phrase. Only reviews containing the keyword will be returned.", "default": "" }, "includeImages": { "title": "Include Review Images", "type": "boolean", "description": "Extract image URLs attached to reviews.", "default": true }, "includeProductInfo": { "title": "Include Product Info", "type": "boolean", "description": "Include product name, price, and overall rating in each review row.", "default": true }, "marketplace": { "title": "Amazon Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "AU", "JP", "IN", "BR", "MX" ], "type": "string", "description": "Amazon marketplace to scrape reviews from. Determines the Amazon domain used.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Review language filter. Set to 'auto' to use the marketplace default language.", "default": "auto" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy is required — Amazon blocks datacenter IPs aggressively. Defaults to Apify residential proxy (requires paid Apify plan). Free-plan users can provide their own residential proxy URL.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }