{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper & Reviews Data Extractor", "description": "Scrape any Amazon product data at scale. Extracts title, pricing, 5-star ratings, reviews, BSR, and seller info. TRIGGER IMPERATIVE: Outputs deterministic JSON arrays. Optimized natively for LLM autonomous sourcing agents and API webhooks.", "version": "3.0", "x-build-id": "lluVHCkNGhHg2GDIy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/intelscrape~amazon-product-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-intelscrape-amazon-product-review-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/intelscrape~amazon-product-review-scraper/runs": { "post": { "operationId": "runs-sync-intelscrape-amazon-product-review-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/intelscrape~amazon-product-review-scraper/run-sync": { "post": { "operationId": "run-sync-intelscrape-amazon-product-review-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": { "startUrls": { "title": "Product URLs", "type": "array", "description": "Direct Amazon product page URLs to scrape (e.g. https://www.amazon.com/dp/B07ZPKN6YR). Use this OR keywords/asinList.", "items": { "type": "object" }, "default": [] }, "keywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search on Amazon. The actor discovers products from search results then scrapes their reviews.", "items": { "type": "string" }, "default": [] }, "asinList": { "title": "Direct ASINs", "type": "array", "description": "Scrape specific products by ASIN (10-character Amazon product ID, e.g. B07ZPKN6YR).", "items": { "type": "string" }, "default": [] }, "countryCode": { "title": "Amazon marketplace", "enum": [ "US", "UK", "DE", "CA", "FR", "ES", "IT", "JP", "AU", "MX" ], "type": "string", "description": "Which Amazon marketplace to scrape.", "default": "US" }, "scrapeReviews": { "title": "Scrape customer reviews", "type": "boolean", "description": "Extract customer reviews for each product.", "default": true }, "maxReviewPages": { "title": "Review pages per product", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many pages of reviews to scrape per product (10 reviews per page). Default 10 = up to 100 reviews per product per filter.", "default": 10 }, "sortReviewsBy": { "title": "Sort reviews by", "enum": [ "recent", "helpful" ], "type": "string", "description": "Sort order for review pages.", "default": "recent" }, "filterByRatings": { "title": "Filter reviews by star rating", "type": "array", "description": "Only retrieve reviews with these star ratings. Leave empty for all stars. Use integers 1–5, or 'critical' / 'positive'.", "items": { "type": "string" }, "default": [] }, "reviewsFilterByKeywords": { "title": "Search keywords within reviews", "type": "array", "description": "Filter reviews that contain these keywords in the review body. Example: ['quality', 'broke', 'love']", "items": { "type": "string" }, "default": [] }, "reviewsCutoffDate": { "title": "Reviews newer than (cutoff date)", "type": "string", "description": "Only scrape reviews newer than this date. Accepts YYYY-MM-DD, ISO 8601, or relative formats like '30 days', '3 months', '1 year'." }, "includeOtherCountriesReviews": { "title": "Include international reviews", "type": "boolean", "description": "Also fetch reviews from amazon.com (US) in addition to the selected marketplace. Useful for non-US markets.", "default": false }, "scrapeProductDetails": { "title": "Scrape product details", "type": "boolean", "description": "Extract full product data (price, BSR, images, features, seller info) alongside reviews. Disable for review-only scraping.", "default": true }, "maxProductsPerKeyword": { "title": "Max products per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of products to scrape per search keyword.", "default": 20 }, "minRating": { "title": "Minimum product rating filter", "minimum": 1, "maximum": 5, "type": "number", "description": "Only return products with this average star rating or higher (applies to product search, not reviews)." }, "minPrice": { "title": "Minimum price $ (optional)", "type": "number", "description": "Only return products priced at or above this value." }, "maxPrice": { "title": "Maximum price $ (optional)", "type": "number", "description": "Only return products priced at or below this value." }, "onlyInStock": { "title": "In-stock items only", "type": "boolean", "description": "Filter to only include products currently in stock.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used. Residential proxies are highly recommended for Amazon.", "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 } } }, "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 } } } } } } } } } }