{
"openapi": "3.0.1",
"info": {
"title": "Amazon Reviews Scraper",
"description": "Scrape reviews from Amazon products: rating score, review text, reactions, and images. Filter by rating, keyword, or date, and sort by top or most recent.",
"version": "0.0",
"x-build-id": "ZdXMQeneifN5tFFNl"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/techbellys~amazon-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-techbellys-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/techbellys~amazon-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-techbellys-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/techbellys~amazon-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-techbellys-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": "URLs of Amazon products",
"uniqueItems": true,
"type": "array",
"description": "Enter the URL or URLs of the Amazon products you want to scrape.
(E.g., https://www.amazon.in/dp/B0FD724D8W). Click + Add or use Bulk edit to paste a whole list from the Brand Product Finder.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxReviews": {
"title": "Max reviews per product",
"minimum": 0,
"type": "integer",
"description": "How many reviews to keep per product. Amazon serves about 8 reviews per product detail page without a signed-in session, so higher values have no effect today."
},
"includeGdprSensitive": {
"title": "Include personal information",
"type": "boolean",
"description": "Personal data such as name, ID or profile image is protected by GDPR in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so.",
"default": false
},
"sort": {
"title": "Sort reviews by",
"enum": [
"helpful",
"recent"
],
"type": "string",
"description": "Select by which criteria the reviews should be sorted. Amazon's default is Top reviews.",
"default": "helpful"
},
"reviewsCutoffDate": {
"title": "Newer than",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])(T[0-2]\\d:[0-5]\\d(:[0-5]\\d)?(\\.\\d+)?Z?)?$|^(\\d+)\\s*(minute|hour|day|week|month|year)s?$",
"type": "string",
"description": "Limit how far back to the history the scraper should go. The date should be in YYYY-MM-DD or full ISO absolute format or in relative format e.g. 1 days, 2 months, 3 years. All time values are taken in UTC timezone."
},
"filterByRatings": {
"title": "Filter by ratings",
"type": "array",
"description": "Select the number of stars by which reviews should be filtered. Amazon's default is All stars.",
"items": {
"type": "string",
"enum": [
"allStars",
"fiveStar",
"fourStar",
"threeStar",
"twoStar",
"oneStar",
"positive",
"critical"
],
"enumTitles": [
"All stars",
"5 star",
"4 star",
"3 star",
"2 star",
"1 star",
"All positive",
"All critical"
]
},
"default": [
"allStars"
]
},
"reviewsUseProductVariantFilter": {
"title": "Scrape a single product variant",
"type": "boolean",
"description": "If the product has multiple variants (e.g., different colors, sizes, etc.), you can scrape reviews only for the selected variant.",
"default": false
},
"reviewsFilterByKeywords": {
"title": "Search by keywords",
"type": "array",
"description": "Enter keywords by which the reviews should be filtered.",
"items": {
"type": "string"
}
},
"scrapeProductDetails": {
"title": "Scrape product details",
"type": "boolean",
"description": "If enabled, the Actor will scrape and save product data in the product output field.",
"default": false
},
"reviewsAlwaysSaveCategoryData": {
"title": "Always save category data",
"type": "boolean",
"description": "If enabled, the Actor will return the review category data even if there are no reviews.",
"default": false
},
"deduplicateRedirectedAsins": {
"title": "Deduplicate redirected ASINs",
"type": "boolean",
"description": "If set, the crawler will deduplicate the redirected ASINs.",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}