{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper - Products, Rankings & Seller Profiles", "description": "Collect Amazon products, rankings, seller profiles, and search terms across 23 selectable storefronts. Export ASINs, prices, ratings, and available business information. Pay per delivered row.", "version": "0.3", "x-build-id": "KwehqbjmNQUsEcWlA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~amazon-search-results-collector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-amazon-search-results-collector", "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/lentic_clockss~amazon-search-results-collector/runs": { "post": { "operationId": "runs-sync-lentic_clockss-amazon-search-results-collector", "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/lentic_clockss~amazon-search-results-collector/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-amazon-search-results-collector", "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": { "keywords": { "title": "Keywords", "maxItems": 10, "type": "array", "description": "Amazon search keywords, one per line (up to 10). Fill this for keyword search. Optional for category mode (search within a category).", "items": { "type": "string" } }, "detailUrls": { "title": "Detail URLs (for detail mode)", "maxItems": 20, "type": "array", "description": "Amazon product links (/dp/ASIN) or seller profile links (/sp?seller=ID) on the chosen market's site, e.g. https://www.amazon.com/dp/B0ABCD1234. Fill this to fetch those pages (detail mode).", "items": { "type": "string" } }, "mode": { "title": "Collection mode", "enum": [ "auto", "keyword", "category", "bestsellers", "newreleases", "movers", "detail", "searchSeed" ], "type": "string", "description": "Choose the collection mode, or leave auto to infer it from detail URLs, keywords, category targets, or search seeds. Search-term mode returns suggestions rather than products.", "default": "auto" }, "market": { "title": "Market", "enum": [ "AE", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IE", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "US", "ZA" ], "type": "string", "description": "Amazon storefront to query.", "default": "US" }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum product rows delivered and billed per input (a keyword, a detail URL, a category or ranking target is one input). Default 70; larger numbers are collected in parts of 70. All row types count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor (limits set by the Actor developer). Alias: maxItems.", "default": 70 }, "category": { "title": "Category key", "enum": [ "all", "amazon-devices", "audible", "automotive", "baby", "beauty", "books", "computers", "electronics", "fashion", "garden", "grocery", "handmade", "health", "home", "industrial", "kindle-store", "kitchen", "luggage", "movies-tv", "music", "office-products", "pet-supplies", "software", "sports", "tools", "toys-and-games", "video-games" ], "type": "string", "description": "Department key such as electronics, books, or kitchen. For category or ranking modes, provide this field or a compatible browse node or ranking slug." }, "categoryNodeId": { "title": "Category browse node ID", "type": "string", "description": "Optional browse node from the selected Amazon storefront. Overrides the department's mapped node." }, "categorySlug": { "title": "Best Sellers category slug", "type": "string", "description": "Optional ranking category path, such as electronics. Overrides the department's mapped ranking path." }, "seedKeywords": { "title": "Seed keywords (for searchSeed mode)", "maxItems": 20, "type": "array", "description": "Optional starting terms for searchSeed mode, up to 20. If suggestions are unavailable, the Actor can return built-in department terms instead.", "items": { "type": "string" } }, "sort": { "title": "Search sort order", "enum": [ "featured", "relevance", "price-asc", "price-desc", "newest", "avg-review", "review-count" ], "type": "string", "description": "Sort keyword or category search results. Ranking and detail modes ignore this setting.", "default": "featured" }, "condition": { "title": "Condition filter", "enum": [ "new", "used", "collectible", "refurbished", "renewed" ], "type": "string", "description": "Item condition facet for keyword/category search. Not supported for bestsellers/newreleases/detail." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Minimum price for keyword or category search in the selected storefront's currency. Ranking and detail modes ignore this setting." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Maximum price for keyword or category search in the selected storefront's currency. Ranking and detail modes ignore this setting." }, "pages": { "title": "Pages per keyword", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum result pages for each input, from 1 to 5. Collection may stop sooner at the row or cost limit.", "default": 1 }, "scrapeDetails": { "title": "Add product details", "type": "boolean", "description": "Enable product-detail enrichment of listing rows. On by default; seller enrichment also requires enrichDetails and a positive enrichMaxItems value.", "default": true }, "enrichDetails": { "title": "Add seller business information", "type": "boolean", "description": "Add available seller business information to product rows. On by default; enrichment does not create a separate seller row.", "default": true }, "enrichMaxItems": { "title": "Maximum listing rows to enrich", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum top listing rows to enrich with seller information per collection input, from 0 to 20. Set 0 to skip listing enrichment.", "default": 1 }, "maxItemsPerKeyword": { "title": "Secondary row limit per keyword", "minimum": 1, "maximum": 100, "type": "integer", "description": "Optional secondary cap for one keyword task. It defaults to the schema maximum so maxItems controls the per-input row limit.", "default": 100 }, "workerBaseUrl": { "title": "Test endpoint", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" }, "provider": { "title": "Collection setting", "enum": [ "direct", "render", "httpx", "zyte" ], "type": "string", "description": "Leave unchanged. Used only by the developer for testing.", "default": "direct" }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Leave at 30. Changing this form setting currently leaves the request timeout unchanged; it is separate from the run timeout.", "default": 30 }, "userAgent": { "title": "Test request setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." }, "debug": { "title": "Test logging", "type": "boolean", "description": "Leave off. Used only by the developer for testing.", "default": false }, "includeRawHtml": { "title": "Test page capture", "type": "boolean", "description": "Leave off. Used only by the developer for testing.", "default": false }, "fixtureHtmlPath": { "title": "Test sample path", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }