{ "openapi": "3.0.1", "info": { "title": "Amazon Search Results Scraper", "description": "Just $0.99 per 1,000 results — scrape Amazon search results for ASINs, titles, prices, ratings, reviews, rankings, sponsored products and more.", "version": "1.0", "x-build-id": "6Yg9ZIpnFmFsPZrD6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapecrafter~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapecrafter-amazon-search-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/scrapecrafter~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-scrapecrafter-amazon-search-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/scrapecrafter~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-scrapecrafter-amazon-search-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": [ "queries", "marketplace" ], "properties": { "queries": { "title": "Search queries", "maxItems": 100, "type": "array", "description": "Amazon search keywords. Each query is scraped independently.", "items": { "type": "string", "minLength": 1 }, "default": [ "wireless headphones" ] }, "marketplace": { "title": "Amazon marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.ca", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.co.jp", "amazon.in", "amazon.com.au", "amazon.nl", "amazon.com.mx", "amazon.com.br" ], "type": "string", "description": "Amazon domain to search.", "default": "amazon.com" }, "maxPages": { "title": "Maximum pages per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum Amazon result pages to scrape for each query.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum successfully extracted products across the run. Use 0 for no explicit result limit.", "default": 0 }, "sort": { "title": "Sort order", "enum": [ "relevance", "price_low_to_high", "price_high_to_low", "customer_reviews", "newest" ], "type": "string", "description": "Amazon search sorting method. Some options may vary by marketplace.", "default": "relevance" }, "excludeSponsored": { "title": "Exclude sponsored products", "type": "boolean", "description": "If enabled, sponsored products are excluded from the dataset.", "default": false }, "deduplicate": { "title": "Deduplicate by ASIN", "type": "boolean", "description": "If enabled, the same ASIN is returned only once across all queries and pages.", "default": true }, "proxySettings": { "title": "Proxy", "type": "object", "description": "Apify Proxy configuration used by Crawlee for Amazon requests." }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of Amazon search pages requested simultaneously.", "default": 2 }, "requestDelayMs": { "title": "Request delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay in milliseconds before each Amazon page request.", "default": 1000 }, "maxRetries": { "title": "Retries per page", "minimum": 0, "maximum": 5, "type": "integer", "description": "Maximum number of retry attempts after an Amazon request fails.", "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 } } } } } } } } } }