{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Amazon Product Scraper — Extract detailed Amazon product data including titles, prices, ASINs, ratings, reviews, images, descriptions, features, availability, sellers, and product URLs. Ideal for product research, price tracking, competitor analysis, and e-commerce insights.", "version": "0.4", "x-build-id": "GAyxOHc2Q0lz8mCXy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fastdataapi~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fastdataapi-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/fastdataapi~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-fastdataapi-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/fastdataapi~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-fastdataapi-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 search, category or product URLs", "type": "array", "description": "Add one entry per line. Accepted:\n1. Search or category result links, e.g. https://www.amazon.com/s?k=keyboard or a category link with filters applied (price, brand, rating and so on).\n2. Product links, e.g. https://www.amazon.com/dp/B0B3BVWJ6Y.\n3. Plain keywords, e.g. wireless mouse, which are searched on amazon.com.\n\nEvery link is scraped on its own marketplace (amazon.de, amazon.co.uk, amazon.co.jp and so on). Entries that are not Amazon links are skipped and listed in the log.", "items": { "type": "string" } }, "maxItemsPerStartUrl": { "title": "🔢 Max results per URL", "minimum": 0, "type": "integer", "description": "How many search results to keep for each search or category URL. 0 = all results the search shows. A product URL gives its product (plus its variants when you ask for them).\n\nFree plan: up to 20 products per run (all start URLs together) and 200 per month; paid plans have no limit.", "default": 10 }, "maxSearchPagesPerStartUrl": { "title": "🔢 Max search pages per URL", "minimum": 1, "type": "integer", "description": "Stop after this many search result pages for each search or category URL. The run stops at whichever comes first: this page count or Max results per URL. Amazon caps how many pages one search shows; to reach more products, split the search into narrower category or filter links.", "default": 9999 }, "scrapeProductDetails": { "title": "✅ Scrape product details", "type": "boolean", "description": "On: every search result also gets its product page data (brand, bullets, description, specifications, images, videos, delivery, seller, ranks, variants, rating breakdown, top reviews and more).\n\nOff: only the data shown on the search results page (ASIN, title, URL, image, price, rating, review count, sponsored flag, position) - much faster. Product URLs always load their product page.", "default": true }, "maxProductVariantsAsSeparateResults": { "title": "🔢 Variants as separate results", "minimum": 0, "type": "integer", "description": "Save up to this many other variants (color, size, style) of each product as their own full result rows. 0 = off. The variant list with its options is always included in the product row under variants." }, "scrapeProductVariantPrices": { "title": "✅ Scrape variant prices", "type": "boolean", "description": "Add the current price of every variant to the product's variants list.", "default": false }, "maxOffers": { "title": "🔢 Max offers per product", "minimum": 0, "type": "integer", "description": "How many marketplace offers (price, condition, delivery, seller) to collect per product, buy-box offer first. 0 = no offer list.", "default": 0 }, "scrapeSellers": { "title": "✅ Scrape seller profiles", "type": "boolean", "description": "Add the seller profile (business name, address, rating, ratings count, positive feedback) to the product's seller and to every collected offer's seller. Amazon's own retail stores have no public seller profile.", "default": false }, "ensureLoadedProductDescriptionFields": { "title": "✅ Make sure descriptions are loaded", "type": "boolean", "description": "Amazon sometimes serves product pages without the feature bullets and description. When on, such pages are loaded again on a fresh session until those sections are present. More requests, more complete data.", "default": false }, "countryCode": { "title": "📍 Delivery country", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "CI", "HR", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GT", "GG", "GW", "GN", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "AN", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "QA", "KR", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SR", "SJ", "SZ", "SE", "CH", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "Country to deliver to. Leave empty for the marketplace's default location. The zip code below is used when this is empty or matches the marketplace's own country (e.g. US on amazon.com); for any other country only the country is set." }, "zipCode": { "title": "📍 Delivery zip code", "type": "string", "description": "Zip or postal code to deliver to, e.g. 10001 for New York on amazon.com. With only a country set, Amazon may pick a different zip code for every session." }, "locationDeliverableRoutes": { "title": "🎯 Apply the delivery location to", "type": "array", "description": "Page types that use the delivery location: PRODUCT (product pages and seller profiles), SEARCH (search and category pages), OFFERS (offer lists and variant prices). Leaving a type out makes it a little faster but its prices and delivery data follow Amazon's default location.", "items": { "type": "string", "enum": [ "PRODUCT", "SEARCH", "OFFERS" ] }, "default": [ "PRODUCT", "SEARCH", "OFFERS" ] }, "language": { "title": "🌍 Language", "enum": [ "cs", "da", "de", "en", "es", "fr", "nl", "pl", "pt", "sv", "tr", "he", "ar", "mrta", "hi", "bn", "ta", "te", "kn", "ml", "ko", "zh_CN", "zh_TW", "ja" ], "type": "string", "description": "Language of the Amazon pages. Each marketplace supports its own set of languages; an unsupported choice falls back to the marketplace's default language." }, "maxConcurrentRequests": { "title": "⚡ Max concurrent requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages load at the same time. Higher is faster; lower is gentler when Amazon blocks a lot.", "default": 10 }, "useCaptchaSolver": { "title": "✅ Use captcha solver", "type": "boolean", "description": "Solve Amazon's image captchas with your CapSolver key (field below or the CAPSOLVER_API_KEY environment variable) instead of only retrying on a fresh session. Without a key, captchas are retried on a fresh session.", "default": false }, "capSolverApiKey": { "title": "🔑 CapSolver API key", "type": "string", "description": "Your CapSolver API key, used only when Use captcha solver is on. Stored as a secret and never written to the output or the log." }, "proxyCountry": { "title": "📍 Proxy country", "enum": [ "AUTO_SELECT_PROXY_COUNTRY", "NO_PROXY", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GW", "GN", "GY", "HT", "HM", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UM", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW", "AX" ], "type": "string", "description": "Country of the proxy IP addresses. Automatic matches each Amazon marketplace (amazon.de uses German IPs, amazon.co.uk British ones, and so on). No proxy uses a direct connection.", "default": "AUTO_SELECT_PROXY_COUNTRY" }, "proxyConfiguration": { "title": "🌐 Proxy", "type": "object", "description": "Proxy for all requests. Residential proxy gives the fewest blocks. If the proxy keeps refusing connections, the run continues with a direct connection." } } }, "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 } } } } } } } } } }