{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape Amazon product data — price, BSR, rating, seller, FBA status, variants — from search, category, URL, or ASIN input across 18 marketplaces. Flat JSON output optimized for AI agents and MCP.", "version": "0.1", "x-build-id": "KaGjZgeWfKCqcoRbK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-amazon-product-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/khadinakbar~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-amazon-product-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/khadinakbar~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-amazon-product-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": { "searchQuery": { "title": "Search query", "type": "string", "description": "Free-text keyword search run on Amazon (e.g. 'wireless earbuds'). Opens the search results page for the selected marketplace and extracts each product. NOT an Amazon URL — paste URLs into 'startUrls' instead. Leave empty if you use 'asins' or 'startUrls'." }, "asins": { "title": "ASIN list", "type": "array", "description": "Specific Amazon Standard Identification Numbers (e.g. ['B08N5WRWNW','B09G9HD6PD']). Each ASIN is resolved against the selected marketplace domain. NOT a URL list — for URLs use 'startUrls'. NOT a keyword — for keywords use 'searchQuery'.", "items": { "type": "string", "pattern": "^[A-Z0-9]{10}$" }, "default": [] }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Direct Amazon URLs — product pages ('/dp/ASIN'), search result pages ('/s?k=...'), or category pages. The domain inside each URL overrides the 'country' setting below. Use this when you already have the exact URLs to scrape.", "default": [], "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", "MX", "BR", "NL", "SE", "PL", "TR", "AE", "SG" ], "type": "string", "description": "Which Amazon marketplace to use when you pass 'searchQuery' or 'asins'. Ignored when 'startUrls' contains a different Amazon domain. Defaults to US (amazon.com).", "default": "US" }, "maxResults": { "title": "Max products", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum products to scrape across all inputs combined (searchQuery + asins + startUrls). Each product returned is billed as one 'product-scraped' event at $0.004. Start small (5–25) to verify output before large jobs.", "default": 50 }, "maxSearchPages": { "title": "Max search pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search or category result pages to paginate through per start URL or search query. Each page has ~48 products. Amazon caps most searches at ~7 pages — higher values are silently clipped.", "default": 3 }, "scrapeProductDetails": { "title": "Scrape full product pages", "type": "boolean", "description": "When true, every product found on a search/category page is fetched again on its own product page for full data (bullets, A+ content, BSR, variants, seller). When false, the scraper returns only the summary fields visible on the search page — faster and cheaper but shallower.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Amazon blocks datacenter IPs — residential proxies are required and are the default. Override only if you have a specific compliance reason.", "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 } } } } } } } } } }