{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper with Advanced Filters", "description": "Extract Amazon reviews from any ASIN or URL across 16 Amazon marketplaces: rating, title, text, date, country, photos, videos, verified badge and helpful votes, plus Amazon's AI “Customers say” summary. Filter by stars, verified purchase, media, keywords and date.", "version": "0.0", "x-build-id": "QbzKXXDBcSYoNgJLf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-delicious_zebu-amazon-reviews-scraper-with-advanced-filters", "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/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/runs": { "post": { "operationId": "runs-sync-delicious_zebu-amazon-reviews-scraper-with-advanced-filters", "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/delicious_zebu~amazon-reviews-scraper-with-advanced-filters/run-sync": { "post": { "operationId": "run-sync-delicious_zebu-amazon-reviews-scraper-with-advanced-filters", "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": [ "ASIN_or_URL" ], "properties": { "ASIN_or_URL": { "title": "ASIN or Product URL", "maxItems": 10000, "uniqueItems": false, "type": "array", "description": "Provide either an ASIN (E.G., B0CC1F5CGH) or a product URL (E.G., https://www.amazon.com/iPad-8th-Gen-Cellular-Renewed/dp/B0BFC42HQR).", "items": { "type": "string" } }, "country": { "title": "ASIN Country", "enum": [ "United States", "Canada", "United Kingdom", "Germany (Deutschland)", "France", "Italy (Italia)", "Mexico (México)", "Spain (España)", "India", "Brazil (Brasil)", "Belgium (Belgique)", "Netherlands (Nederland)", "Sweden (Sverige)", "Poland (Polska)", "Singapore", "Australia" ], "type": "string", "description": "Select the country corresponding to the ASIN. This determines the marketplace from which reviews will be scraped. Default: United States.", "default": "United States" }, "End_date": { "title": "End Date", "type": "string", "description": "Select the end date to scrape all reviews from today until this specified date.", "default": "1990-01-01" }, "recent_days": { "title": "Recent Days", "minimum": 0, "type": "integer", "description": "Collect reviews from the past N days only. (This parameter defaults to 0, meaning it is not set. If a value is provided, it will override the 'End Date' parameter above. For example: Passing 5 will collect data from the last 5 days.)", "default": 0 }, "unique_only": { "title": "Unique Reviews Only", "type": "boolean", "description": "Enable this option to deduplicate reviews. If disabled, the same review may appear multiple times in different filters (e.g., both 'All stars' and '5 star only').", "default": false }, "get_customers_say": { "title": "Get AI Review Summary (Customers Say)", "type": "boolean", "description": "Enable this to scrape the 'Customers say' AI-generated review summary. Default: Enabled.", "default": true }, "max_reviews": { "title": "Maximum Reviews", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to collect per ASIN. Default: 15. Enter 0 to collect all available reviews (up to 10,000 per ASIN).", "default": 15 }, "sort_reviews_by": { "title": "Sort Reviews By", "type": "array", "description": "Select how to sort reviews. Default: All options ('Top reviews' and 'Most recent') are selected.", "items": { "type": "string", "enum": [ "helpful", "recent" ], "enumTitles": [ "Top reviews", "Most recent" ] }, "default": [ "helpful", "recent" ] }, "filter_by_verified_purchase_only": { "title": "Filter By Verified Purchase", "type": "array", "description": "Filter reviews based on purchase verification. Default: All options ('All reviewers' and 'Verified purchase only') are selected.", "items": { "type": "string", "enum": [ "all_reviews", "avp_only_reviews" ], "enumTitles": [ "All reviewers", "Verified purchase only" ] }, "default": [ "all_reviews", "avp_only_reviews" ] }, "filter_by_ratings": { "title": "Filter By Ratings", "type": "array", "description": "Filter reviews by star rating, the same options as the star filter on Amazon's reviews page. Default: all options selected for the widest coverage. Amazon shows at most 100 reviews per filter, so combining filters is how you collect more.", "items": { "type": "string", "enum": [ "all_stars", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ], "enumTitles": [ "All stars", "5 star only", "4 star only", "3 star only", "2 star only", "1 star only", "Positive reviews", "Critical reviews" ] }, "default": [ "all_stars", "five_star", "four_star", "three_star", "two_star", "one_star", "positive", "critical" ] }, "filter_by_mediaType": { "title": "Filter By Media Type", "type": "array", "description": "Filter reviews by media content. Default: All options ('Text, image, video' and 'Image and video reviews only') are selected.", "items": { "type": "string", "enum": [ "all_contents", "media_reviews_only" ], "enumTitles": [ "Text, image, video", "Image and video reviews only" ] }, "default": [ "all_contents", "media_reviews_only" ] }, "variant_scope": { "title": "Variant Filter (All Variants vs Current Variant)", "enum": [ "all_variants", "current_variant" ], "type": "string", "description": "Choose which reviews to collect for each ASIN. This mirrors the 'All variants' dropdown on Amazon's own reviews page. 'All variants' (default) collects reviews from every variant under the parent listing (the original behavior). 'Current variant only' collects reviews for ONLY the specific variant (child ASIN) you provided. Note: 'Current variant only' usually returns far fewer reviews per ASIN, because each variant only has its own reviews.", "default": "all_variants" }, "filter_by_keywords": { "title": "Filter by Keywords", "type": "array", "description": "You can specify keywords to filter the collected results (optional). For example: good, perfect, cheap (case-sensitive). Only reviews containing AT LEAST ONE of these keywords (with exact case matching) will be retained. Reviews without any matching keywords will be excluded from collection.", "default": [], "items": { "type": "string" } }, "include_personal_data": { "title": "Include personal data", "type": "boolean", "description": "Include the reviewer's display name, profile URL and reviewer ID (fields Reviewer, ReviewerProfileUrl, ReviewerId). Turn it off to receive these three fields empty. You are responsible for complying with GDPR and other data protection laws when processing personal data.", "default": 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 } } } } } } } } } }