{ "openapi": "3.0.1", "info": { "title": "Amazon Bestseller Radar - BSR Movers, New Entries & Price Delta", "description": "Track Amazon Best Sellers categories and see what actually changed since your last run: new entries, climbers, fallers and drop-outs with rank deltas, prices and demand signals. Up to 10 categories per run, flat price per category - not per product. Schedule it daily or weekly.", "version": "0.1", "x-build-id": "TOpkzl1OTL9ncZCFe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/doesaiknow~amazon-bestseller-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-doesaiknow-amazon-bestseller-radar", "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/doesaiknow~amazon-bestseller-radar/runs": { "post": { "operationId": "runs-sync-doesaiknow-amazon-bestseller-radar", "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/doesaiknow~amazon-bestseller-radar/run-sync": { "post": { "operationId": "run-sync-doesaiknow-amazon-bestseller-radar", "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": [ "categories" ], "properties": { "categories": { "title": "Best Sellers categories", "maxItems": 10, "type": "array", "description": "Amazon Best Sellers category URLs, one per line — e.g. https://www.amazon.com/Best-Sellers-Health-Household/zgbs/hpc/. Each category costs one category-scan event per run (× depth). Duplicates are merged before anything is charged. FREE PLAN: 1-category preview per run at depth 1, movement tracking disabled.", "items": { "type": "string", "minLength": 1, "maxLength": 500 } }, "depth": { "title": "Scan depth", "minimum": 1, "maximum": 2, "type": "integer", "description": "1 = top 30 of the category. 2 = top 30 PLUS ranks 51–80 (Amazon only serves ranks 31–50 and 81–100 to a scrolling browser, so no scheduled tool can see them — ranks shown are Amazon's own badge numbers). Depth 2 costs 2× category-scan events per category.", "default": 2 }, "watchlistId": { "title": "Watchlist ID (enables movement tracking)", "maxLength": 40, "type": "string", "description": "Any label you choose, e.g. \"supplements-radar\" or a client name. Runs sharing a watchlist ID are compared with each other, so every run reports new entries, climbers, fallers and drop-outs since the previous one. Leave empty for a one-off snapshot with no history. Use a separate ID per project." }, "enrichDemand": { "title": "Attach demand signals", "type": "boolean", "description": "Adds \"bought in past month\" and Amazon's Choice / Best Seller badges to the TOP 10 of each category — the zone the volatility summary prices and the zone worth acting on. Price, stars and review counts come with the full ranking either way (except on rare fallback-sourced runs, where enrichment also fills top-10 prices in).", "default": true }, "marketplace": { "title": "Amazon marketplace", "enum": [ "com" ], "type": "string", "description": "Amazon.com (US) only in this version. Other marketplaces are planned.", "default": "com" }, "bypassRunCache": { "title": "Force a fresh scan", "type": "boolean", "description": "Identical runs within 24 hours normally return cached results with no per-category charge. Tick this to force a fresh scan — this WILL incur charges. Note: Amazon updates Best Sellers roughly hourly, so scanning more often than daily mostly measures noise.", "default": false } } }, "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 } } } } } } } } } }