{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper — Best Sellers, Ranks & Prices", "description": "Amazon search results, Best Sellers and New Releases as structured rows: ASIN, title, price, rating, rating count, image, sponsored flag and the exact position on the page. Track keyword rank and category charts in any marketplace. Pay per product row.", "version": "1.2", "x-build-id": "oeFjkJNhBeEqBCL9H" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kestrel~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kestrel-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/kestrel~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-kestrel-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/kestrel~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-kestrel-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", "properties": { "queries": { "title": "Search keywords", "uniqueItems": true, "type": "array", "description": "Keywords to search, exactly as a shopper would type them: \"wireless earbuds\", \"cast iron skillet\". Each is searched across the pages set below.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Category charts", "uniqueItems": true, "type": "array", "description": "Amazon category nodes to pull charts for, e.g. \"electronics\", \"kitchen\", \"books\" — the slug from a Best Sellers URL. Combined with the chart type below.", "default": [], "items": { "type": "string" } }, "chart": { "title": "Chart type", "enum": [ "bestsellers", "new_releases" ], "type": "string", "description": "Which category chart to pull for each category above. Movers & Shakers is rendered client-side by Amazon (its HTML carries no products), so it is not offered.", "default": "bestsellers" }, "pages": { "title": "Pages per keyword or category", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many result pages to walk. Search pages carry roughly 20 organic products each; charts carry about 30.", "default": 1 }, "maxResultsPerQuery": { "title": "Max products per keyword or category", "minimum": 0, "maximum": 2000, "type": "integer", "description": "0 = everything the pages returned. N = the first N in Amazon's order. The main cost control.", "default": 0 }, "skipSponsored": { "title": "Skip sponsored results", "type": "boolean", "description": "Drop ad placements and keep only organic results — the honest view of keyword rank. Skipped rows are never charged.", "default": false }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "0 = keep everything. 1-5 = keep only products rated at or above this. Filtered products are never charged.", "default": 0 }, "domain": { "title": "Marketplace", "type": "string", "description": "Amazon marketplace: com, co.uk, de, fr, it, es, ca, com.au, co.jp, in, com.mx, com.br, nl, se, pl, sa, ae, sg, com.tr, com.be.", "default": "com" }, "department": { "title": "Search department", "type": "string", "description": "Optional department to search inside, e.g. \"electronics\", \"kitchen\". Leave empty to search all of Amazon.", "default": "" }, "sessions": { "title": "Parallel sessions", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many proxy sessions (egress IPs) run in parallel. More is faster; each is paced separately.", "default": 4 }, "perIp": { "title": "Requests per second per IP", "minimum": 0.1, "maximum": 2, "type": "number", "description": "Pace for each session. Amazon tolerates about 0.5/s per IP; faster causes captchas, not speed.", "default": 0.5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is required: Amazon captchas datacentre traffic that is not rotated. RESIDENTIAL works best.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }