{ "openapi": "3.0.1", "info": { "title": "Amazon Product Details Scraper With Ratings & Reviews", "description": "Amazon Product Details Scraper extracts detailed Amazon product data, including ratings, reviews, prices, product titles, specifications, seller information, availability, and product URLs. Ideal for product research, competitor analysis, price monitoring, review analysis, and e-commerce insights.", "version": "0.1", "x-build-id": "xfCeAmLfmRO4p1esB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~amazon-product-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-amazon-product-details-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/scrapier~amazon-product-details-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-amazon-product-details-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/scrapier~amazon-product-details-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-amazon-product-details-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": [ "asins" ], "properties": { "productAsins": { "title": "πŸ“š Products to analyse", "type": "array", "description": "ASINs or full Amazon product addresses. Accepts B00FLYWNYQ, https://www.amazon.com/dp/B00FLYWNYQ and /gp/product/ links. Merged with anything in the legacy ASIN list below, duplicates removed.", "items": { "type": "string" } }, "asins": { "title": "πŸ”Ž Amazon ASINs (legacy field)", "type": "array", "description": "The original ASIN list. Still fully supported, so an input JSON written for the previous version keeps working unchanged. Its values are merged with the list above.", "items": { "type": "string" } }, "includeStarBreakdown": { "title": "⭐ Include the 5-star rating distribution", "type": "boolean", "description": "Adds starsBreakdown (fiveStar…oneStar, in percent), the five flat percent columns, starsBreakdownSum, positiveReviewShare (5β˜…+4β˜…) and criticalReviewShare (2β˜…+1β˜…). The five percentages always add up to 100, so the row checks itself. Default is on.", "default": true }, "estimateReviewCounts": { "title": "πŸ”’ Estimate a rating count per star bucket", "type": "boolean", "description": "Adds starsBreakdownCounts = each bucket's percentage applied to countReview. These are rounded estimates, flagged as such by starsBreakdownCountsAreEstimates, because Amazon publishes percentages and not per-bucket totals. Default is on.", "default": true }, "emitReviewRows": { "title": "πŸ’¬ Emit one row per review", "type": "boolean", "description": "Adds a labelled child row (type = review, isChild = true) for every review kept, alongside the product row, and mirrors those rows into a per-run reviews dataset. Turn off to get product rows only. Default is on.", "default": true }, "maxReviewsPerProduct": { "title": "πŸ” Maximum reviews per product", "minimum": 0, "type": "integer", "description": "Caps how many reviews are kept per product after the filters below are applied. Example: 5 keeps the first five matching reviews. Set 0 to keep every review the page carries. Default is 0.", "default": 0 }, "verifiedOnly": { "title": "βœ… Verified purchases only", "type": "boolean", "description": "Keeps only reviews carrying the verified-purchase badge. Every kept row still reports verifiedPurchase, so you can see the badge rate without filtering. Default is off.", "default": false }, "minStars": { "title": "⭐ Minimum review rating", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Drops reviews rated below the chosen value. Example: 5 stars only keeps a 5.0 review and drops a 4.0 one. Default is Any rating.", "default": "0" }, "withImagesOnly": { "title": "πŸ–ΌοΈ Only reviews that include photos", "type": "boolean", "description": "Keeps only reviews whose review body carries at least one customer photo. Photo reviews are a small minority, so expect far fewer rows. Default is off.", "default": false }, "marketplaceDomain": { "title": "🌐 Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.es", "amazon.it", "amazon.nl", "amazon.se", "amazon.pl", "amazon.ie", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.sg", "amazon.ae", "amazon.sa", "amazon.eg", "amazon.com.tr" ], "type": "string", "description": "Which Amazon marketplace to read. Used when the legacy Amazon domain field below is left at amazon.com; if you change that field instead, it wins. Default is amazon.com." }, "amazonDomain": { "title": "🌍 Amazon domain (legacy field)", "type": "string", "description": "The original free-text domain field, e.g. amazon.com, amazon.co.uk, amazon.de. Kept so an input JSON written for the previous version still works. Anything other than amazon.com here overrides the marketplace picker above.", "default": "amazon.com" }, "pageLanguage": { "title": "πŸ—£οΈ Page language", "enum": [ "", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "ja-JP", "zh-CN" ], "type": "string", "description": "Requests a localized version of the product page. Leave empty to take the marketplace's own default language." }, "language": { "title": "🈯 Language (legacy field)", "enum": [ "", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "ja-JP", "zh-CN" ], "type": "string", "description": "The original language field. Kept for backward compatibility; when set it overrides the page language picker above.", "default": "" }, "exitCountry": { "title": "πŸ“ Read the storefront as a shopper in", "enum": [ "US", "GB", "DE", "FR", "ES", "IT", "NL", "SE", "PL", "IE", "CA", "MX", "BR", "AU", "JP", "IN", "SG", "AE", "SA", "EG", "TR" ], "type": "string", "description": "The country the marketplace should treat the request as coming from. This decides the quoted currency and the delivery terms, so a US reader on amazon.com sees US dollars. Default is United States." }, "proxyCountry": { "title": "🧭 Country (legacy field)", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP" ], "type": "string", "description": "The original country field. AUTO derives the country from the marketplace. Kept for backward compatibility; anything other than AUTO overrides the picker above.", "default": "AUTO" }, "proxyConfiguration": { "title": "βš™οΈ Connection configuration", "type": "object", "description": "Network settings for reaching the marketplace. The prepared selection is the one this actor is tuned for; changing it can change which currency and delivery terms the storefront quotes." } } }, "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 } } } } } } } } } }