{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper: Search Results, Prices & Reviews", "description": "Scrape Amazon product data from keywords, category URLs, product URLs, or ASINs. Start with stable search-result exports for prices, ratings, and review counts, then enable full product-detail enrichment when you need deeper fields.", "version": "0.1", "x-build-id": "NY9byOvuTOme0s34e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nezha~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nezha-amazon-product-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/nezha~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-nezha-amazon-product-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/nezha~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-nezha-amazon-product-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Recommended first-run path. Enter one or more Amazon search keywords such as 'wireless mouse', 'standing desk', or 'protein powder'. The Actor builds Amazon search URLs automatically.", "items": { "type": "string" } }, "categoryOrProductUrls": { "title": "Category, Search, or Product URLs", "type": "array", "description": "Optional Amazon URLs. Paste category URLs, filtered search URLs, bestseller pages, or product URLs from any supported Amazon marketplace.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "asins": { "title": "ASINs", "type": "array", "description": "Optional known product ASINs. Use this when you already have a product list and want full product detail enrichment without search discovery.", "items": { "type": "string" } }, "marketplace": { "title": "Default Marketplace", "enum": [ "US", "DE", "GB", "FR", "ES", "IT", "NL", "SE", "PL", "JP", "CA", "AU", "IN", "MX", "BR", "AE", "SA", "SG", "TR" ], "type": "string", "description": "Marketplace used for keyword searches and ASIN-only input. URLs keep their own marketplace automatically.", "default": "US" }, "language": { "title": "Preferred Language", "enum": [ "AUTO", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "nl-NL", "pl-PL", "ja-JP" ], "type": "string", "description": "Controls the Accept-Language header. Use AUTO to follow the default language of each marketplace.", "default": "AUTO" }, "sortBy": { "title": "Keyword Search Sort Order", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank" ], "type": "string", "description": "Applied only to keyword-generated search URLs.", "default": "relevanceblender" }, "maxItems": { "title": "Max Output Records", "minimum": 1, "type": "integer", "description": "Global output cap. Keep this low for preview runs, then set it deliberately for larger exports.", "default": 48 }, "maxItemsPerStartUrl": { "title": "Max Products Per Search URL", "minimum": 1, "type": "integer", "description": "Maximum products to follow or emit from each keyword or direct search URL.", "default": 24 }, "maxSearchPagesPerStartUrl": { "title": "Max Search Pages Per URL", "minimum": 1, "type": "integer", "description": "Stops discovery after this many Amazon search pages per keyword or direct search URL.", "default": 2 }, "scrapeProductDetails": { "title": "Scrape Full Product Details", "type": "boolean", "description": "Recommended. When enabled, the Actor follows products from search pages and extracts full product detail records. Disable it if you only want lightweight search-result rows from search URLs.", "default": false }, "includeQuestionsCount": { "title": "Include Answered Questions Count", "type": "boolean", "description": "Follows the Amazon Q&A page when available and adds the answered questions count. This adds extra requests, so keep it off for the fastest preview run.", "default": false }, "maxImages": { "title": "Max Images", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum high-resolution image URLs to keep per product detail record.", "default": 6 }, "maxRetries": { "title": "Retries Per Request", "minimum": 1, "type": "integer", "description": "How many times to retry blocked or failed Amazon pages before saving them to FAILED_REQUESTS.", "default": 3 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Parallel request count. Lower values are slower but usually more stable for Amazon.", "default": 3 }, "requestDelaySecs": { "title": "Delay Between Requests (Secs)", "minimum": 0, "type": "integer", "description": "Small polite delay before each request to reduce blocking risk.", "default": 2 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Recommended for Amazon. Use Apify Proxy and select a country that matches the marketplace when you want the most stable and localized product availability and pricing." } } }, "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 } } } } } } } } } }