{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper", "description": "The Amazon Search Results Scraper lets you extract product data directly from Amazon search results. Collect titles, prices, ratings, ASINs, URLs, and more at scale. Ideal for market research, competitor analysis, and e-commerce insights. Fast, accurate, and customizable scraping solution.", "version": "0.2", "x-build-id": "rITikfRxmuANBlAKp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": [ "urls" ], "properties": { "urls": { "title": "šŸ”— Keywords or Amazon Search URLs āœļø", "type": "array", "description": "šŸ“ Add one or more entries ā€” each runs as its own search task.\n\nāœ… Examples:\n ā€¢ šŸ”¤ `laptop` ā† simple keyword\n ā€¢ šŸ”¤ `wireless headphones`\n ā€¢ šŸŒ `https://www.amazon.com/s?k=gaming+chair`\n ā€¢ šŸŒ `https://www.amazon.co.uk/s?k=running+shoes`\n\nšŸ’” Tip: Plain keywords default to amazon.com. Paste a country-specific search URL to scrape that domain instead. šŸŒ", "items": { "type": "string" } }, "maxResults": { "title": "šŸ“¦ Max products to collect šŸ”¢", "minimum": 1, "maximum": 10000, "type": "integer", "description": "šŸŽÆ The total cap for this run, across all keywords combined.\n\nšŸ’Ø Smaller values = faster runs. Larger values = more pages crawled.\nšŸ“Š Tip: ~22 products fit on one page, so 50 ā‰ˆ 3 pages, 200 ā‰ˆ 10 pages.", "default": 10 }, "sortBy": { "title": "ā†•ļø Sort search results šŸ“Š", "enum": [ "relevanceblender", "recent" ], "type": "string", "description": "šŸŽØ Choose how Amazon orders search results before scraping.\n\nšŸŽÆ **Relevance** ā€” Amazon's default best-match ranking (great for product discovery).\nšŸ†• **Most Recent** ā€” newest listings first (great for catching trends).", "default": "relevanceblender" }, "proxyConfiguration": { "title": "šŸŒšŸ›”ļø Proxy Configuration šŸ”Œ", "type": "object", "description": "šŸ”’ Configure a proxy for stronger reliability against bot blocks.\n\nšŸ’” **Recommended for best results:** āœ… enable Apify Proxy, group `RESIDENTIAL`.\nšŸš€ **Faster but less stealthy:** group `DATACENTER`.\nāš” **Skip entirely:** leave empty to run with a direct connection.\n\nšŸŒ The actor automatically picks a sticky session so cookies stay consistent across pages ā€” no manual setup needed!" } } }, "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 } } } } } } } } } }