{ "openapi": "3.0.1", "info": { "title": "Amazon Sponsored Products & Search Results Scraper", "description": "Scrape Amazon search results for any keyword at $0.10 per 1,000 products: position, ASIN, title, price, list price, rating, review count, Prime, sponsored flag and badges, up to 20 pages per search, on amazon.com and amazon.ca. No login; only-new-products mode.", "version": "0.1", "x-build-id": "I4MMcmqhDhR1PtyR4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aurelix~amazon-product-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aurelix-amazon-product-search", "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/aurelix~amazon-product-search/runs": { "post": { "operationId": "runs-sync-aurelix-amazon-product-search", "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/aurelix~amazon-product-search/run-sync": { "post": { "operationId": "run-sync-aurelix-amazon-product-search", "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": [ "searches" ], "properties": { "searches": { "title": "Searches", "type": "array", "description": "Keywords as you would type them into Amazon's search box, e.g. 'coffee grinder' or 'usb c cable 6ft', or Amazon search result URLs, e.g. 'https://www.amazon.com/s?k=yoga+mat&i=sporting' (their filters are kept).", "default": [], "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Results per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Most products to return per search, e.g. 100. Amazon shows up to 20 result pages per search (often 7), about 16-60 products each including sponsored ones.", "default": 100 }, "marketplace": { "title": "Amazon marketplace", "enum": [ "com", "ca" ], "type": "string", "description": "Which Amazon keywords are searched on. Search URLs keep their own marketplace.", "default": "com" }, "category": { "title": "Department", "enum": [ "", "electronics", "garden", "lawngarden", "beauty", "hpc", "toys-and-games", "sporting", "pets", "baby-products", "fashion", "tools", "automotive", "office-products", "computers", "mobile", "appliances", "grocery", "stripbooks", "videogames", "arts-crafts", "industrial" ], "type": "string", "description": "Limit keyword searches to one department, e.g. Electronics; 'All departments' = Amazon's default. The names follow amazon.com's department menu; on amazon.ca the matching department is used.", "default": "" }, "sort": { "title": "Sort by", "enum": [ "relevance", "price-asc", "price-desc", "reviews", "newest", "best-sellers" ], "type": "string", "description": "Order of the results, as in Amazon's 'Sort by' menu.", "default": "relevance" }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Keep sponsored (ad) results, each flagged with sponsored = true. Turn off to get organic results only; positions still count every card on the page.", "default": true }, "onlyNewProducts": { "title": "Only new products", "type": "boolean", "description": "Return only products (ASINs) not seen in this search at your previous runs. The first run returns everything; schedule it daily to see newcomers. In this mode a search stops at the first page with nothing new, and each results page read costs $0.0003 (only-new-page).", "default": false }, "stateKey": { "title": "Tracking name (optional)", "type": "string", "description": "Name for the 'previous runs' memory used by 'Only new products', e.g. 'grinders-daily'. Leave empty to share one memory per search across all your runs." }, "residentialFallback": { "title": "Residential fallback (paid add-on)", "type": "boolean", "description": "Off by default. When on and every datacenter session gets a robot check, the page is retried on up to 3 residential proxy sessions. The residential fee ($0.012) applies to every request sent over residential, even if Amazon returns no matches or refuses the request. Each search starts on datacenter; within a search, once a page needed residential, that search's later pages try residential first. Choosing the RESIDENTIAL group in 'Proxy' counts every page as residential. Challenges are never solved.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is required; the default datacenter group is tried first.", "default": { "useApifyProxy": true } }, "slackWebhookUrl": { "title": "Slack webhook URL (optional)", "type": "string", "description": "After each run, post a short digest to Slack: how many results were saved (new ones only when 'Only new products' is on) and the top 10 with links, e.g. https://hooks.slack.com/services/T000/B000/XXXX. Nothing is posted when the run saved nothing. Leave empty to skip." }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "After each run, POST the same digest as JSON (actor, newOnly, count, items = top 10 results, runUrl, text) to any URL, e.g. a Zapier, Make or n8n webhook. Nothing is sent when the run saved nothing. Leave empty to skip." } } }, "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 } } } } } } } } } }