{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Extract product data from Amazon — title, price, description, images, ASIN, and more. Enter one or more product URLs.", "version": "0.1", "x-build-id": "0WBoT3v6g6ocVGmSl" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shanks0x0~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shanks0x0-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/shanks0x0~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-shanks0x0-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/shanks0x0~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-shanks0x0-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", "required": [ "categoryOrProductUrls" ], "properties": { "categoryOrProductUrls": { "title": "Amazon URLs", "type": "array", "description": "One or more Amazon product URLs (e.g. /dp/B0XXXXX), category URLs, or search result URLs. Supports all Amazon domains.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItemsPerStartUrl": { "title": "Max Results Per URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of products to scrape per start URL.", "default": 100 }, "maxSearchPagesPerStartUrl": { "title": "Max Search Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of search/category result pages to follow per start URL.", "default": 5 }, "language": { "title": "Language", "enum": [ "en", "de", "fr", "es", "it", "ja", "pt", "nl", "sv", "pl", "ar", "cs", "da", "ko", "zh_CN", "zh_TW" ], "type": "string", "description": "Language for Amazon pages (e.g. en, de, fr, es, it, ja).", "default": "en" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy configuration for geo-targeting." }, "proxyCountry": { "title": "Proxy Country", "enum": [ "AUTO_SELECT_PROXY_COUNTRY", "US", "DE", "GB", "FR", "ES", "IT", "JP", "CA", "AU", "IN", "BR", "MX", "NL", "SE", "PL", "SG", "AE", "SA", "TR" ], "type": "string", "description": "Proxy country to use for avoiding geo-blocking (requires proxy).", "default": "AUTO_SELECT_PROXY_COUNTRY" }, "countryCode": { "title": "Delivery Country", "type": "string", "description": "Country code for delivery location pricing (e.g. US, DE, GB).", "default": "" }, "zipCode": { "title": "ZIP Code", "type": "string", "description": "ZIP/postal code for precise delivery pricing.", "default": "" }, "scrapeProductDetails": { "title": "Scrape Product Details", "type": "boolean", "description": "If enabled, each product from search/category results is scraped in detail.", "default": true }, "maxProductVariantsAsSeparateResults": { "title": "Max Variants Per Product", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum number of product variants to scrape as separate results (0 = disabled).", "default": 0 }, "scrapeProductVariantPrices": { "title": "Scrape Variant Prices", "type": "boolean", "description": "If enabled, scrape prices for different product variations.", "default": false }, "maxOffers": { "title": "Max Offers", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum number of offers (other sellers) to scrape per product.", "default": 0 }, "scrapeSellers": { "title": "Scrape Seller Info", "type": "boolean", "description": "If enabled, scrape seller details for each product.", "default": false }, "useCaptchaSolver": { "title": "Use CAPTCHA Solver", "type": "boolean", "description": "If enabled, the scraper attempts to detect CAPTCHAs (may slow down scraping).", "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 } } } } } } } } } }