{ "openapi": "3.0.1", "info": { "title": "Amazon Best Sellers & Seller UBO Scraper", "description": "Track Amazon Best Sellers rank/ASIN/price/rating by category, plus seller profiles with business name, registered address (UBO), country, VAT and feedback. HTTP, JSON/CSV/Excel.", "version": "0.1", "x-build-id": "0hEuZASGqfoycEMvk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~amazon-bestsellers-seller-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-amazon-bestsellers-seller-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/scrapers_lat~amazon-bestsellers-seller-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-amazon-bestsellers-seller-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/scrapers_lat~amazon-bestsellers-seller-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-amazon-bestsellers-seller-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": { "mode": { "title": "Mode", "enum": [ "bestsellers", "seller" ], "type": "string", "description": "What to scrape: 'bestsellers' returns a ranked Best-Sellers list for a category; 'seller' returns seller profiles with business name and registered address (UBO) for the seller IDs you provide.", "default": "bestsellers" }, "category": { "title": "Best-Sellers category", "type": "string", "description": "Best-Sellers category node or slug, e.g. 'electronics', 'books', 'electronics/172282' or a full /gp/bestsellers URL. Leave empty for the top-level Best Sellers list. Used in bestsellers mode." }, "categoryUrls": { "title": "Best-Sellers URLs", "type": "array", "description": "One or more full Best-Sellers page URLs (https://www.amazon.com/gp/bestsellers/...). Alternative to 'category'. Used in bestsellers mode.", "items": { "type": "string" } }, "sellerIds": { "title": "Seller IDs", "type": "array", "description": "Amazon seller/merchant IDs (e.g. A2L77EE7U53NWQ). Used in seller mode.", "items": { "type": "string" } }, "sellerUrls": { "title": "Seller URLs", "type": "array", "description": "Seller storefront/profile URLs containing seller= (e.g. https://www.amazon.com/sp?seller=...). Used in seller mode.", "items": { "type": "string" } }, "domain": { "title": "Marketplace domain", "enum": [ "com", "co.uk", "de", "es", "fr", "it", "ca", "com.mx", "com.br", "com.au", "co.jp", "in", "nl", "se", "pl" ], "type": "string", "description": "Amazon marketplace to scrape.", "default": "com" }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records to return. Free Apify plans are capped at 10 per run.", "default": 50 }, "withDetails": { "title": "Fetch product details (Buy Box seller + BSR)", "type": "boolean", "description": "Bestsellers mode: fetch each item's product page for the Buy Box seller, seller ID, best-seller rank detail and feature bullets. Charged as the 'details' add-on only when detail data is returned.", "default": true }, "withSellerUbo": { "title": "Seller UBO add-on (business name + registered address)", "type": "boolean", "description": "Fetch the seller's Detailed Seller Information page and add business name, registered address (UBO), country, VAT and feedback. Default ON in seller mode. Requires a paid Apify plan. Charged as 'seller_ubo' only when business info is found.", "default": false }, "withSummary": { "title": "AI seller summary (add-on)", "type": "boolean", "description": "AI one-line KYB summary of the seller (who they are, where based, trust signal). Requires a paid Apify plan. Charged as 'ai_summary' only on usable AI output.", "default": false }, "withAttributes": { "title": "AI product attributes (add-on)", "type": "boolean", "description": "Bestsellers mode: AI-extracted structured product attributes and a broad category. Requires a paid Apify plan. Charged as 'ai_attributes' only on usable AI output.", "default": false }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Only keep best-seller items with a star rating at or above this value (0-5). Items without a rating are kept." }, "maxRank": { "title": "Maximum rank", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only keep best-seller items with rank at or below this value (e.g. 20 = top 20)." } } }, "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 } } } } } } } } } }