{ "openapi": "3.0.1", "info": { "title": "Amazon US Scraper - Products, Prices, Reviews, ASIN Data", "description": "Scrape Amazon.com (US) products, reviews, ratings, prices, sellers, and detailed features with optional AI market analysis.", "version": "1.0", "x-build-id": "JJBpqox2x6QqPe8wo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~amazon-us-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-amazon-us-intelligence", "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/viralanalyzer~amazon-us-intelligence/runs": { "post": { "operationId": "runs-sync-viralanalyzer-amazon-us-intelligence", "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/viralanalyzer~amazon-us-intelligence/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-amazon-us-intelligence", "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": { "searchQuery": { "title": "Search Query", "type": "string", "description": "Product search term (e.g., 'iPhone 15', 'wireless earbuds', 'gaming laptop')" }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Direct Amazon.com product URLs to scrape (alternative to search)", "default": [], "items": { "type": "string" } }, "category": { "title": "Category Filter", "type": "string", "description": "Optional. Keeps only products whose Amazon breadcrumb contains this text (case- and accent-insensitive, e.g. \"Electronics\" or \"headphones\"). Filtering happens in memory before billing, so discarded products are never charged. The breadcrumb is read from the product detail page: a product whose detail page could not be loaded has no breadcrumb, cannot be verified, and is excluded (the count is reported in the run log). Leave empty to keep every product matched by the search query.", "default": "" }, "maxProducts": { "title": "Maximum Products", "minimum": 1, "maximum": 500, "type": "integer", "description": "Ceiling on products scraped, NOT a guarantee. Search pagination stops after 10 result pages, so values that would need an 11th page are unreachable and the run returns fewer products. Direct productUrls are not affected by this limit.", "default": 50 }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Scrape customer reviews for each product (slower but more data)", "default": false }, "maxReviewsPerProduct": { "title": "Max Reviews per Product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Ceiling on reviews per product, NOT a guarantee. Review pagination stops after 5 pages per ASIN, so asking for 100 typically returns fewer — the run keeps whatever those 5 pages contain. Requires includeReviews = true.", "default": 10 }, "sortBy": { "title": "Sort Results By", "enum": [ "relevance", "price-asc", "price-desc", "rating", "newest" ], "type": "string", "description": "How to sort search results", "default": "relevance" }, "minPrice": { "title": "Minimum Price ($)", "type": "number", "description": "Filter products above this price", "default": 0 }, "maxPrice": { "title": "Maximum Price ($)", "type": "number", "description": "Filter products below this price (0 = no limit)", "default": 0 }, "primeOnly": { "title": "Prime Only", "type": "boolean", "description": "Only return products with Amazon Prime delivery", "default": false }, "includeAiAnalysis": { "title": "Include AI Analysis", "type": "boolean", "description": "AI-powered pricing and sentiment analysis (requires GEMINI_API_KEY)", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings — recommended for Amazon scraping", "default": { "useApifyProxy": 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 } } } } } } } } } }