{ "openapi": "3.0.1", "info": { "title": "Amazon Products & Search Scraper", "description": "Extract Amazon product search results, pricing, availability, sellers, ratings, and product details across marketplaces.", "version": "0.1", "x-build-id": "pFlrfxNOnEzTniO1t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fetch_cat~amazon-products-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fetch_cat-amazon-products-search-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/fetch_cat~amazon-products-search-scraper/runs": { "post": { "operationId": "runs-sync-fetch_cat-amazon-products-search-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/fetch_cat~amazon-products-search-scraper/run-sync": { "post": { "operationId": "run-sync-fetch_cat-amazon-products-search-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": { "queries": { "title": "Search queries", "type": "array", "description": "Product names, brands, keywords, or models to search for. Supply at least one non-empty query, start URL, or ASIN; no individual input list is required. Up to 100 unique queries, each at most 200 characters.", "items": { "type": "string" } }, "startUrls": { "title": "Amazon search or product URLs", "type": "array", "description": "Public Amazon search or product detail URLs, using HTTPS and the exact www.amazon domain for the selected marketplace (for example www.amazon.co.uk for UK). Can be combined with queries and ASINs. Search URL filters and sorting are used as supplied.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "asins": { "title": "ASINs", "type": "array", "description": "Ten-character Amazon Standard Identification Numbers for direct product extraction.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "US", "CA", "UK", "DE", "FR", "IT", "ES", "AU", "IN", "JP" ], "type": "string", "description": "Amazon marketplace used for queries and ASINs.", "default": "US" }, "sort": { "title": "Search sorting", "enum": [ "relevance", "price-asc", "price-desc", "reviews", "newest" ], "type": "string", "description": "Amazon sort order requested for generated query searches only: relevance, price ascending, price descending, average customer review, or newest. Existing search URLs retain their own sorting; ASINs and product URLs are not sorted. Amazon may mix sponsored placements into results.", "default": "relevance" }, "maxItems": { "title": "Maximum products", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique product rows saved across all queries, URLs, and ASINs.", "default": 20 }, "enrichDetails": { "title": "Enrich product details", "type": "boolean", "description": "Add available brand, category, list price, savings, availability, seller, variant ASINs, and images to search results. Default false. Successful optional enrichment adds a detail event; missing fields remain empty. ASIN and product URL inputs always obtain details, regardless of this setting. Recent details may be reused according to detailCacheMaxAgeMinutes.", "default": false }, "detailCacheMaxAgeMinutes": { "title": "Reuse recent product details", "minimum": 0, "maximum": 1440, "type": "integer", "description": "Maximum age of a reusable public product-detail snapshot: 0–1440 minutes, default 60. Set 0 to request fresh details. Search rank and sponsored placement come from this run. Live enrichment can replace search prices; cached enrichment keeps available search prices and fills missing fields from the snapshot. Detail source and timestamp are included in diagnostics when details are available.", "default": 60 }, "proxyMode": { "title": "Proxy cost and reliability mode", "enum": [ "auto", "datacenter", "residential" ], "type": "string", "description": "Default auto preserves automatic access: direct first, then country-matched datacenter and residential fallback when needed. Datacenter and Residential use only that selected proxy route, with no switch between proxy types. Proxy routes can incur platform usage; consult the live Pricing tab. This Actor does not offer a direct-only mode or custom proxy configuration. Use only auto, datacenter, or residential; unsupported values are rejected before extraction.", "default": "auto" } } }, "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 } } } } } } } } } }