{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper: Results, Rank, Price & Sales", "description": "Amazon search scraper for any keyword or search URL. Get search rank, ASIN, price, list price, rating, reviews, bought in past month, Best Seller and Amazon's Choice badges and delivery dates for any US ZIP (no extra fee). $1 per 1,000 results. Export CSV/JSON or use the API.", "version": "0.1", "x-build-id": "vhNVqgkxUdh1MmSi1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jaaylee~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jaaylee-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/jaaylee~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-jaaylee-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/jaaylee~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-jaaylee-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": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search keywords or URLs", "type": "array", "description": "Keywords to search on Amazon.com (e.g. wireless earbuds), or full amazon.com search result URLs with your filters. One per line. Duplicates are removed.", "items": { "type": "string" } }, "maxPagesPerSearch": { "title": "Pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to scrape for each search (Amazon shows 16-48 results per page, up to 20 pages).", "default": 1 }, "sort": { "title": "Sort by", "enum": [ "relevance", "price-asc", "price-desc", "reviews", "newest", "bestsellers" ], "type": "string", "description": "Result order, as in Amazon's 'Sort by' menu. Ignored for search URLs that already contain a sort.", "default": "relevance" }, "zipCode": { "title": "Delivery ZIP code (US)", "pattern": "^\\d{5}(-\\d{4})?$", "type": "string", "description": "Optional. Results, prices and delivery dates are shown as a shopper in this US ZIP code sees them. Included at no extra cost." }, "maxItems": { "title": "Max results in total", "minimum": 1, "type": "integer", "description": "Optional. Stop after this many results across all searches (useful to cap cost)." }, "maxItemsPerSearch": { "title": "Max results per search", "minimum": 1, "type": "integer", "description": "Optional. Stop each search after this many results." }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Keep results marked as Sponsored (when Amazon shows them in the page). Turn off to get organic results only.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages are fetched in parallel.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Primary proxy. The default Apify datacenter proxy works for most search pages.", "default": { "useApifyProxy": true } }, "residentialFallback": { "title": "Retry blocked pages with residential proxy", "type": "boolean", "description": "If a page stays blocked after 3 attempts on the primary proxy, retry it up to 2 more times through US residential proxies. Blocked pages are never charged either way.", "default": true }, "failOnLowQuality": { "title": "Fail run on low data quality (monitoring)", "type": "boolean", "description": "For monitoring tasks: mark the run as failed when fewer than 80% of pages succeed or key fields are missing.", "default": false } } }, "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 } } } } } } } } } }