{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper - Global Search and Product Details", "description": "Scrape Amazon search results and product pages across 23 country storefronts.", "version": "0.0", "x-build-id": "QE723urk10pHvX0CA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hypebridge~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hypebridge-amazon-product-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/hypebridge~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-hypebridge-amazon-product-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/hypebridge~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-hypebridge-amazon-product-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": { "startUrls": { "title": "Start URLs", "maxItems": 50, "type": "array", "description": "Amazon search or product URLs from any supported storefront (for example amazon.de/s?k=maus or amazon.co.jp/dp/4837979653). Each URL keeps its own country marketplace.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "marketplaces": { "title": "Marketplaces", "minItems": 1, "maxItems": 23, "uniqueItems": true, "type": "array", "description": "Select storefronts for Search keywords and ASINs. Start URLs always use their own storefront. Default is US for existing workflows. Choose all 23 for a global run.", "items": { "type": "string", "enum": [ "US", "CA", "MX", "BR", "IE", "ES", "UK", "FR", "BE", "NL", "DE", "IT", "SE", "ZA", "PL", "SA", "EG", "TR", "AE", "IN", "SG", "AU", "JP" ], "enumTitles": [ "US", "CA", "MX", "BR", "IE", "ES", "UK", "FR", "BE", "NL", "DE", "IT", "SE", "ZA", "PL", "SA", "EG", "TR", "AE", "IN", "SG", "AU", "JP" ] }, "default": [ "US" ] }, "productUrls": { "title": "Product URLs", "maxItems": 50, "uniqueItems": true, "type": "array", "description": "Direct Amazon product page URLs. Use this simpler list for product-only batches; up to 50 URLs total across Start URLs and Product URLs.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique marketplace and ASIN pairs across the run. Search-only multi-market runs share this cap across storefronts; set it at least as high as the market count.", "default": 50 }, "getProductDetails": { "title": "Get full product details", "type": "boolean", "description": "Off: search results return the fields shown on the results page (title, price, rating, placement). On: also open every product page for full details (specs, images, seller, variants, identifiers). Slower and costs more per product. Product URLs and ASINs always return full details.", "default": false }, "searchQueries": { "title": "Search keywords", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Keywords to search in every selected marketplace. Up to 20 per run.", "items": { "type": "string" } }, "asins": { "title": "ASINs", "maxItems": 1000, "uniqueItems": true, "type": "array", "description": "10-character product IDs, including book ISBN-10 values. Each ASIN is opened in every selected marketplace; duplicates are removed by marketplace and ASIN.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{10}$" } }, "maxPages": { "title": "Max result pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search result pages to read for each search URL or keyword. The run also stops once Max products is reached or there are no more pages.", "default": 5 }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Off: skip products that appear only as ads. Products that also appear organically are always kept.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests. Lower it if you see many blocked-page retries in the log.", "default": 2 }, "maxRequests": { "title": "Max page requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on page requests across all selected marketplaces, including pagination and product details.", "default": 250 }, "debugMode": { "title": "Debug mode", "type": "boolean", "description": "Save the raw HTML of up to 5 failed pages to the key-value store.", "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 }, "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 } } } } } } } } } }