{ "openapi": "3.0.1", "info": { "title": "Amazon Product & Review Scraper", "description": "Scrape Amazon products, reviews, and search results across multiple countries. Supports stealth mode with anti-detection and Apify Proxy integration.", "version": "1.0", "x-build-id": "KBu1gfh1Sc1Jh0sLO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/qianyii~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-qianyii-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/qianyii~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-qianyii-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/qianyii~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-qianyii-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": [ "action" ], "properties": { "action": { "title": "Action", "enum": [ "product", "reviews", "full", "search", "multi_country" ], "type": "string", "description": "What to scrape: product details, reviews, full (details+reviews), or search.", "default": "full" }, "asins": { "title": "ASINs", "type": "array", "description": "Amazon product ASIN(s) to scrape. Used for product, reviews, full, and multi_country actions.", "items": { "type": "string" } }, "keyword": { "title": "Search Keyword", "type": "string", "description": "Keyword to search on Amazon. Used only for the 'search' action." }, "country": { "title": "Amazon Marketplace", "enum": [ "us", "uk", "de", "jp", "fr", "ca", "it", "es", "au" ], "type": "string", "description": "Which Amazon country site to scrape.", "default": "us" }, "countries": { "title": "Countries (Multi-Country Mode)", "type": "string", "description": "Comma-separated country codes for multi-country price comparison. E.g. us,uk,de,jp", "default": "us,uk,de" }, "maxReviews": { "title": "Max Reviews per Product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of reviews to scrape per ASIN.", "default": 100 }, "sortReviews": { "title": "Review Sort Order", "enum": [ "recent", "helpful" ], "type": "string", "description": "How to sort reviews.", "default": "recent" }, "filterReviews": { "title": "Review Filter", "enum": [ "all", "positive", "critical", "5_star", "4_star", "3_star", "2_star", "1_star", "verified" ], "type": "string", "description": "Filter reviews by star rating or type.", "default": "all" }, "maxPages": { "title": "Max Search Pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of search result pages to scrape.", "default": 3 }, "sortSearch": { "title": "Search Sort Order", "enum": [ "relevance", "price_low", "price_high", "avg_review", "newest", "best_sellers" ], "type": "string", "description": "How to sort search results.", "default": "relevance" }, "minPrice": { "title": "Min Price Filter", "type": "number", "description": "Minimum price filter for search results (leave empty for no filter)." }, "maxPrice": { "title": "Max Price Filter", "type": "number", "description": "Maximum price filter for search results (leave empty for no filter)." }, "primeOnly": { "title": "Prime Only", "type": "boolean", "description": "Only include Amazon Prime eligible products in search results.", "default": false }, "minRating": { "title": "Min Star Rating (1-4)", "minimum": 1, "maximum": 4, "type": "integer", "description": "Minimum average star rating filter for search results. Enter 1, 2, 3, or 4." }, "excludeSponsored": { "title": "Exclude Sponsored Products", "type": "boolean", "description": "Skip sponsored/ad products in search results.", "default": false }, "fetchDetails": { "title": "Fetch Product Details After Search", "type": "boolean", "description": "After searching, also scrape full details for each product found.", "default": false }, "detailCount": { "title": "Number of Products to Fetch Details For", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many products from search results to fetch full details for.", "default": 20 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify Proxy settings. Residential proxies are strongly recommended for Amazon." } } }, "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 } } } } } } } } } }