{ "openapi": "3.0.1", "info": { "title": "Amazon Real-Time Data — Search, Reviews, Deals & Best Sellers", "description": "Scrape live Amazon data: product search, details, seller offers, reviews, deals & best sellers across 25 marketplaces. Enable only what you need via checkboxes. Built-in CAPTCHA handling, residential proxy support, and structured JSON for research, repricing, and integrations.", "version": "0.0", "x-build-id": "yEZiela1Z3G7Rkzvl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/b2b_leads~amazon-real-time-data-search-reviews-deals-best-sellers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-b2b_leads-amazon-real-time-data-search-reviews-deals-best-sellers", "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/b2b_leads~amazon-real-time-data-search-reviews-deals-best-sellers/runs": { "post": { "operationId": "runs-sync-b2b_leads-amazon-real-time-data-search-reviews-deals-best-sellers", "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/b2b_leads~amazon-real-time-data-search-reviews-deals-best-sellers/run-sync": { "post": { "operationId": "run-sync-b2b_leads-amazon-real-time-data-search-reviews-deals-best-sellers", "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": { "country": { "title": "Marketplace country", "enum": [ "US", "CA", "MX", "BR", "UK", "DE", "FR", "IT", "ES", "NL", "BE", "SE", "PL", "TR", "IE", "AE", "SA", "EG", "IN", "SG", "AU", "JP", "AT", "CH", "LU" ], "type": "string", "description": "Amazon marketplace to scrape. Drives domain, currency, and language headers.", "default": "US" }, "enableProductSearch": { "title": "Product Search", "type": "boolean", "description": "Search Amazon by keyword and return matching products from search results.", "default": true }, "searchKeywords": { "title": "Search keywords", "type": "array", "description": "One or more keywords to search (1–20). Required when Product Search is enabled.", "default": [ "wireless mouse" ], "items": { "type": "string" } }, "searchMaxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum products to return per keyword (1–100).", "default": 10 }, "searchPage": { "title": "Start page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First search results page to scrape (1-based).", "default": 1 }, "searchMaxPages": { "title": "Max pages per keyword", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of search result pages to crawl per keyword.", "default": 1 }, "searchSort": { "title": "Sort order", "enum": [ "relevance", "price-asc", "price-desc", "review-rank", "date-desc" ], "type": "string", "description": "How to sort search results on Amazon.", "default": "relevance" }, "searchCategory": { "title": "Category browse node ID (optional)", "type": "string", "description": "Restrict search to an Amazon category using its browse node ID.", "default": "" }, "enableProductDetails": { "title": "Product Details", "type": "boolean", "description": "Fetch full product page data for specific ASINs or URLs.", "default": false }, "productAsins": { "title": "Product ASINs", "type": "array", "description": "10-character Amazon ASINs to scrape.", "default": [], "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Alternative to ASINs — paste full Amazon product page URLs.", "default": [], "items": { "type": "string" } }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Parse product variation swatches when available.", "default": false }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Include product description text in output.", "default": true }, "includeImages": { "title": "Include images", "type": "boolean", "description": "Include product image URLs in output.", "default": true }, "enableProductOffers": { "title": "Product Offers", "type": "boolean", "description": "Fetch all seller offers for given ASINs (Phase 3).", "default": false }, "offersAsins": { "title": "Offer ASINs", "type": "array", "description": "ASINs to fetch offers for.", "default": [], "items": { "type": "string" } }, "offersCondition": { "title": "Offer condition filter", "enum": [ "all", "new", "used", "refurbished" ], "type": "string", "description": "Filter offers by item condition. Use All to return every available offer.", "default": "all" }, "enableProductReviews": { "title": "Product Reviews", "type": "boolean", "description": "Scrape customer reviews for given ASINs (Phase 3).", "default": false }, "reviewsAsins": { "title": "Review ASINs", "type": "array", "description": "ASINs to fetch reviews for.", "default": [], "items": { "type": "string" } }, "reviewsMaxPerProduct": { "title": "Max reviews per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of reviews to collect per ASIN (1–100).", "default": 10 }, "reviewsSortBy": { "title": "Review sort", "enum": [ "recent", "helpful" ], "type": "string", "description": "How to sort reviews on the product page.", "default": "recent" }, "reviewsFilterByStar": { "title": "Star rating filter", "minimum": 0, "maximum": 5, "type": "integer", "description": "Filter reviews by star rating. 0 = all ratings, 1–5 = specific star count.", "default": 0 }, "enableScrapeByUrl": { "title": "Scrape By URL", "type": "boolean", "description": "Scrape arbitrary Amazon URLs with auto page-type detection (Phase 4).", "default": false }, "scrapeUrls": { "title": "Amazon URLs", "type": "array", "description": "Amazon URLs to scrape.", "default": [], "items": { "type": "string" } }, "enableBestSellers": { "title": "Best Sellers", "type": "boolean", "description": "Scrape Amazon best seller category pages (Phase 4).", "default": false }, "bestSellerCategoryUrls": { "title": "Best seller category URLs", "type": "array", "description": "URLs of Amazon best seller category pages.", "default": [], "items": { "type": "string" } }, "bestSellersCategory": { "title": "Best seller category slug", "type": "string", "description": "Category path slug (e.g. software, electronics, books). Used when category URLs are empty.", "default": "software" }, "bestSellerCategoryIds": { "title": "Best seller browse node IDs", "type": "array", "description": "Amazon browse node IDs for best seller categories.", "default": [], "items": { "type": "string" } }, "bestSellerMaxProducts": { "title": "Max best seller products", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of best seller products to return per category (1–100).", "default": 50 }, "enableDeals": { "title": "Deals", "type": "boolean", "description": "Scrape Amazon deals / Gold Box pages (Phase 4).", "default": false }, "dealsMaxProducts": { "title": "Max deals", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of deals to return from Amazon Gold Box (1–100).", "default": 50 }, "dealsOffset": { "title": "Deals page offset", "minimum": 0, "type": "integer", "description": "Pagination offset for Today's Deals (multiples of 30). 0 = first page.", "default": 0 }, "dealsMinDiscountPercent": { "title": "Minimum discount (%)", "minimum": 0, "type": "number", "description": "Only include deals with at least this discount percentage.", "default": 0 }, "proxyConfiguration": { "title": "Proxy settings", "type": "object", "description": "Use Apify Proxy with US Residential for best results on Amazon. Leave the default unless you know you need something else.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }