{ "openapi": "3.0.1", "info": { "title": "Amazon Reviews Scraper", "description": "Extract public Amazon product review previews with ratings, titles, text, dates, verification, variants, images, and helpful votes. Accept product URLs or ASINs and export flat review records.", "version": "0.1", "x-build-id": "9DOdwPEbBOUPEPpVQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~amazon-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-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/mlg14~amazon-reviews-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-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/mlg14~amazon-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-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": { "productUrls": { "title": "Product URLs", "type": "array", "description": "Amazon product links (amazon.com, .co.uk, .de, .in and other domains, a.co short links). Each product yields the public review preview shown on its product page. You can also use the ASINs field.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "asins": { "title": "ASINs", "type": "array", "description": "10-character Amazon product IDs such as B0CWXNS552 (amazon.com). Use product URLs for other Amazon domains.", "default": [], "items": { "type": "string" } }, "maxReviews": { "title": "Max reviews per product", "minimum": 0, "type": "integer", "description": "Maximum matching visible reviews to save per product. The public page usually exposes about 8–13 reviews.", "default": 100 }, "maxItems": { "title": "Max reviews overall", "minimum": 0, "type": "integer", "description": "Hard limit across all products. Zero means no overall cap.", "default": 0 }, "sort": { "title": "Sort visible reviews", "enum": [ "helpful", "recent" ], "type": "string", "description": "Keep the page order or sort the visible review preview by date. This does not fetch additional reviews.", "default": "helpful" }, "filterByRatings": { "title": "Ratings", "type": "array", "description": "Keep visible reviews matching these star groups. Overlapping groups are deduplicated.", "items": { "type": "string", "enum": [ "allStars", "fiveStar", "fourStar", "threeStar", "twoStar", "oneStar", "positive", "critical" ], "enumTitles": [ "All stars", "5 stars", "4 stars", "3 stars", "2 stars", "1 star", "4–5 stars", "1–3 stars" ] }, "default": [ "allStars" ] }, "reviewsFilterByKeywords": { "title": "Keywords", "type": "array", "description": "Keep a visible review when its title or text contains any supplied keyword, ignoring case.", "default": [], "items": { "type": "string" } }, "reviewsCutoffDate": { "title": "Reviewed since", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Keep visible reviews on or after this date in YYYY-MM-DD format." }, "includeGdprSensitive": { "title": "Include reviewer name", "type": "boolean", "description": "Include the public display name of each reviewer only when you have a legitimate use for it.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings for requests. Datacenter is attempted first, then a US residential browser when blocked.", "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 } } } } } } } } } }