{ "openapi": "3.0.1", "info": { "title": "Amazon Multi-Domain Product Price & Detail Scraper", "description": "Pull pricing, ratings, seller, variant and technical detail for Amazon products by URL or ASIN, across 21 country domains, with optional delivery postal-code targeting.", "version": "1.0", "x-build-id": "0Bfb9bnO1sEJObmDM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~amazon-multi-domain-product-price-and-detail/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-amazon-multi-domain-product-price-and-detail", "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/nimbryxo-studio~amazon-multi-domain-product-price-and-detail/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-amazon-multi-domain-product-price-and-detail", "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/nimbryxo-studio~amazon-multi-domain-product-price-and-detail/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-amazon-multi-domain-product-price-and-detail", "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": { "productUrls": { "title": "Product URLs", "type": "array", "description": "Amazon product URLs to scrape. Any mix of the 21 supported country domains is allowed, e.g. https://www.amazon.com/dp/B0B8PD8TTP.", "items": { "type": "string" }, "default": [] }, "asins": { "title": "ASINs", "type": "array", "description": "Bare 10-character Amazon ASINs. Builds /dp/{ASIN} URLs on the selected marketplace, or on every domain listed in `domains` for cross-marketplace runs.", "items": { "type": "string" }, "default": [] }, "searchTerms": { "title": "Search Terms", "type": "array", "description": "Keyword queries to run on Amazon search pages. Price/rating/deal/condition/sort filters are applied as URL parameters.", "items": { "type": "string" }, "default": [] }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Full Amazon search URLs to pass through, including your own `i=`, `rh=`, `low-price`, and `s=` parameters. Pagination is added automatically.", "items": { "type": "string" }, "default": [] }, "bestsellerUrls": { "title": "Bestseller List URLs", "type": "array", "description": "Amazon bestseller /zgbs/ or /gp/bestsellers/ list URLs. Returns the ranked product cards, optionally enriched with product-detail fields.", "items": { "type": "string" }, "default": [] }, "marketplace": { "title": "Marketplace", "enum": [ "auto", "amazon.com", "amazon.ca", "amazon.com.mx", "amazon.com.br", "amazon.co.uk", "amazon.de", "amazon.fr", "amazon.it", "amazon.es", "amazon.nl", "amazon.com.be", "amazon.se", "amazon.pl", "amazon.com.tr", "amazon.ae", "amazon.sa", "amazon.eg", "amazon.in", "amazon.co.jp", "amazon.com.au", "amazon.sg" ], "type": "string", "description": "Marketplace used for bare ASINs and keyword search terms. `auto` uses the first product URL's domain, or amazon.com.", "default": "auto" }, "domains": { "title": "Additional Domains", "type": "array", "description": "Optional list of marketplaces (e.g. amazon.com, amazon.de) to run bare ASINs and search terms across. Leave empty to use `marketplace` only.", "items": { "type": "string" }, "default": [] }, "language": { "title": "Language", "enum": [ "auto", "en_US", "en_GB", "en_CA", "en_AU", "en_IN", "en_SG", "de_DE", "fr_FR", "it_IT", "es_ES", "es_MX", "pt_BR", "nl_NL", "nl_BE", "sv_SE", "pl_PL", "tr_TR", "ja_JP", "ar_AE", "ar_SA", "ar_EG" ], "type": "string", "description": "Page language. `auto` uses the marketplace's own default. Explicit values set `?language=` and the matching Accept-Language header.", "default": "auto" }, "currency": { "title": "Display Currency", "enum": [ "auto", "USD", "EUR", "GBP", "JPY", "CAD", "AUD", "INR", "BRL", "MXN", "SEK", "PLN", "TRY", "AED", "SAR", "EGP", "SGD", "CNY", "CHF", "HKD", "NZD", "ZAR", "NOK", "DKK", "CZK", "HUF", "ILS", "KRW", "THB", "MYR", "PHP", "IDR", "VND" ], "type": "string", "description": "ISO currency for the displayed price. `auto` uses the marketplace currency. Note: Amazon converts display currency; it is not guaranteed local retail pricing.", "default": "auto" }, "deliveryCountry": { "title": "Delivery Country", "enum": [ "auto", "AU", "BE", "BR", "CA", "DE", "EG", "ES", "FR", "GB", "IN", "IT", "JP", "MX", "NL", "PL", "SA", "SE", "SG", "TR", "AE", "US" ], "type": "string", "description": "Optional country hint. When `postalCode` is empty, a representative local ZIP for that country is used. A country alone is not sent to Amazon.", "default": "auto" }, "postalCode": { "title": "Postal Code", "type": "string", "description": "Local ZIP/postal code for the delivery location. The actor validates it against the marketplace format and skips the location change if it does not match.", "default": "" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Minimum price for discovery (search) results. Leave empty for no lower bound." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Maximum price for discovery (search) results. Leave empty for no upper bound." }, "minRating": { "title": "Minimum Rating", "enum": [ "any", "4", "3", "2", "1" ], "type": "string", "description": "Minimum star rating for discovery results. `4` is the live-validated 4+ stars filter; lower values are best effort.", "default": "any" }, "dealsOnly": { "title": "Deals Only", "type": "boolean", "description": "Apply Amazon's deals filter to keyword searches. Only affects discovery.", "default": false }, "primeOnly": { "title": "Prime Only", "type": "boolean", "description": "Apply Amazon's Prime filter to keyword searches. Prime eligibility itself is not emitted because the page does not expose a reliable per-item signal.", "default": false }, "condition": { "title": "Condition", "enum": [ "any", "new", "used", "renewed", "collectible" ], "type": "string", "description": "Item condition filter for keyword searches. `new` is live-validated; other values are best effort.", "default": "any" }, "brand": { "title": "Brand / Keyword Refinement", "type": "string", "description": "Optional brand word added to keyword search terms and used as a title/brand post-filter. This is not a structured Amazon brand-facet resolver.", "default": "" }, "stock": { "title": "Stock", "enum": [ "any", "inStock", "outOfStock" ], "type": "string", "description": "Best-effort stock filter applied after parsing. Records with unknown stock pass through.", "default": "any" }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price-asc", "price-desc", "review-rank", "newest" ], "type": "string", "description": "Sort order for keyword searches. Search-URL pass-through keeps its own sort.", "default": "relevance" }, "maxItems": { "title": "Max Discovery Items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of search/bestseller rows across all discovery inputs. Explicit product URLs/ASINs are always processed.", "default": 50 }, "maxPages": { "title": "Max Pages per Query", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum search-result pages to read per keyword or search URL (1-20).", "default": 3 }, "includeDetails": { "title": "Fetch Product Details", "type": "boolean", "description": "Fetch each discovery result's product page for full price, seller, variants, specs, reviews, and media fields. Disable for a cheaper search-card-only run.", "default": true }, "includeSponsored": { "title": "Include Sponsored Results", "type": "boolean", "description": "Keep sponsored search cards. The isSponsored flag is always preserved.", "default": true }, "includeVariants": { "title": "Include Variants", "type": "boolean", "description": "Include parent ASIN, child ASINs, and variant dimensions. Per-variant price and stock are not available from the product page.", "default": true }, "includeTopReviews": { "title": "Include Top Reviews", "type": "boolean", "description": "Include the inline top-review snippets Amazon renders publicly. Full review pagination is login-gated and is not supported.", "default": true }, "includeFailed": { "title": "Include Failure Rows", "type": "boolean", "description": "Emit an error row (recordType=error, reason, httpStatus) when a product or discovery input fails instead of silently dropping it.", "default": true }, "failOnEmpty": { "title": "Fail on Empty", "type": "boolean", "description": "Mark the run as FAILED when no product/search records are emitted.", "default": false }, "rateLimitDelay": { "title": "Delay Between Requests", "minimum": 0, "maximum": 10, "type": "integer", "description": "Base pause in seconds between product/search requests (0-10). A random value between this and twice this is used.", "default": 1 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional. The actor starts direct and escalates through Apify Proxy automatically only if Amazon blocks the request. No setup is required.", "default": { "useApifyProxy": true } }, "proxyCountry": { "title": "Proxy Country", "enum": [ "AUTO", "US", "GB", "DE", "FR", "ES", "IT", "CA", "AU", "JP", "IN", "BR", "MX", "NL", "SE", "PL", "TR", "AE", "SA", "SG", "BE", "EG" ], "type": "string", "description": "Optional proxy exit country. `AUTO` uses the marketplace's own country for every domain.", "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 } } } } } } } } } }