{ "openapi": "3.0.1", "info": { "title": "Amazon Product Data Scraper", "description": "Scrape Amazon product data by keyword or category/search URL across 20 country websites: price, rating, reviews, variants, seller, images and more.", "version": "1.0", "x-build-id": "mIWwRB5A16KD1rdhF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/delicious_zebu~amazon-product-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-delicious_zebu-amazon-product-data-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/delicious_zebu~amazon-product-data-scraper/runs": { "post": { "operationId": "runs-sync-delicious_zebu-amazon-product-data-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/delicious_zebu~amazon-product-data-scraper/run-sync": { "post": { "operationId": "run-sync-delicious_zebu-amazon-product-data-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": { "Keywords": { "title": "Search Keywords", "uniqueItems": false, "type": "array", "description": "Search terms, one per line — e.g. gaming keyboard, mechanical keyboard. Each term is searched on the Amazon site chosen below.", "default": [], "items": { "type": "string" } }, "website": { "title": "Website (Country/Region)", "enum": [ "amazon.com", "amazon.de", "amazon.co.uk", "amazon.ca", "amazon.com.au", "amazon.in", "amazon.sg", "amazon.ie", "amazon.com.mx", "amazon.es", "amazon.com.br", "amazon.sa", "amazon.ae", "amazon.eg", "amazon.it", "amazon.co.jp", "amazon.nl", "amazon.pl", "amazon.se", "amazon.com.tr" ], "type": "string", "description": "Amazon site to search — keywords only (a URL's site is taken from its own domain). Same as Amazon's 'Change country/region' menu, 20 sites. Each site is scraped as its local buyers see it.", "default": "amazon.com" }, "sort": { "title": "Sort by", "enum": [ "Featured", "Price: Low to High", "Price: High to Low", "Avg. Customer Review", "Newest Arrivals", "Best Sellers" ], "type": "string", "description": "Same as Amazon's 'Sort by' dropdown on the results page. Featured is Amazon's own relevance order.", "default": "Featured" }, "language": { "title": "Language", "enum": [ "default", "en", "ar", "de", "es", "fr", "he", "it", "ja", "ko", "nl", "pl", "pt", "sv", "tr", "zh_CN", "zh_TW" ], "type": "string", "description": "Page language for keyword searches. Site default = the site's own language. If a site doesn't offer the chosen language, its default is used (noted in the run log). On amazon.com, languages other than English/Spanish only take effect when Deliver to is outside the US (Amazon's own rule).", "default": "default" }, "Urls": { "title": "Filtered List Page URLs", "uniqueItems": false, "type": "array", "description": "Amazon search or category URLs, one per line, copied from your browser after filtering.", "default": [], "items": { "type": "string" } }, "deliverTo": { "title": "Deliver To", "enum": [ "US", "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", "CG", "CD", "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", "GN", "GW", "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", "NL", "AN", "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", "UY", "UZ", "VU", "VE", "VN", "VG", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "Delivery country for Amazon.com, same as the 'Deliver to' location in the top-left of Amazon pages (full country list from Amazon's own 'ship outside the US' menu). It affects which products are shown, prices and availability. Other country websites always deliver to their own country. For a precise location, set Zip Code below.", "default": "US" }, "zipCode": { "title": "Zip Code", "type": "string", "description": "Optional postal code for a precise 'Deliver to' location, in the selected site's own format (e.g. 10010 for amazon.com, 160-0022 for amazon.co.jp). A code Amazon rejects falls back to the site's default location (noted in the run log). On amazon.de and amazon.co.uk the location follows a local IP instead, so zip codes can't be applied there.", "default": "" }, "currency": { "title": "Currency", "enum": [ "default", "USD", "CLP", "COP", "HKD", "IDR", "ILS", "KRW", "MYR", "NZD", "THB", "TWD", "CRC", "PEN", "UYU", "BRL", "AUD", "CAD", "CNY", "EUR", "JPY", "MXN", "GBP", "AED", "SGD", "SAR", "NOK", "ARS", "AMD", "AWG", "AZN", "BSD", "BZD", "BOB", "BND", "BGN", "KHR", "KYD", "DOP", "XCD", "EGP", "GHS", "GTQ", "HUF", "INR", "JMD", "KZT", "KES", "LBP", "HNL", "MOP", "MUR", "MAD", "NAD", "NGN", "PAB", "PYG", "QAR", "RUB", "ZAR", "TZS", "PHP", "TTD", "MNT", "TRY", "VND", "SEK", "PLN", "BBD", "BMD", "XPF", "XOF", "XAF", "NIO", "CZK", "DKK", "GEL", "GYD", "PKR", "RON", "MVR", "LKR", "CHF", "UZS" ], "type": "string", "description": "Site default = the site's own currency. Amazon converts prices where it supports the chosen currency; otherwise they stay in the site's currency. On amazon.com, conversion only applies when Deliver to is outside the US.", "default": "default" }, "maxItems": { "title": "Max Items", "minimum": 1, "type": "integer", "description": "Maximum number of products to scrape per keyword or URL. Crawling stops once this many products are collected (pagination is handled automatically). Lower = faster & cheaper.", "default": 100 }, "scrapeProductDetails": { "title": "Scrape Product Details", "type": "boolean", "description": "ON (default): visit each product's detail page for the full field set (description, best sellers rank, seller, rating breakdown, all images, variants, etc.). OFF: use only the search results page — much faster and cheaper, but only basic listing fields (title, price, rating, review count, bought-in-past-month, badge, thumbnail).", "default": true } } }, "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 } } } } } } } } } }