{ "openapi": "3.0.1", "info": { "title": "Amazon Search, Category & Seller Listings Extractor", "description": "Get Amazon products from search results, categories, seller storefronts, or ASIN lookups across 20+ marketplaces, with price, rating, badges, deals, and delivery details.", "version": "1.0", "x-build-id": "aAJedoI4DhBVoe0x1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~amazon-search-category-and-seller-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-amazon-search-category-and-seller-listings", "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/dataspryva~amazon-search-category-and-seller-listings/runs": { "post": { "operationId": "runs-sync-dataspryva-amazon-search-category-and-seller-listings", "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/dataspryva~amazon-search-category-and-seller-listings/run-sync": { "post": { "operationId": "run-sync-dataspryva-amazon-search-category-and-seller-listings", "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": { "categoryUrls": { "title": "Search, Category & Product URLs", "type": "array", "description": "Amazon search, category, seller-profile, or exact product URLs. Search pages (/s?k=), browse nodes (/b?node=), seller profiles (/sp?seller=), and product pages (/dp/) are routed automatically. Combine with any other mode.", "items": { "type": "string" } }, "keywords": { "title": "Search Keywords", "type": "array", "description": "Plain search keywords or phrases. Each keyword builds an Amazon search URL (/s?k={query}).", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Exact Amazon product URLs. Each URL is normalized to /dp/{ASIN} on its own marketplace and fetched directly (never as a search).", "items": { "type": "string" } }, "asins": { "title": "ASINs", "type": "array", "description": "Amazon ASINs to fetch exactly. Each ASIN opens its own product page (/dp/{ASIN}) directly, never a keyword search.", "items": { "type": "string" } }, "sellerIds": { "title": "Seller IDs", "type": "array", "description": "Amazon seller/merchant IDs. Each ID builds that seller's storefront listing (/s?me={sellerId}).", "items": { "type": "string" } }, "categoryNodeIds": { "title": "Category Node IDs", "type": "array", "description": "Amazon browse-node IDs. Each node builds a real category listing (/s?rh=n:{node}&fs=true), with a merchandising fallback only when Amazon renders no listing grid.", "items": { "type": "string" } }, "marketplaceDomain": { "title": "Marketplace", "enum": [ "amazon.com", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.ca", "amazon.com.au", "amazon.co.jp", "amazon.in", "amazon.com.br", "amazon.com.mx", "amazon.nl", "amazon.se", "amazon.pl", "amazon.com.tr", "amazon.ae", "amazon.sa", "amazon.sg", "amazon.com.be", "amazon.eg" ], "type": "string", "description": "Amazon marketplace used for keyword, ASIN, seller, and node modes. URLs in categoryUrls/productUrls keep their own marketplace.", "default": "amazon.com" }, "maxItems": { "title": "Maximum Items (all sources)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Global cap across every source in the run. 0 means no global cap.", "default": 0 }, "maxItemsPerCategory": { "title": "Maximum Items Per Source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum products to return from each keyword, URL, seller, or node source.", "default": 10 }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum listing pages per source. Amazon keyword search itself stops at page 7; category listings go deeper.", "default": 1 }, "scrapeProductDetails": { "title": "Scrape Product Details", "type": "boolean", "description": "If true, visit each accepted product's own page for specs, gallery images, seller, BSR, variants, and histogram. ASIN/product-URL modes always use detail pages. If false, only listing-card fields are returned.", "default": true }, "includeSpecifications": { "title": "Include Specifications", "type": "boolean", "description": "If true (and detail pages are scraped), return the specifications object parsed from the overview and technical-detail tables.", "default": true }, "sortBy": { "title": "Sort By", "enum": [ "relevanceblender", "price-asc-rank", "price-desc-rank", "review-rank", "date-desc-rank", "exact-aware-popularity-rank" ], "type": "string", "description": "Sort order applied to search and category listings.", "default": "relevanceblender" }, "priceMin": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Only return products priced at or above this amount (marketplace currency)." }, "priceMax": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Only return products priced at or below this amount (marketplace currency)." }, "minRating": { "title": "Minimum Rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Only return products with a star rating at or above this value (0-5)." }, "includeSponsored": { "title": "Include Sponsored Results", "type": "boolean", "description": "If true (default), sponsored/ad placements are included. Set false to return organic results only.", "default": true }, "onlyDeals": { "title": "Only Deals", "type": "boolean", "description": "If true, only return products with visible deal evidence (coupon, limited-time-deal badge, or genuine strike-through list price).", "default": false }, "primeOnly": { "title": "Prime Only", "type": "boolean", "description": "If true, only return products with a visible Amazon Prime badge. Badges are render-dependent in some marketplaces.", "default": false }, "rateLimitDelay": { "title": "Base Request Delay (seconds)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Base pacing delay between live requests. Product-detail requests always add human-like jitter.", "default": 2 } } }, "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 } } } } } } } } } }