{ "openapi": "3.0.1", "info": { "title": "πŸ›’ Amazon Best Sellers Scraper", "description": "Amazon Bestsellers Actor extracts top-ranked products from Amazon’s Best Sellers lists across any category. It collects titles, prices, ratings, reviews, rankings, images, and seller details. Perfect for market research, trend spotting, competitor analysis, and automated product insights at scale", "version": "0.3", "x-build-id": "c0e3L4IGt5sCpqvcc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~amazon-bestsellers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-amazon-bestsellers-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/simpleapi~amazon-bestsellers-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-amazon-bestsellers-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/simpleapi~amazon-bestsellers-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-amazon-bestsellers-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", "required": [ "categoryUrls" ], "properties": { "categoryUrls": { "title": "πŸ”— Category URLs", "type": "array", "description": "Amazon list-page URLs to scrape. Supports Best Sellers (/zgbs/), New Releases (/gp/new-releases/) and Most Wished For (/gp/most-wished-for/). (Movers & Shakers is not supported β€” Amazon renders it client-side, so its data is not in the page HTML.) Example: https://www.amazon.com/Best-Sellers-Electronics/zgbs/electronics/", "items": { "type": "string" } }, "maxResults": { "title": "πŸ“Š Max results (per start URL)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum products to extract per category URL (across main list + subcategories, deduped by ASIN). Example: 100. Default is 100.", "default": 100 }, "subcategoryDepth": { "title": "πŸ“ Subcategory depth", "minimum": 1, "type": "integer", "description": "1 = main category only. 2+ = also scrape the listed subcategories (still capped by Max results). Default is 1.", "default": 1 }, "detailedInformation": { "title": "πŸ” Detailed information (per-product enrichment)", "type": "boolean", "description": "Visit each product page to add brand, features, availability, coupon, list price + discount, isPrime, badges, variant ASINs, breadcrumbs, real Best Sellers Ranks and the star histogram. Slower and billed per enriched row. Default is off.", "default": false }, "minRating": { "title": "⭐ Minimum rating", "minimum": 1, "maximum": 5, "type": "number", "description": "Keep only products with at least this star rating (1–5, decimals allowed e.g. 4.5). Products without a rating are dropped. Leave empty for no filter." }, "minReviews": { "title": "πŸ—£οΈ Minimum reviews", "minimum": 0, "type": "integer", "description": "Keep only products with at least this many ratings/reviews. Products without a review count are dropped. Example: 1000. Leave empty for no filter." }, "priceRange": { "title": "πŸ’² Price range", "type": "object", "description": "Keep only products whose price falls within {\"min\": X, \"max\": Y} (in the marketplace currency). Products without a price are dropped when a bound is set. Example: {\"min\": 10, \"max\": 100}." }, "primeOnly": { "title": "🚚 Prime only", "type": "boolean", "description": "Keep only Prime-eligible products. Requires Detailed information = on (isPrime is only available on the product page). Default is off.", "default": false }, "language": { "title": "🌐 Language", "enum": [ "", "cs", "da", "de", "en", "es", "fr", "nl", "pl", "pt", "sv", "tr", "he", "ar", "hi", "bn", "ta", "te", "kn", "ml", "ko", "zh_CN", "zh_TW", "ja" ], "type": "string", "description": "Preferred Amazon content language (Accept-Language). Each domain supports a different set; unsupported values fall back to the domain default." }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "Proxy settings. Default is Apify residential proxy with user-agent rotation and automatic fresh-IP escalation on blocks. Amazon robot-checks datacenter IPs, so residential is strongly recommended.", "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 } } } } } } } } } }