{ "openapi": "3.0.1", "info": { "title": "Amazon Search Scraper", "description": "Scrapes Amazon keyword search results across 18 marketplaces: organic rank separated from sponsored placements, structured local-currency prices, sales badges, ratings. Batch keywords, filters applied before charging, error items never charged.", "version": "0.0", "x-build-id": "qXZ85Ezq8lWv36jnn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cyprusapi~amazon-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cyprusapi-amazon-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/cyprusapi~amazon-search/runs": { "post": { "operationId": "runs-sync-cyprusapi-amazon-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/cyprusapi~amazon-search/run-sync": { "post": { "operationId": "run-sync-cyprusapi-amazon-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", "properties": { "keywords": { "title": "Keywords", "type": "array", "description": "Search keywords or phrases. Batch them: many keywords in one run share startup cost. Also accepts a single keyword via 'query'.", "items": { "type": "string" } }, "query": { "title": "Single keyword (alternative)", "type": "string", "description": "Convenience field for one keyword — used when 'keywords' is empty." }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Amazon search result URLs to scrape directly. Apply any filters on Amazon first (Prime, price band, condition, deals, brand…) and paste the URL — Amazon's own query params (rh, s, low-price, high-price, …) are server-side filters and pass through untouched. The domain sets the marketplace and must be one of the 18 supported (unknown domains yield a free error item). Combine freely with keywords; at least one of keywords/query/searchUrls is required.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "marketplace": { "title": "Marketplace", "enum": [ "de", "com", "co.uk", "fr", "it", "es", "ca", "com.au", "co.jp", "in", "nl", "se", "pl", "be", "mx", "br", "ae", "sa" ], "type": "string", "description": "Amazon marketplace to search on.", "default": "com" }, "maxPages": { "title": "Max pages per keyword/URL", "minimum": 1, "maximum": 20, "type": "integer", "description": "Search result pages to scrape per keyword or search URL (Amazon renders ~16-48 cards per page).", "default": 1 }, "startPage": { "title": "Start page", "minimum": 1, "maximum": 20, "type": "integer", "description": "First result page to scrape (for continuing a previous run).", "default": 1 }, "sortBy": { "title": "Sort order", "enum": [ "RELEVANCE", "LOWEST_PRICE", "HIGHEST_PRICE", "REVIEWS", "NEWEST", "BEST_SELLERS" ], "type": "string", "description": "Amazon's own sort order for the result pages.", "default": "RELEVANCE" }, "language": { "title": "Language override", "type": "string", "description": "Optional Amazon locale parameter (e.g. 'en_US', 'de_DE'). Default: the marketplace's own language." }, "excludeSponsored": { "title": "Exclude sponsored placements", "type": "boolean", "description": "Skip sponsored cards entirely (they never occupy organic rank positions either way).", "default": false }, "minStars": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only push products with at least this rating (0 = no filter). Applied before charging.", "default": 0 }, "minReviews": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Only push products with at least this many reviews (0 = no filter). Applied before charging.", "default": 0 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Only push products at/above this price in marketplace currency (0 = no filter). Applied before charging.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Only push products at/below this price in marketplace currency (0 = no filter). Applied before charging.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional — the actor ships with bundled geo proxies per marketplace (no setup needed, we cover the cost). Enable this only to force your own or Apify proxies instead.", "default": { "useApifyProxy": false } }, "proxiesByMarketplace": { "title": "Per-marketplace proxies", "type": "object", "description": "Optional geo-pinned proxies per marketplace ({\"com\": [\"http://…\"], …}). Prevents wrong-currency results and geo bot-gates. Proxy tier chain per task: this explicit pool FIRST; otherwise the bundled shared pool (we cover it); on blocked/transport the run falls back to Apify datacenter, then Apify residential. With useApifyProxy off and no pool at all: single direct attempt." } } }, "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 } } } } } } } } } }