{ "openapi": "3.0.1", "info": { "title": "Amazon Products Scraper", "description": "Scrape Amazon products by keyword, category, or URL. Get price, rating, reviews, brand, availability & images across 7 marketplaces. Export to JSON, CSV, Excel or deliver to Notion, Slack & more.", "version": "0.1", "x-build-id": "E1vbburZauGlPbhmg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/techforce.global~amazon-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-techforce.global-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/techforce.global~amazon-scraper/runs": { "post": { "operationId": "runs-sync-techforce.global-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/techforce.global~amazon-scraper/run-sync": { "post": { "operationId": "run-sync-techforce.global-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": { "searchKeywords": { "title": "Search keywords", "type": "array", "description": "Keywords to search for on Amazon (e.g. \"wireless headphones\"). Each keyword is searched separately and the matching result pages are scraped.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (search / category / product)", "type": "array", "description": "Amazon URLs to scrape directly. Supports search result pages, category/listing pages, and individual product (/dp/ or /gp/product/) pages. Listing pages are crawled and their products enqueued; product pages are scraped directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "amazonDomain": { "title": "Amazon marketplace", "enum": [ "www.amazon.in", "www.amazon.com", "www.amazon.co.uk", "www.amazon.de", "www.amazon.ca", "www.amazon.com.au", "www.amazon.ae" ], "type": "string", "description": "Marketplace domain used to build search URLs from keywords.", "default": "www.amazon.in" }, "maxItemsPerSearch": { "title": "Max products per search / start URL", "minimum": 0, "type": "integer", "description": "Maximum number of products to scrape for each keyword or listing start URL. Set to 0 for no limit.", "default": 100 }, "maxPagesPerSearch": { "title": "Max listing pages per search", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of result pages to paginate through for each search / listing. Amazon typically caps search results around page 7-20.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Amazon aggressively blocks scrapers, so Apify Residential proxies are strongly recommended (requires a paid Apify plan).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "mcpConnector": { "title": "Deliver to (MCP connector)", "type": "string", "description": "Optionally deliver the scraped products into a connector you have authorized — Notion, Slack, Linear, Airtable, Jira, GitHub, or any MCP-compatible connector. Leave empty to only save the results to the dataset." }, "deliveryMode": { "title": "Delivery mode", "enum": [ "perProduct", "summary", "none" ], "type": "string", "description": "How to deliver to the connector: 'perProduct' (one call per scraped product), 'summary' (one call containing all products), or 'none' (save to dataset only).", "default": "perProduct" }, "mcpTool": { "title": "Connector tool name", "type": "string", "description": "Name of the tool to call on the connector (e.g. 'create_page' for Notion, 'send_message' for Slack, 'create_issue' for Jira/GitHub). If unsure, run once with a connector selected — the log lists the connector's available tools.", "default": "" }, "mcpArguments": { "title": "Connector tool arguments", "type": "object", "description": "Arguments passed to the connector tool. String values support {placeholders}. In 'perProduct' mode: {asin}, {title}, {brand}, {price}, {priceRaw}, {currency}, {rating}, {reviewsCount}, {availability}, {url}, {thumbnailUrl}, {searchName}, {position} and {message} (the rendered template below). In 'summary' mode: {productCount}, {products} (a markdown list of all products) and {message}. Example for Slack: {\"channel\": \"#products\", \"text\": \"{message}\"}.", "default": {} }, "mcpMessageTemplate": { "title": "Message template", "type": "string", "description": "Optional template rendered and exposed as the {message} placeholder in the tool arguments. Per-product example: '*{title}* — {priceRaw} ({rating}★, {reviewsCount} reviews)\\n{url}'. Summary example: 'Found {productCount} products:\\n\\n{products}'.", "default": "" } } }, "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 } } } } } } } } } }