{ "openapi": "3.0.1", "info": { "title": "Amazon Search Results Scraper · Rank & sponsored · $0.8/1K", "description": "Get Amazon search results by keyword or search URL for product research, rank tracking and competitor monitoring on amazon.com. Returns ASIN, price, stars, reviews, badges, sponsored flag, delivery text and search position. $0.8/1K results.", "version": "0.1", "x-build-id": "k80vD2AmIAZ5uoj6w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~amazon-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-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/mlg14~amazon-search-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-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/mlg14~amazon-search-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Amazon.com keywords; each keyword runs its own search and is stored in every result row. Example: [\"wireless earbuds\"]. Use it for rank and price checks per keyword.", "default": [ "wireless earbuds" ], "items": { "type": "string" } }, "startUrls": { "title": "Search URLs", "type": "array", "description": "Public amazon.com /s search URLs with a k or keywords parameter, as {\"url\": ...} objects; URL filters are kept. Example: [{\"url\": \"https://www.amazon.com/s?k=wireless+earbuds\"}]. Use it to reuse a filtered search; leave empty for keywords only.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResultsPerQuery": { "title": "Results per query", "minimum": 0, "type": "integer", "description": "Maximum results per keyword or URL (integer, 0 = only page and total limits apply). Example: 35. Use a small number for quick checks.", "default": 50 }, "maxResults": { "title": "Total results", "minimum": 0, "type": "integer", "description": "Maximum results across all searches (integer, 0 = no total cap). Example: 100. Use it as a safety limit for budgets.", "default": 0 }, "maxPages": { "title": "Pages per query", "minimum": 1, "maximum": 20, "type": "integer", "description": "Search result pages to request per input, 1 to 20. Example: 3. Use more pages for deeper rank tracking.", "default": 5 }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "featured-rank" ], "type": "string", "description": "Amazon sort order for keyword searches. Allowed values: relevance, price-asc-rank, price-desc-rank, review-rank, date-desc-rank, featured-rank. Example: review-rank. Use relevance for default ranking. A sort order already in a search URL takes precedence.", "default": "relevance" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lower price bound in US dollars (integer, 0 = off). Example: 20. Use it with Max price to set a price band.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Upper price bound in US dollars (integer, 0 = off). Example: 100. Use it with Min price to set a price band.", "default": 0 }, "primeOnly": { "title": "Prime offers only", "type": "boolean", "description": "If true, applies the Prime filter on Amazon search pages (true or false). Example: true. Leave false for all listings.", "default": false }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "If true, includes sponsored product cards, which always count toward rank positions (true or false). Example: false to drop ads. Keep true for accurate ad-share and rank tracking.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is used automatically; override only if needed.", "default": { "useApifyProxy": true } }, "fourStarsOnly": { "title": "4 stars and up", "type": "boolean", "description": "If true, applies the Amazon 4 Stars & Up filter (true or false). Example: true. Leave false for all ratings.", "default": false } } }, "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 } } } } } } } } } }