{
"openapi": "3.0.1",
"info": {
"title": "Amazon Reviews Scraper API",
"description": "Scrape Amazon product reviews with correct ratings, publish dates and verified-purchase status, plus Amazon's own aspect sentiment. Priced per product, not per review.",
"version": "0.1",
"x-build-id": "Obgm8qXZm63uKg942"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/shakamize~amazon-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-shakamize-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/shakamize~amazon-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-shakamize-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/shakamize~amazon-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-shakamize-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",
"required": [
"productUrls"
],
"properties": {
"productUrls": {
"title": "Product URLs or ASINs",
"type": "array",
"description": "The products whose reviews you want. Accepts full Amazon product URLs or bare 10-character ASINs, and every entry is scraped. A bare ASIN is resolved against the marketplace the other URLs point at, or against Marketplace below.",
"items": {
"type": "string"
}
},
"maxReviewsPerProduct": {
"title": "Max reviews per product",
"minimum": 1,
"type": "integer",
"description": "Cap the reviews kept per product. Leave empty for everything Amazon publishes, which is 8 to 20 for a product with real review volume and fewer for one with few ratings. Read What Amazon actually serves in the README before setting this high: there is no page two to fetch."
},
"filterByRatings": {
"title": "Filter by star rating",
"type": "array",
"description": "Keep only reviews at these star ratings. Applied to the reviews Amazon publishes on the product page, because its own star-filtered pages require a signed-in Amazon account and are not reachable.",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"enumTitles": [
"1 star",
"2 stars",
"3 stars",
"4 stars",
"5 stars"
]
}
},
"verifiedPurchaseOnly": {
"title": "Verified purchases only",
"type": "boolean",
"description": "Keep only reviews carrying Amazon's Verified Purchase badge.",
"default": false
},
"reviewsCutoffDate": {
"title": "Only reviews since",
"type": "string",
"description": "Drop reviews older than this. Absolute (2026-01-15) or relative (30 days, 6 months, 1 year). A review whose date could not be parsed is kept rather than silently dropped."
},
"sort": {
"title": "Sort by",
"enum": [
"helpful",
"recent",
"rating-high",
"rating-low"
],
"type": "string",
"description": "Order of the returned reviews. Top reviews keeps Amazon's own ranking, which is the order the page renders.",
"default": "helpful"
},
"includeAspectSentiment": {
"title": "Include aspect sentiment",
"type": "boolean",
"description": "Amazon's own per-aspect breakdown, computed over every review a product has rather than over the ones on the page: mention counts, the positive and negative split, and a sentence per aspect.",
"default": true
},
"includeReviewerProfile": {
"title": "Include reviewer name and profile",
"type": "boolean",
"description": "A reviewer's name and profile id are personal data, protected by GDPR in the EU and by comparable rules elsewhere. Enable this only if you have a legitimate reason to hold it.",
"default": false
},
"countryCode": {
"title": "Marketplace",
"enum": [
"US",
"CA",
"MX",
"BR",
"GB",
"IE",
"DE",
"FR",
"IT",
"ES",
"NL",
"BE",
"SE",
"PL",
"TR",
"AE",
"SA",
"EG",
"IN",
"JP",
"SG",
"AU",
"ZA"
],
"type": "string",
"description": "Which Amazon storefront to read. Ignored when the product URLs already name one.",
"default": "US"
},
"language": {
"title": "Language",
"type": "string",
"description": "Ask Amazon for the page in this language, when the marketplace offers it. Review dates and helpful-vote counts are parsed in whatever language comes back."
},
"proxyCountry": {
"title": "Proxy country",
"type": "string",
"description": "Exit country for the proxy. Defaults to the marketplace's own country, which is what Amazon expects to see."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Amazon serves an anti-bot interstitial to unproxied clients, so a residential proxy is effectively required.",
"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
}
}
}
}
}
}
}
}
}
}