{ "openapi": "3.0.1", "info": { "title": "Amazon Search Results & Best Sellers Scraper", "description": "Track where products rank on Amazon. Search mode returns every result for a keyword with its absolute rank across pages, sponsored ads flagged separately from organic positions. Best Sellers mode returns the top 100 of any category with rank, price, rating and reviews.", "version": "0.1", "x-build-id": "1FKFhmfM7Q7PA8xWC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~amazon-search-bestsellers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-amazon-search-bestsellers", "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/xtracto~amazon-search-bestsellers/runs": { "post": { "operationId": "runs-sync-xtracto-amazon-search-bestsellers", "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/xtracto~amazon-search-bestsellers/run-sync": { "post": { "operationId": "run-sync-xtracto-amazon-search-bestsellers", "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": [ "search", "bestsellers" ], "type": "string", "description": "What to scrape. 'Search results' walks the result pages for your keywords and returns each product with its rank. 'Best Sellers' returns the ranked top 100 of a category.", "default": "search" }, "keywords": { "title": "Keywords (Search mode)", "type": "array", "description": "Search terms to look up, exactly as a shopper would type them. Each keyword is searched separately and every product gets a rank for that keyword.", "items": { "type": "string" } }, "searchUrls": { "title": "Search URLs (Search mode)", "type": "array", "description": "Paste full Amazon search URLs to reuse filters, sorting or department restrictions you set up in the browser (for example a price-filtered or brand-filtered search). Page numbers are added automatically.", "items": { "type": "string" } }, "categoryUrls": { "title": "Best Sellers URLs (Best Sellers mode)", "type": "array", "description": "Full Amazon Best Sellers URLs, including sub-category pages. Copy them straight from the browser address bar.", "items": { "type": "string" } }, "categories": { "title": "Best Sellers categories (Best Sellers mode)", "type": "array", "description": "Top-level category names as they appear in a Best Sellers link, for example 'electronics', 'videogames', 'toys-and-games', 'home-garden'.", "items": { "type": "string" } }, "domain": { "title": "Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.ca", "amazon.com.au", "amazon.in", "amazon.co.jp" ], "type": "string", "description": "Which Amazon marketplace to search. Keywords and category names are resolved on this marketplace; pasted URLs are used exactly as given.", "default": "amazon.com" }, "maxPages": { "title": "Max pages per keyword or category", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to walk for each keyword, search URL or category. A search page holds roughly 16 to 60 products depending on the layout Amazon serves. Best Sellers lists are only two pages long (the top 100), so higher values are ignored there.", "default": 3 }, "maxItems": { "title": "Max results for the whole run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on how many rows this run returns, counted across all keywords and categories. Raise it when you track many keywords at once.", "default": 200 }, "maxConcurrency": { "title": "Keywords or categories in parallel", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many keywords or categories to work on at the same time. Lower this if results come back incomplete.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Residential proxy in the marketplace's own country is strongly recommended (US for amazon.com). Amazon prices, currency and delivery promises change with the visitor's location, so a mismatched country returns prices in the wrong currency.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }