{ "openapi": "3.0.1", "info": { "title": "Amazon Product Search Scraper", "description": "Amazon search results and product pages as structured JSON: ASIN, title, brand, price, list price, discount, rating, review count, Prime, sponsored, Best Seller and Amazon's Choice badges, delivery and images. Works on 14 marketplaces (US, UK, DE, FR, IT, ES, CA, AU, IN, JP, MX, NL, SE, PL).", "version": "0.1", "x-build-id": "YpMbWz1DAAPshsNZM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearrun~amazon-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearrun-amazon-products", "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/clearrun~amazon-products/runs": { "post": { "operationId": "runs-sync-clearrun-amazon-products", "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/clearrun~amazon-products/run-sync": { "post": { "operationId": "run-sync-clearrun-amazon-products", "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 terms", "type": "array", "description": "One search per line, exactly as you would type it into Amazon's search box. Each term returns the ranked products from the search result pages.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Optional. Amazon product page URLs (any marketplace, any URL form containing /dp/ or /gp/product/). Each returns one richer record with features, availability, seller, breadcrumbs, attributes and all images.", "default": [], "items": { "type": "string" } }, "asins": { "title": "ASINs", "type": "array", "description": "Optional. Plain 10-character ASINs to fetch as product pages on the selected marketplace, e.g. B0DZZVLF6N.", "default": [], "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "ca", "com.au", "in", "co.jp", "com.mx", "nl", "se", "pl" ], "type": "string", "description": "Which Amazon site to search. Prices and delivery text come in that site's currency and language.", "default": "com" }, "maxResultsPerQuery": { "title": "Max results per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Stop after this many products for each search term. Amazon shows up to about 20 pages (roughly 300-500 products) per search.", "default": 100 }, "sortBy": { "title": "Sort", "enum": [ "relevance", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "Order of results, as on Amazon.", "default": "relevance" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "number", "description": "Lowest price to include, in the marketplace's currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "number", "description": "Highest price to include, in the marketplace's currency." }, "primeOnly": { "title": "Prime only", "type": "boolean", "description": "Only return products with the Prime badge.", "default": false }, "language": { "title": "Language", "type": "string", "description": "Optional page language override such as en_US, de_DE or en_GB. Leave empty for the marketplace's own language." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Amazon blocks data-centre traffic, so residential proxies are used by default. The exit country is pinned to the marketplace's home country automatically.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }