{ "openapi": "3.0.1", "info": { "title": "Amazon US Search & Product Scraper", "description": "Collect Amazon.com search results, full product details by ASIN and seller catalogs. Verified US ZIP, image galleries, typed prices, seller data and explicit coverage.", "version": "0.0", "x-build-id": "MI5180c24Yrct0c7v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/commercestack~amazon-us-search-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-commercestack-amazon-us-search-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/commercestack~amazon-us-search-product-scraper/runs": { "post": { "operationId": "runs-sync-commercestack-amazon-us-search-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/commercestack~amazon-us-search-product-scraper/run-sync": { "post": { "operationId": "run-sync-commercestack-amazon-us-search-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", "required": [ "mode" ], "properties": { "mode": { "title": "Collection mode", "enum": [ "lookup_only", "products", "search_only", "seller_catalog" ], "type": "string", "description": "Choose product lookup, full product fields, search listings or seller catalog.", "default": "lookup_only" }, "products": { "title": "ASINs or product URLs", "type": "array", "description": "Amazon.com ASINs or product URLs.", "items": { "type": "string" } }, "queries": { "title": "Search queries", "type": "array", "description": "Search phrases. Used by search_only or query-driven products mode.", "items": { "type": "string" } }, "sellerIds": { "title": "Merchant IDs", "type": "array", "description": "Amazon merchant IDs for seller_catalog mode. Catalog identity is separate from the featured seller.", "items": { "type": "string" } }, "marketplaces": { "title": "Marketplace", "type": "array", "description": "Only com (Amazon.com) is supported.", "default": [ "com" ], "items": { "type": "string" } }, "maxItems": { "title": "maxItems", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum distinct product identities in the collection.", "default": 100 }, "maxItemsPerSource": { "title": "maxItemsPerSource", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum distinct products collected from each query or seller.", "default": 100 }, "maxPagesPerSource": { "title": "maxPagesPerSource", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum source pages per query or seller. Reaching the cap is reported as partial coverage.", "default": 3 }, "maxConcurrency": { "title": "maxConcurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Concurrent native workers. Maximum 4.", "default": 4 }, "maxRequests": { "title": "maxRequests", "minimum": 1, "maximum": 300, "type": "integer", "description": "Global source request budget, including location preparation and bounded retries.", "default": 100 }, "maxRunSeconds": { "title": "maxRunSeconds", "minimum": 1, "maximum": 600, "type": "integer", "description": "Global source-work deadline in seconds.", "default": 180 }, "maxWireBytes": { "title": "maxWireBytes", "minimum": 1, "maximum": 100000000, "type": "integer", "description": "Maximum observed source traffic bytes. Failed-request estimates are reported separately.", "default": 40000000 }, "includeSponsored": { "title": "Include sponsored search placements", "type": "boolean", "description": "Include source-marked sponsored search placements.", "default": true }, "enrichProducts": { "title": "Enrich seller catalog products", "type": "boolean", "description": "seller_catalog only: fetch each discovered product card. Adds requests and cost.", "default": false }, "locations": { "title": "Delivery locations", "type": "object", "description": "Optional US delivery context, for example {\"com\":{\"postalCode\":\"10001\",\"currency\":\"USD\",\"deliveryCountry\":\"US\"}}. Only US ZIP/USD supported." } } }, "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 } } } } } } } } } }