{ "openapi": "3.0.1", "info": { "title": "Amazon Best Sellers Scraper", "description": "Scrape public Amazon Best Sellers and New Releases category pages and get ranked product records with ASIN, title, category, marketplace, and product path. The Actor preserves the rank displayed on each card, so gaps caused by items loaded only after scrolling remain visible.", "version": "0.0", "x-build-id": "bmGtQ94SAMaqWeY4t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~amazon-sellers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-amazon-sellers-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/axiomworks~amazon-sellers-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-amazon-sellers-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/axiomworks~amazon-sellers-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-amazon-sellers-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": { "categories": { "title": "Category slugs or IDs", "type": "array", "description": "Amazon category slugs, numeric IDs or nested paths, e.g. [\"electronics\"], [\"281407\"] or [\"electronics/281407\"]. Used when startUrls is empty; marketplace and listType construct the chart URLs. Supply categories or startUrls.", "items": { "type": "string" } }, "includeSubcategories": { "title": "Collect linked child charts", "type": "boolean", "description": "Whether to collect child category charts linked from starting pages, e.g. true; default false. Limited by maxSubcategories and the shared maxItems budget.", "default": false }, "startUrls": { "title": "Amazon ranking category URLs", "type": "array", "description": "HTTPS Amazon category chart URLs, e.g. [{\"url\":\"https://www.amazon.com/zgbs/electronics/\"}]. Accepts /gp/bestsellers/, /gp/new-releases/ and nested /zgbs/ paths on supported www.amazon hosts. Nonempty startUrls overrides categories, marketplace and listType; product and search URLs are invalid.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "marketplace": { "title": "Amazon domain for category inputs", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.co.jp", "amazon.in", "amazon.com.au" ], "type": "string", "description": "Marketplace domain used only with categories, e.g. amazon.de; default amazon.com. Each startUrls entry determines its own marketplace. Prices and language can depend on the proxy exit country.", "default": "amazon.com" }, "listType": { "title": "Ranking type for category inputs", "enum": [ "bestsellers", "new-releases" ], "type": "string", "description": "Chart type used only with categories: bestsellers (default) or new-releases, e.g. new-releases. Each startUrls entry determines its own chart type.", "default": "bestsellers" }, "maxPagesPerCategory": { "title": "Pages per ranking chart", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum pages per starting or child chart, 1-5, e.g. 1; default 2. Static HTML commonly exposes 30 items per page, with rank gaps; extra pages may be empty.", "default": 2 }, "maxSubcategories": { "title": "Child charts across the run", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum linked child charts to add across all starting targets, 1-50, e.g. 3; default 10. Used only when includeSubcategories is true.", "default": 10 }, "maxItems": { "title": "Ranking records across all charts", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum ranking records saved across all targets and pages, 1-10000, e.g. 7; default 50. Deduplicates within each marketplace/list/category/ASIN context. Stops early when fewer records exist or targets remain blocked.", "default": 50 }, "minRating": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Minimum displayed star rating, 0-5, e.g. 4.5; default 0 disables filtering. Cards with missing ratings are excluded only when enabled. maxItems counts matching saved records across all charts.", "default": 0 }, "minReviewCount": { "title": "Minimum rating count", "minimum": 0, "type": "integer", "description": "Minimum displayed review/rating count, e.g. 100; default 0 disables filtering. Cards with missing counts are excluded only when enabled. Filtered cards are not saved or charged; empty matches succeed with a status message.", "default": 0 }, "proxyConfiguration": { "title": "Amazon request proxy settings", "type": "object", "description": "Apify Proxy settings, e.g. {\"useApifyProxy\":true,\"apifyProxyGroups\":[\"RESIDENTIAL\"]}. Defaults to residential; country matches the marketplace when all targets share one. Repeatedly blocked or empty charts contribute zero records; check the category URL or proxy country.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }