{ "openapi": "3.0.1", "info": { "title": "Amazon Best Sellers Scraper", "description": "Scrape Amazon Best Sellers rankings from Amazon marketplaces, including Amazon.in. Extract rank, title, ASIN, price, rating, review count, product URL, image URL, and category details. Optionally collect additional product information from product pages.", "version": "1.0", "x-build-id": "SgFBmoI8uXvffHFwi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeai~amazon-bestsellers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeai-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/scrapeai~amazon-bestsellers-scraper/runs": { "post": { "operationId": "runs-sync-scrapeai-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/scrapeai~amazon-bestsellers-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeai-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "category", "categoryUrl", "productUrl" ], "type": "string", "description": "Scraping mode: 'category' to scrape by category slug, 'categoryUrl' to scrape a specific best sellers URL, 'productUrl' to scrape specific product URLs.", "default": "category" }, "category": { "title": "Category", "type": "string", "description": "Best sellers category slug (e.g., electronics, books, toys, kitchen, beauty, clothing). Used when mode is 'category'.", "default": "electronics" }, "categoryUrl": { "title": "Category URL", "type": "string", "description": "Direct URL to an Amazon Best Sellers category or subcategory page (e.g., https://www.amazon.in/gp/bestsellers/electronics/). Used when mode is 'categoryUrl'." }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Array of direct Amazon product page URLs to scrape (used when mode is 'productUrl').", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of best seller products to extract (1–100). Amazon shows 50 per page; use 100 for full top-100 list.", "default": 50 }, "deepSearch": { "title": "Deep Search", "type": "boolean", "description": "Visit each product detail page to extract full information (brand, description, technical specs, full images, etc.). Slower but much richer data.", "default": false }, "extractReviews": { "title": "Extract Reviews", "type": "boolean", "description": "Extract customer reviews from product detail pages (requires deepSearch: true).", "default": false }, "country": { "title": "Amazon Marketplace", "enum": [ "in", "com", "co.uk", "de", "co.jp", "ca", "com.au", "com.br" ], "type": "string", "description": "Amazon marketplace to scrape. Defaults to India (amazon.in).", "default": "in" }, "headless": { "title": "Headless Mode", "type": "boolean", "description": "Run the browser in headless mode (no visible window).", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Use Apify Proxy with RESIDENTIAL group for reliable Amazon scraping." } } }, "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 } } } } } } } } } }