{ "openapi": "3.0.1", "info": { "title": "Amazon Search Products & Trending Scraper", "description": "Scrape Amazon search results and trending products with titles, ASINs, prices, ratings, reviews, rankings, categories, images, and availability. Discover high-demand products, analyze market trends, research competitors, and uncover profitable e-commerce opportunities.", "version": "0.1", "x-build-id": "WGVt9l5KmeLVShQVg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~amazon-search-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-amazon-search-products-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/api-empire~amazon-search-products-scraper/runs": { "post": { "operationId": "runs-sync-api-empire-amazon-search-products-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/api-empire~amazon-search-products-scraper/run-sync": { "post": { "operationId": "run-sync-api-empire-amazon-search-products-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": { "searchTerms": { "title": "🎯 Keywords, search URLs or Best Sellers URLs", "type": "array", "description": "What market to scan. Add product keywords (e.g. 'whey protein', 'gaming mouse'), full Amazon search URLs (filters preserved), or Amazon Best Sellers /zgbs/ list URLs. Each entry runs as its own scan. (Base-compatible: 'startUrls' is also accepted.)", "items": { "type": "string" } }, "sortOrder": { "title": "↕️ Sort results by", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank" ], "type": "string", "description": "How Amazon sorts each keyword search (ignored for Best Sellers URLs). Featured is the default relevance ranking.", "default": "relevanceblender" }, "maxPages": { "title": "📄 Max pages per scan", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Max result pages to scan for each keyword/list. Keep 1 for auto-continue on searches (stops after 2 empty pages), or raise it to enforce a strict cap.", "default": 1 }, "badgeFilter": { "title": "🏅 Keep only products with these badges", "type": "array", "description": "Output only products carrying at least one of the selected badges. Leave empty to keep everything (badges are still extracted either way). Example: pick 'Best Seller' + \"Amazon's Choice\" to screen for proven winners.", "items": { "type": "string", "enum": [ "BEST_SELLER", "AMAZONS_CHOICE", "NEW_RELEASE", "LIMITED_TIME_DEAL", "CLIMATE_PLEDGE", "SMALL_BUSINESS" ], "enumTitles": [ "🥇 Best Seller", "✅ Amazon's Choice", "🆕 #1 New Release", "⏳ Limited-time Deal", "🌱 Climate Pledge Friendly", "🏪 Small Business" ] }, "default": [] }, "includeBestsellerRank": { "title": "📈 Fetch Best-Sellers-Rank per product", "type": "boolean", "description": "Open each product's detail page (1 extra request/product) to read its Best-Sellers-Rank and category. Adds bestsellerRanks + rankCategoryTop. Slower and uses more requests — cap it with 'Max rank lookups'.", "default": false }, "maxRankLookups": { "title": "🔢 Max rank lookups", "minimum": 0, "type": "integer", "description": "Upper bound on how many products get a Best-Sellers-Rank detail fetch (0 = unlimited). Only used when 'Fetch Best-Sellers-Rank' is on. Example: 25.", "default": 10 }, "minMonthlySales": { "title": "🔥 Minimum monthly sales", "minimum": 0, "type": "integer", "description": "Keep only products whose 'X bought in past month' demand (salesVolumeNumeric) is at least this many. 0 = no demand floor. Example: 500 keeps only fast movers.", "default": 0 }, "marketplace": { "title": "🌍 Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.nl", "amazon.se", "amazon.com.mx", "amazon.com.br", "amazon.sg", "amazon.ae" ], "type": "string", "description": "Which Amazon marketplace to scan. Pin your proxy country to the same region for accurate prices. (Base-compatible: 'amazonDomain' is also accepted.)" }, "language": { "title": "🗣️ Page language", "enum": [ "", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "ja-JP", "nl-NL", "sv-SE", "pt-BR", "zh-CN" ], "type": "string", "description": "Preferred page language (Accept-Language). Leave empty to use the marketplace default.", "default": "" }, "proxyCountry": { "title": "📍 Proxy country", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "MX", "BR", "NL", "SE", "SG", "AE" ], "type": "string", "description": "Route requests through this country (pin it to the marketplace region for correct prices/buy-box). AUTO lets Apify choose.", "default": "AUTO" }, "proxyConfiguration": { "title": "🛡️ Proxy configuration", "type": "object", "description": "Network settings. Default: no proxy. If Amazon blocks, the actor falls back none → datacenter → residential automatically. Enable Apify Proxy here for reliable runs." } } }, "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 } } } } } } } } } }