{ "openapi": "3.0.1", "info": { "title": "Amazon Product & Review Scraper", "description": "Extract product details and reviews from Amazon by ASIN, URL, or search term. Dual-crawler with bot-check fallback. No API key required.", "version": "1.0", "x-build-id": "WTD0QgwtmrCn4qgxu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/woundless_yellowwood~z-amazon-scraper-20250727/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-woundless_yellowwood-z-amazon-scraper-20250727", "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/woundless_yellowwood~z-amazon-scraper-20250727/runs": { "post": { "operationId": "runs-sync-woundless_yellowwood-z-amazon-scraper-20250727", "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/woundless_yellowwood~z-amazon-scraper-20250727/run-sync": { "post": { "operationId": "run-sync-woundless_yellowwood-z-amazon-scraper-20250727", "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": [ "inputs" ], "properties": { "inputs": { "title": "Inputs", "type": "array", "description": "Array of items to scrape. Each item can be an ASIN (e.g. B09V3KXJPB), a full Amazon product URL, or a search term. For search terms, also set the domain.", "items": { "type": "object", "properties": { "type": { "title": "Input Type", "description": "Type of input: 'asin', 'url', or 'search'.", "type": "string", "enum": [ "asin", "url", "search" ], "default": "asin" }, "value": { "title": "Value", "description": "The ASIN (e.g. B09V3KXJPB), full product URL (e.g. https://www.amazon.com/dp/B09V3KXJPB), or search term (e.g. 'wireless earbuds').", "type": "string", "default": "" }, "domain": { "title": "Amazon Domain", "description": "Amazon domain to use. Only applicable for search-type inputs. Ignored for ASIN and URL inputs (they encode their own domain).", "type": "string", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.co.jp", "amazon.ca", "amazon.com.mx", "amazon.it", "amazon.es", "amazon.com.au" ], "default": "amazon.com" } }, "required": [ "type", "value" ] }, "default": [ { "value": "B09V3KXJPB", "type": "asin" } ] }, "maxProductsPerSearch": { "title": "Max Products Per Search", "minimum": 1, "maximum": 48, "type": "integer", "description": "Maximum number of products to extract from a single search-term input. Only applies when input type is 'search'.", "default": 10 }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Whether to extract reviews for each product.", "default": true }, "maxReviewsPerProduct": { "title": "Max Reviews Per Product", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of reviews to extract per product. Only applies when includeReviews is true.", "default": 20 }, "reviewSort": { "title": "Review Sort Order", "enum": [ "recent", "helpful" ], "type": "string", "description": "How to sort reviews on the review page.", "default": "recent" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy configuration. Residential proxies are strongly recommended for Amazon.", "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 } } } } } } } } } }