{ "openapi": "3.0.1", "info": { "title": "Amazon Product Scraper", "description": "Scrape amazon.com by keyword, ASIN or URL: price, list price, rating, reviews, seller, Best Sellers Rank, images, variants. $1 per 1,000 results, proxies included.", "version": "0.1", "x-build-id": "sBdNkoFNuWM2z6i8W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lordfloofington~amazon-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lordfloofington-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/lordfloofington~amazon-product-scraper/runs": { "post": { "operationId": "runs-sync-lordfloofington-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/lordfloofington~amazon-product-scraper/run-sync": { "post": { "operationId": "run-sync-lordfloofington-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords to search on amazon.com, exactly as typed into its search bar, e.g. \"wireless earbuds\". Each keyword returns search results ($1.00 per 1,000), or full product details if \"Open each product page\" is on. Provide at least one keyword, ASIN or URL.", "items": { "type": "string" } }, "asins": { "title": "ASINs", "type": "array", "description": "10-character Amazon product IDs, e.g. B0BTYCRJSS. Each ASIN returns full product details ($4.00 per 1,000) and is returned before any search results. Use this for price tracking of known products.", "items": { "type": "string" } }, "startUrls": { "title": "amazon.com URLs", "type": "array", "description": "amazon.com search URLs (https://www.amazon.com/s?k=…) or product URLs (https://www.amazon.com/dp/ASIN). Product URLs return full product details and are returned before search results. Other URL types and other Amazon sites are skipped.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeProductDetails": { "title": "Open each product page for full details", "type": "boolean", "description": "Off (default): one result per product straight from search pages, with title, price, list price, rating, reviews, badges and sponsored flag, at $1.00 per 1,000. On: opens every product found by search and returns full details instead (brand, seller, availability, Best Sellers Rank, bullet points, all images, variants, specs) at $4.00 per 1,000. Has no effect on ASINs and product URLs, which always return full details.", "default": false }, "maxItems": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Exact maximum number of results returned and charged for in this run, across all keywords, ASINs and URLs. Products given as ASINs or product URLs are returned first. Runs by users on Apify's free plan are limited to 3 search queries, ASINs or URLs and 20 results per run.", "default": 100 }, "maxPagesPerQuery": { "title": "Max search pages per keyword", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many search result pages to read for each keyword. Amazon shows 16–60 products per page, so the default of 7 covers roughly 100–400 products per keyword. The run still stops at Max results.", "default": 7 }, "includeSponsored": { "title": "Include sponsored results", "type": "boolean", "description": "Keep sponsored (ad) placements from search pages. Every result is flagged with isSponsored either way; turn this off to return organic results only.", "default": true }, "postalCode": { "title": "US delivery ZIP code", "type": "string", "description": "US ZIP code that prices, offers and availability are shown for, e.g. 90210. Leave empty to use 10001 (New York). Keep it the same across runs to compare prices over time." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum parallel requests. The default of 10 suits almost every run; higher values finish faster but are retried more often.", "default": 10 } } }, "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 } } } } } } } } } }