{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper", "description": "Scrapes products from Amazon category and search result pages. Extracts detailed product data including prices, reviews, seller info, variants, and delivery details. Supports multiple Amazon domains.", "version": "1.0", "x-build-id": "jgD0keVUob6T3GXvV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-amazon-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/crawlerbros~amazon-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-amazon-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/crawlerbros~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-amazon-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": { "categoryUrls": { "title": "Category/Search URLs", "type": "array", "description": "List of Amazon category or search result URLs to scrape. Supports search pages (e.g., amazon.com/s?k=laptops) and browse nodes (e.g., amazon.com/b?node=123). A direct product URL (amazon.com/dp/...) pasted here also works and is fetched directly, same as Product URLs below. At least one of Category/Search URLs, Product URLs, Keywords, ASINs, Seller IDs, or Category Node IDs is required.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Direct Amazon product page URLs to scrape (e.g. amazon.com/dp/B08N5WRWNW). Always fetches full product-detail data for the exact product at that URL -- a guaranteed exact match, unlike ASINs (which search by text and take the closest result). Price/rating/Prime/sponsored/deal filters do not apply to this mode, since you're asking for one specific product by URL.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Plain search keywords/phrases. Each keyword builds an Amazon search URL (/s?k={query}) automatically.", "items": { "type": "string" } }, "asins": { "title": "ASINs", "type": "array", "description": "Amazon ASINs to look up. Each ASIN is searched (/s?k={ASIN}) and the matching search-result card is scraped, reusing the same search-card parser as other input modes. For a guaranteed exact match instead of a search approximation, use Product URLs (amazon.com/dp/{ASIN}) instead.", "items": { "type": "string" } }, "sellerIds": { "title": "Seller IDs", "type": "array", "description": "Amazon seller/merchant IDs. Each seller ID builds a storefront search URL (/s?me={sellerId}) listing that seller's products.", "items": { "type": "string" } }, "categoryNodeIds": { "title": "Category Node IDs", "type": "array", "description": "Amazon browse-node IDs. Each node ID builds a browse-node/category landing URL (/b?node={id}).", "items": { "type": "string" } }, "marketplaceDomain": { "title": "Marketplace Domain", "type": "string", "description": "Amazon marketplace domain used to build URLs for the Keywords/ASINs/Seller IDs/Category Node IDs input modes (ignored for Category/Search URLs, which are used as-is).", "default": "amazon.com" }, "maxItemsPerCategory": { "title": "Max Items Per Category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of products to scrape per category URL", "default": 10 }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of pages to scrape per category", "default": 1 }, "scrapeProductDetails": { "title": "Scrape Product Details", "type": "boolean", "description": "If true, scrapes full product details from individual product pages. If false, returns only data visible on category pages (faster).", "default": true }, "sortBy": { "title": "Sort By", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "Sort order applied to search/category results.", "default": "relevanceblender" }, "priceMin": { "title": "Minimum Price ($)", "minimum": 0, "type": "number", "description": "Only return products priced at or above this amount (in dollars)." }, "priceMax": { "title": "Maximum Price ($)", "minimum": 0, "type": "number", "description": "Only return products priced at or below this amount (in dollars)." }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only return products with a star rating at or above this value (0-5)." }, "includeSponsored": { "title": "Include Sponsored Results", "type": "boolean", "description": "If true (default), sponsored/ad results are included in the output. Set to false to only return organic results.", "default": true }, "onlyDeals": { "title": "Only Deals", "type": "boolean", "description": "If true, only return products with evidence of a deal (coupon, limited-time-deal badge, or a visible list/strike-through price).", "default": false }, "primeOnly": { "title": "Prime Only", "type": "boolean", "description": "If true, only return products with a visible Amazon Prime badge.", "default": false }, "proxyCountry": { "title": "Proxy Country", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "BR", "MX" ], "type": "string", "description": "Proxy country for geo-targeting. Use AUTO to automatically select based on Amazon domain.", "default": "AUTO" }, "useResidentialProxy": { "title": "Use Residential Proxy", "type": "boolean", "description": "Start every session on residential proxies (more reliable but more expensive ~$12.50/GB). Default (false) uses datacenter proxies (~$0.50/GB) and automatically escalates a session to residential only after repeated blocks.", "default": false }, "rateLimitDelay": { "title": "Rate Limit Delay (seconds)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Base delay between requests in seconds to avoid rate limiting", "default": 2 } } }, "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 } } } } } } } } } }