{
"openapi": "3.0.1",
"info": {
"title": "Amazon Reviews Scraper – Ratings, Photos & Monitoring",
"description": "Scrape Amazon reviews for any ASIN or URL on 20 Amazon sites: rating, title, text, date, country, variant, verified badge, helpful votes and photos. Sign in once in Live View for full lists with star, keyword and media filters. First 100 reviews every month free.",
"version": "0.3",
"x-build-id": "kdUrSTRIRtcTkgS8U"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/k-data-lab~amazon-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-k-data-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/k-data-lab~amazon-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-k-data-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/k-data-lab~amazon-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-k-data-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",
"properties": {
"mode": {
"title": "Mode",
"enum": [
"scrape",
"login"
],
"type": "string",
"description": "Scrape collects reviews. Login opens a real browser in the run's Live View tab where you sign in to your own Amazon shopper account; the session is saved privately in your Apify account and later Scrape runs reuse it. Never needs your password in the input.",
"default": "scrape"
},
"products": {
"title": "Products (ASINs or URLs)",
"type": "array",
"description": "One per line: an ASIN (uses the marketplace below) or a product / review page URL from any Amazon site (uses that site).",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace for bare ASINs",
"enum": [
"com",
"co.uk",
"de",
"fr",
"it",
"es",
"nl",
"se",
"pl",
"com.tr",
"co.jp",
"in",
"ca",
"com.mx",
"com.br",
"com.au",
"ae",
"sa",
"sg",
"com.be"
],
"type": "string",
"description": "Used for lines that are only an ASIN.",
"default": "com"
},
"maxReviewsPerProduct": {
"title": "Max reviews per product",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Amazon lists at most 100 reviews per sort/filter, so above 100 the actor also walks each star rating and the other sort order (de-duplicated). 0 = everything reachable (usually up to ~1,000).",
"default": 100
},
"sort": {
"title": "Sort",
"enum": [
"recent",
"helpful"
],
"type": "string",
"description": "Order of the review list.",
"default": "recent"
},
"filterByStar": {
"title": "Star rating",
"enum": [
"all_stars",
"five_star",
"four_star",
"three_star",
"two_star",
"one_star",
"positive",
"critical"
],
"type": "string",
"description": "Only reviews with this rating.",
"default": "all_stars"
},
"verifiedOnly": {
"title": "Verified purchases only",
"type": "boolean",
"description": "Only reviews with the Verified Purchase badge.",
"default": false
},
"withMediaOnly": {
"title": "With photos or videos only",
"type": "boolean",
"description": "Only reviews that include images or video.",
"default": false
},
"currentVariantOnly": {
"title": "This variant only",
"type": "boolean",
"description": "Only reviews of the exact variant (size/colour) in the link, not the whole product family.",
"default": false
},
"keyword": {
"title": "Keyword",
"type": "string",
"description": "Only reviews containing this word or phrase (Amazon's own review search)."
},
"reviewsFromDaysAgo": {
"title": "Only reviews from the last N days",
"minimum": 1,
"maximum": 3650,
"type": "integer",
"description": "Skip older reviews. With 'Most recent' sort the actor also stops paging early, so runs are faster and cheaper."
},
"minReviewDate": {
"title": "Only reviews on/after",
"type": "string",
"description": "Absolute date alternative to the field above (yyyy-mm-dd)."
},
"onlyNewReviews": {
"title": "Only new reviews (monitoring)",
"type": "boolean",
"description": "Remember delivered review IDs (in your own Apify account) and return only reviews you haven't received before. Perfect for a daily schedule: each review is delivered and billed once.",
"default": false
},
"loginMarketplaces": {
"title": "Login: marketplaces to sign in to",
"type": "array",
"description": "Login mode only. Defaults to the marketplaces of your products (or the marketplace above).",
"items": {
"type": "string",
"enum": [
"com",
"co.uk",
"de",
"fr",
"it",
"es",
"nl",
"se",
"pl",
"com.tr",
"co.jp",
"in",
"ca",
"com.mx",
"com.br",
"com.au",
"ae",
"sa",
"sg",
"com.be"
],
"enumTitles": [
"🇺🇸 amazon.com",
"🇬🇧 amazon.co.uk",
"🇩🇪 amazon.de",
"🇫🇷 amazon.fr",
"🇮🇹 amazon.it",
"🇪🇸 amazon.es",
"🇳🇱 amazon.nl",
"🇸🇪 amazon.se",
"🇵🇱 amazon.pl",
"🇹🇷 amazon.com.tr",
"🇯🇵 amazon.co.jp",
"🇮🇳 amazon.in",
"🇨🇦 amazon.ca",
"🇲🇽 amazon.com.mx",
"🇧🇷 amazon.com.br",
"🇦🇺 amazon.com.au",
"🇦🇪 amazon.ae",
"🇸🇦 amazon.sa",
"🇸🇬 amazon.sg",
"🇧🇪 amazon.com.be"
]
}
},
"loginTimeoutMinutes": {
"title": "Login: minutes per marketplace",
"minimum": 2,
"maximum": 30,
"type": "integer",
"description": "How long Login mode waits for you to finish signing in on each marketplace.",
"default": 10
},
"useSavedSessions": {
"title": "Use saved sessions",
"type": "boolean",
"description": "Use the sessions saved by Login mode (stored privately in your own Apify account).",
"default": true
},
"saveSessions": {
"title": "Keep sessions fresh",
"type": "boolean",
"description": "Save the cookies Amazon refreshes during a run, so the session lasts longer.",
"default": true
},
"sessionStoreName": {
"title": "Session store name",
"type": "string",
"description": "Named key-value store in your account that holds your sessions, monitoring history and free-quota counter. Use different names to keep several Amazon accounts apart.",
"default": "amazon-review-sessions"
},
"sessionCookie": {
"title": "Paste a session instead (optional)",
"type": "string",
"description": "Advanced: instead of Login mode, paste a Cookie-Editor JSON export or the Cookie header from your signed-in amazon. tab. Applies to the marketplace above (single-marketplace runs)."
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Signed-in runs use one sticky residential IP in the marketplace's country by default; signed-out runs use datacenter IPs.",
"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
}
}
}
}
}
}
}
}
}
}