{ "openapi": "3.0.1", "info": { "title": "Amazon Product Research Scraper — BSR, Reviews & Seller", "description": "Research Amazon products by ASIN or keyword: price, Best Sellers Rank, ratings, seller, Prime status, bullet points, images and optional review snippets across 10 marketplaces (US, UK, DE, FR, CA, ES, IT, JP, AU, IN), one analysis-ready row per product.", "version": "1.6", "x-build-id": "pSo4Oe4kvVJY7HbwA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~amazon-product-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-amazon-product-intelligence", "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/khadinakbar~amazon-product-intelligence/runs": { "post": { "operationId": "runs-sync-khadinakbar-amazon-product-intelligence", "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/khadinakbar~amazon-product-intelligence/run-sync": { "post": { "operationId": "run-sync-khadinakbar-amazon-product-intelligence", "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": { "searchQuery": { "title": "Search Query (Keyword)", "type": "string", "description": "Use this when the user wants to search Amazon by keyword (e.g. 'wireless earbuds', 'vitamin C supplement'). Use startUrls instead when the user provides a direct Amazon product or search URL. Use asins instead when the user provides specific ASIN codes." }, "asins": { "title": "ASIN List", "type": "array", "description": "Use this when the user provides specific Amazon Standard Identification Numbers (ASINs), e.g. ['B07DF46NW9', 'B00FLYWNYQ']. Do NOT use this when the user describes a topic or category — use searchQuery for that.", "items": { "type": "string" } }, "startUrls": { "title": "Direct URLs", "type": "array", "description": "Use this when the user provides direct Amazon product pages (e.g. amazon.com/dp/...) or Amazon search result pages (amazon.com/s?k=...). Other URLs are rejected as invalid input.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "country": { "title": "Amazon Marketplace", "enum": [ "US", "UK", "DE", "FR", "CA", "ES", "IT", "JP", "AU", "IN" ], "type": "string", "description": "Which Amazon marketplace to scrape. Defaults to US (amazon.com). Options: US, UK, DE, FR, CA, ES, IT, JP, AU, IN.", "default": "US" }, "maxResults": { "title": "Max Products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of products to extract. Each product counts as one billable event. Start with a small number to test. Maximum recommended: 1000 per run.", "default": 50 }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Set to true to include the customer review snippets Amazon shows on each product page (up to maxReviews per product). Reviews are read from the product page itself, so no extra page load is needed on the native route.", "default": false }, "maxReviews": { "title": "Max Reviews Per Product", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many customer reviews to extract per product. Only used when includeReviews is true. Higher values take longer.", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the browser fallback route. The native page route always tries the Apify datacenter pool first and Apify Residential proxies pinned to the marketplace country when a page is blocked or shown for another region (converted currency, not deliverable). Apify Residential without a country is pinned to the marketplace country. Supply your own proxy URLs to route every request through them instead." } } }, "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 } } } } } } } } } }