{ "openapi": "3.0.1", "info": { "title": "Amazon Best Sellers Scraper (rank, price, rating, monitor)", "description": "Amazon Best Sellers, New Releases and Movers & Shakers scraper: one row per ranked product with Amazon's rank, price in the marketplace currency, rating and review count, on ten marketplaces. Monitor mode alerts on rank moves and price changes. You pay only for rows returned.", "version": "0.1", "x-build-id": "9hg2JmO4r5IwDgETH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahamster~amazon-bestsellers/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahamster-amazon-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/datahamster~amazon-bestsellers/runs": { "post": { "operationId": "runs-sync-datahamster-amazon-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/datahamster~amazon-bestsellers/run-sync": { "post": { "operationId": "run-sync-datahamster-amazon-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": { "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many results (you are charged only for pushed items)", "default": 100 }, "mode": { "title": "Mode", "enum": [ "scrape", "monitor" ], "type": "string", "description": "scrape = full results; monitor = only new/changed items since the previous run of this task", "default": "scrape" }, "monitorStateId": { "title": "Monitor state id", "type": "string", "description": "Optional state id when not running as a saved task (monitor mode)" }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST a change summary here in monitor mode" }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional: bot token for monitor-mode change summaries" }, "telegramChatId": { "title": "Telegram chat id", "type": "string", "description": "Optional: chat id that receives monitor-mode summaries" }, "categoryUrls": { "title": "Category list URLs", "type": "array", "description": "Best Sellers, New Releases or Movers & Shakers URLs, one per line, e.g. \"https://www.amazon.com/Best-Sellers-Electronics/zgbs/electronics\". Any marketplace and any sub-category depth. A URL names its own marketplace and list type, so Marketplace and List type are ignored for it.", "items": { "type": "string" } }, "categories": { "title": "Category slugs", "type": "array", "description": "Category slugs to build URLs from, one per line, e.g. \"electronics\", \"books\", \"kitchen\". Slugs differ per marketplace (Electronics is \"electronics\" on .com and \"ce-de\" on .de), so pasting the URL is safer. Used together with Marketplace and List type.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "de", "co.uk", "fr", "it", "es", "ca", "co.jp", "in", "com.au" ], "type": "string", "description": "Which Amazon marketplace the category slugs belong to. The proxy exit is pinned to that country, so prices come back in its currency. Example: de.", "default": "com" }, "listType": { "title": "List type", "enum": [ "bestsellers", "new-releases", "movers-and-shakers" ], "type": "string", "description": "Which list to read for the category slugs. Amazon currently answers every Movers & Shakers URL with an empty list (checked 2026-09-17 on .com, .de and .co.uk), so that option returns nothing until Amazon serves the data again.", "default": "bestsellers" }, "maxPagesPerList": { "title": "Pages per list", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many pages to read per list. Amazon has two (ranks 1-100) and renders 30 products of each, so 2 pages return ranks 1-30 and 51-80. Range 1-10.", "default": 2 } } }, "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 } } } } } } } } } }