{ "openapi": "3.0.1", "info": { "title": "Amazon Scraper — Search, Products & Best Sellers (No Login)", "version": "0.1", "x-build-id": "j8Fjqa4cC27Xmqjim" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sondalabs~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sondalabs-amazon-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/sondalabs~amazon-scraper/runs": { "post": { "operationId": "runs-sync-sondalabs-amazon-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/sondalabs~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-sondalabs-amazon-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": { "mode": { "title": "Mode", "enum": [ "search", "product", "bestsellers" ], "type": "string", "description": "What to scrape. Search reads search terms and search or category URLs; Product reads ASINs and product URLs; Best Sellers reads Best Sellers URLs. An input the chosen mode does not read makes the run fail before anything is charged. Product mode (and product details) is available on amazon.com, amazon.com.mx and amazon.com.br; Search and Best Sellers also work on amazon.co.jp.", "default": "search" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Keywords for Search mode. Leave empty to search a default headphones term in the chosen marketplace's language. Not read in Product or Best Sellers mode (the run fails with a clear message if you fill it there).", "default": [], "items": { "type": "string" } }, "asins": { "title": "ASINs", "type": "array", "description": "10-character Amazon product IDs for Product mode.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Amazon search, category, Best Sellers or product URLs. The marketplace is taken from each URL.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "marketplace": { "title": "Marketplace", "enum": [ "amazon.com", "amazon.com.mx", "amazon.com.br", "amazon.co.jp" ], "type": "string", "description": "Amazon site used for search terms and ASINs.", "default": "amazon.com" }, "maxItemsPerStart": { "title": "Max results per search, URL or category", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum results per search term, category or start URL.", "default": 50 }, "maxPages": { "title": "Max pages per search or category", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum result pages to read per search or category.", "default": 20 }, "maxItems": { "title": "Max results per run", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum charged results for the whole run.", "default": 500 }, "scrapeProductDetails": { "title": "Open every product", "type": "boolean", "description": "In Search and Best Sellers modes, open every product and return the full product record (charged as product details). Available on amazon.com, amazon.com.mx and amazon.com.br.", "default": false }, "includeRatingsHistogram": { "title": "Exact ratings and star breakdown", "type": "boolean", "description": "Add the exact number of ratings and the 1–5 star breakdown.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify datacenter proxy is recommended. Residential traffic is used automatically only as a fallback for blocked pages.", "default": { "useApifyProxy": true } }, "allowResidentialFallback": { "title": "Residential fallback for blocked pages", "type": "boolean", "description": "If a page is still blocked after 7 attempts on datacenter IPs, use residential IPs of the marketplace's country for the last 3 attempts, up to maxResidentialMB.", "default": true }, "maxResidentialMB": { "title": "Max residential traffic (MB)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Cap on residential traffic per run.", "default": 200 } } }, "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 } } } } } } } } } }