{ "openapi": "3.0.1", "info": { "title": "Amazon Product Details Scraper (Bestsellers & New Releases)", "description": "Amazon Product Details Scraper extracts detailed data for bestsellers and new releases, including titles, prices, ASINs, ratings, reviews, rankings, images, availability, sellers, and product URLs. Ideal for product research, market analysis, competitor tracking, and e-commerce intelligence.", "version": "0.1", "x-build-id": "OvxeInagHhUWRbMu8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simpleapi~amazon-product-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simpleapi-amazon-product-details-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/simpleapi~amazon-product-details-scraper/runs": { "post": { "operationId": "runs-sync-simpleapi-amazon-product-details-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/simpleapi~amazon-product-details-scraper/run-sync": { "post": { "operationId": "run-sync-simpleapi-amazon-product-details-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": { "listUrls": { "title": "๐Ÿ”— Ranked list addresses", "type": "array", "description": "Amazon Best Sellers, New Releases or Most Wished For list addresses. Example: https://www.amazon.com/gp/bestsellers/electronics/", "items": { "type": "string" } }, "listTypes": { "title": "๐Ÿ“Š List types to build", "type": "array", "description": "Pick one or more ranked-list families. Combined with the categories below to build a list for each pairing. Leave empty if you already pasted addresses above.", "items": { "type": "string", "enum": [ "best-sellers", "new-releases", "most-wished-for" ], "enumTitles": [ "Best Sellers", "New Releases", "Most Wished For" ] } }, "categoryNodes": { "title": "๐Ÿ—‚๏ธ Categories or category ids", "type": "array", "description": "Category names as they appear in a list address (electronics, kitchen, books) or numeric Amazon category ids (172282, 11036491). Used together with the list types above.", "items": { "type": "string" } }, "listPagesToScan": { "title": "๐Ÿ“„ Ranked positions depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many ranked-list views to read per list. Each one adds up to 30 further ranked positions." }, "maxProductsPerList": { "title": "๐Ÿ”ข Maximum products per list", "minimum": 0, "type": "integer", "description": "Stop after this many qualifying products per list. Set 0 to keep every qualifying item." }, "topRanksOnly": { "title": "๐Ÿ† Keep only the top N ranks", "minimum": 0, "type": "integer", "description": "Ignore any item whose rank is higher than this number. Set 0 to keep every rank." }, "minCardRating": { "title": "โญ Minimum star rating", "enum": [ "", "3.0", "3.5", "4.0", "4.2", "4.5", "4.7", "4.8" ], "type": "string", "description": "Keep only items whose star rating on the ranked list clears this bar. Items with no rating are dropped when a bar is set." }, "maxCardPrice": { "title": "๐Ÿ’ฒ Maximum price", "minimum": 0, "type": "integer", "description": "Keep only items priced at or below this amount on the ranked list, in the marketplace currency. Set 0 to keep every price." }, "skipDuplicateAsins": { "title": "๐Ÿงน Collect each product only once", "type": "boolean", "description": "When two lists rank the same product, collect it once. Every rank it held is still reported on the row.", "default": true }, "listOnly": { "title": "โšก Ranked cards only", "type": "boolean", "description": "Return the ranked cards (rank, title, price, rating, image) without collecting the full product record for each one.", "default": false }, "asins": { "title": "๐Ÿ”Ž Amazon ASINs", "type": "array", "description": "One or more product ASINs or product addresses. Each one is turned into a product record.", "items": { "type": "string" } }, "marketplaceDomain": { "title": "๐ŸŒ Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.es", "amazon.it", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.com.mx", "amazon.nl", "amazon.se", "amazon.pl", "amazon.com.br", "amazon.sg", "amazon.ae", "amazon.sa", "amazon.com.tr", "amazon.com.be", "amazon.ie", "amazon.eg" ], "type": "string", "description": "The Amazon marketplace to read." }, "amazonDomain": { "title": "๐ŸŒ Amazon domain (legacy key)", "type": "string", "description": "Same setting as Marketplace, kept so an existing input file keeps working. A value here other than amazon.com takes precedence.", "default": "amazon.com" }, "pageLanguage": { "title": "๐Ÿ—ฃ๏ธ Content language", "enum": [ "", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "ja-JP", "zh-CN", "nl-NL", "pt-BR", "sv-SE", "pl-PL", "tr-TR", "ar-AE" ], "type": "string", "description": "Request localized content. Leave empty to use the marketplace default." }, "language": { "title": "๐Ÿ—จ๏ธ Language (legacy key)", "enum": [ "", "en-US", "en-GB", "de-DE", "fr-FR", "es-ES", "it-IT", "ja-JP", "zh-CN" ], "type": "string", "description": "Same setting as Content language, kept so an existing input file keeps working. A value here takes precedence.", "default": "" }, "exitCountry": { "title": "๐Ÿ“ Marketplace region", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "MX", "NL", "SE", "PL", "BR", "SG", "AE", "SA", "TR", "BE", "IE", "EG" ], "type": "string", "description": "Read the marketplace as a shopper in this country. Regional lists and prices differ by country, so leave this matched to the marketplace unless you want another region's view." }, "proxyCountry": { "title": "๐Ÿงญ Region (legacy key)", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP" ], "type": "string", "description": "Same setting as Marketplace region, kept so an existing input file keeps working. A value other than AUTO takes precedence.", "default": "AUTO" }, "proxyConfiguration": { "title": "โš™๏ธ Network configuration", "type": "object", "description": "Network settings for the run. The default is recommended: it keeps the marketplace region consistent so prices and ranked lists come back for the country you selected above." } } }, "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 } } } } } } } } } }