{ "openapi": "3.0.1", "info": { "title": "Amazon Search Results Scraper — Full Product Row, Flat Fee", "description": "Amazon search: type a keyword and get full product detail for every result — price, buy box, stock, rating, reviews, variants, bestseller ranks, images and specs. From $1.50 per 1,000 products, one flat fee, no add-on events. Blocked or empty searches are never charged.", "version": "1.0", "x-build-id": "urERRbTXKcr5YPBWX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/steadyfetch~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-steadyfetch-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/steadyfetch~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-steadyfetch-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/steadyfetch~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-steadyfetch-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Amazon search terms, e.g. [\"wireless earbuds\", \"coffee maker\"] — any number, one search each. A keyword Amazon returns nothing for, and a search a robot check blocked, are never charged: both come back as a row saying which. An ASIN or product link belongs in steadyfetch/amazon-product-scraper, a Best Sellers link in steadyfetch/amazon-bestsellers-scraper, a seller id or storefront in steadyfetch/amazon-seller-scraper. Send the field as a list — leaving it out is fine, but this one field cannot be null. Every optional field below accepts null — the Marketplace and Sort by dropdowns included — and null there simply means \"use the default\". A dropdown value that is not on its list is answered with one uncharged row naming the values that work, never quietly swapped for the default. Leave this untouched and click Start to run a 5-product sample search (\"wireless earbuds\" on amazon.com).", "default": [], "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "type": "string", "description": "Which Amazon store to search. Amazon runs a separate catalogue per country. Search is verified end to end on amazon.com; amazon.co.uk and amazon.de are best-effort. The domain, the country code or the country name all work — amazon.co.uk, GB and United Kingdom are the same store. Null or empty means amazon.com; a store that is not on this list is answered with one uncharged row naming the stores that are.", "default": "amazon.com" }, "maxProductsPerKeyword": { "title": "Max products per keyword", "minimum": 1, "type": "integer", "description": "How many products to return for each keyword, taken in Amazon's own result order across up to 3 result pages. Up to 100 — ask for more and the run continues at 100, with one uncharged row saying so.", "default": 40 }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Sponsored (ad) results are included and flagged with isSponsored. Turn this off to skip them — they are never fetched, so a skipped sponsored result costs nothing.", "default": true }, "department": { "title": "Department (optional)", "type": "string", "description": "Narrow the search to a department, e.g. electronics or kitchen. Leave empty to search all departments." }, "sortBy": { "title": "Sort by", "type": "string", "description": "How Amazon orders the results. Featured is Amazon's own default order. The value or the name of the order both work — price-asc and \"Price: low to high\" are the same sort. Null or empty means Featured; a sort that is not on this list is answered with one uncharged row naming the ones that are.", "default": "relevance" }, "maxItems": { "title": "Max products (whole run)", "minimum": 0, "type": "integer", "description": "Hard cap on delivered products across all keywords. 0 means no run-wide cap. Up to 5,000 per run — ask for more and the run continues at 5,000, with one uncharged row saying so.", "default": 0 }, "maxRunSeconds": { "title": "Max run seconds", "type": "integer", "description": "The run stops cleanly before this and reports what is left, instead of being killed by the platform timeout. Between 60 and 21,600 seconds — ask outside that and the run continues at the nearest of the two, with one uncharged row saying so.", "default": 3600 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "Every colour, size or flavour of each product, with its own ASIN. Turn off for a smaller row; the price does not change.", "default": true }, "includeSpecs": { "title": "Include specifications", "type": "boolean", "description": "The product-details table (brand, model, dimensions, materials and so on). Turn off for a smaller row; the price does not change.", "default": 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 } } } } } } } } } }