{ "openapi": "3.0.1", "info": { "title": "Amazon Product Intelligence", "description": "Amazon Product Intelligence gets the job done with reliable prices, stock, ratings, rankings, variants, offers, sellers, and monitoring at a great price. Choose only the data you need so you won't pay for extra features. If anything isn’t right, the developer is ready to help immediately.", "version": "0.0", "x-build-id": "56pYv7j0GKy24U4yp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sincere_developer~amazon-product-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sincere_developer-amazon-product-intelligence", "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/sincere_developer~amazon-product-intelligence/runs": { "post": { "operationId": "runs-sync-sincere_developer-amazon-product-intelligence", "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/sincere_developer~amazon-product-intelligence/run-sync": { "post": { "operationId": "run-sync-sincere_developer-amazon-product-intelligence", "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": { "mode": { "title": "Mode", "enum": [ "fast", "detail", "intelligence", "monitor" ], "type": "string", "description": "fast = economical listing-card data; direct ASINs and product URLs are resolved through an exact-ASIN Amazon search without opening the product page. detail = product page. intelligence = detail plus selected competitive blocks. monitor = compare current product state with a previous dataset.", "default": "detail" }, "dataProfile": { "title": "Data profile", "enum": [ "essential", "catalog", "competitive", "custom" ], "type": "string", "description": "Choose the result depth and base billing event. Essential returns price, availability and ratings with product-essential billing. Catalog adds BSR, Buy Box, variants, content and media with product-detail billing. Competitive also enables offers and seller profiles, which use their own events. Custom lets you choose individual blocks." }, "dataBlocks": { "title": "Custom data blocks", "uniqueItems": true, "type": "array", "description": "Used when Data profile is Custom. Identity, source, location and quality metadata are always returned. Offers and seller profiles have separate per-result billing events.", "items": { "type": "string", "enum": [ "pricing", "availability", "ratings", "rankings", "buyBox", "variants", "product", "media", "offers", "sellerProfiles" ], "enumTitles": [ "Pricing", "Availability", "Ratings", "Rankings / BSR", "Buy Box", "Variants", "Product content", "Media", "Offers", "Seller profiles" ] }, "default": [] }, "marketplace": { "title": "Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA" ], "type": "string", "description": "Which Amazon marketplace to use. Product URLs from a different marketplace are respected and reported per record.", "default": "US" }, "asins": { "title": "ASINs", "type": "array", "description": "One or more 10-character ASINs, e.g. B0CX23V2ZK. Invalid entries are returned as INVALID_INPUT rows rather than dropped.", "items": { "type": "string" } }, "urls": { "title": "Amazon URLs", "type": "array", "description": "Product, search, category, best-seller, storefront or seller URLs.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "keywords": { "title": "Keywords", "type": "array", "description": "Search keywords. Each keyword is crawled up to 'Max search pages'.", "default": [], "items": { "type": "string" } }, "discoveryFilters": { "title": "Search discovery filters", "type": "object", "description": "Filter keyword, category, best-seller and storefront cards before detail pages are queued or billed. Direct ASIN and product URL inputs bypass these filters. When a requested signal is missing from a card, the card is excluded rather than guessed.", "properties": { "minPrice": { "title": "Minimum price", "description": "Exclude discovery cards whose displayed price is below this amount.", "type": "number", "minimum": 0 }, "maxPrice": { "title": "Maximum price", "description": "Exclude discovery cards whose displayed price is above this amount.", "type": "number", "minimum": 0 }, "minRating": { "title": "Minimum rating", "description": "Require at least this displayed star rating on the discovery card.", "type": "number", "minimum": 0, "maximum": 5 }, "minReviewCount": { "title": "Minimum review count", "description": "Require at least this many displayed reviews on the discovery card.", "type": "integer", "minimum": 0 }, "primeOnly": { "title": "Prime only", "description": "Keep only discovery cards that display an Amazon Prime signal.", "type": "boolean", "default": false }, "sponsoredPolicy": { "title": "Sponsored results", "description": "Include all results, exclude sponsored cards, or keep only sponsored cards.", "type": "string", "enum": [ "include", "exclude", "only" ], "default": "include" }, "minBoughtInPastMonth": { "title": "Minimum bought in past month", "description": "Require the discovery card to report at least this recent purchase count.", "type": "integer", "minimum": 0 }, "minDiscountPercent": { "title": "Minimum discount percent", "description": "Require at least this displayed discount percentage on the discovery card.", "type": "number", "minimum": 0, "maximum": 100 } }, "default": {}, "additionalProperties": false }, "items": { "title": "Raw JSON items", "type": "array", "description": "Advanced bulk input. Each object contains exactly one of asin, url or keyword. Optional per-row marketplace is supported for ASINs and keywords.", "items": { "type": "object", "properties": { "asin": { "title": "ASIN", "description": "Ten-character Amazon product identifier.", "type": "string" }, "url": { "title": "Amazon URL", "description": "Product or discovery URL.", "type": "string" }, "keyword": { "title": "Keyword", "description": "Amazon search phrase.", "type": "string" }, "marketplace": { "title": "Marketplace", "description": "Optional marketplace override for this row.", "type": "string", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA" ] } }, "additionalProperties": false }, "default": [] }, "datasetId": { "title": "Input dataset ID", "type": "string", "description": "Read inputs from an existing Apify dataset instead of pasting them." }, "datasetField": { "title": "Input dataset field", "type": "string", "description": "Which field of the input dataset holds the ASIN or URL.", "default": "asin" }, "deliveryCountry": { "title": "Delivery country", "type": "string", "description": "Optional delivery context. Amazon shows different prices and delivery promises by location." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Optional postal code, e.g. 10001. Applied once per session and verified from the page. Every record reports whether it was applied." }, "requireLocation": { "title": "Require the location to be applied", "type": "boolean", "description": "When on, a product whose delivery location could not be applied is returned as REQUIRES_LOCATION instead of a success with an unlocalized price. Recommended for price tracking.", "default": false }, "variantMode": { "title": "Variant mode", "enum": [ "none", "discover", "price", "full" ], "type": "string", "description": "none = skip. discover = child ASINs and option matrix at no extra request cost (default). price = also fetch each child's current price and stock. full = full detail per child.", "default": "discover" }, "includeOffers": { "title": "Include all offers", "type": "boolean", "description": "Fetch the bounded All Offers surface for each product. Adds requests and offer billing events.", "default": false }, "maxOffersPerProduct": { "title": "Max offers per product", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard limit on offers retained and billed for each product.", "default": 10 }, "includeSellerDetails": { "title": "Include public seller details", "type": "boolean", "description": "Fetch public seller profile, feedback and business fields for discovered sellers. No private identity inference.", "default": false }, "maxProducts": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Hard ceiling on products processed in this run.", "default": 1000 }, "maxSearchPages": { "title": "Max search pages per keyword", "minimum": 1, "maximum": 20, "type": "integer", "description": "Hard pagination limit for each keyword, category, best-seller or storefront discovery input.", "default": 5 }, "maxVariants": { "title": "Max variants per parent", "minimum": 1, "type": "integer", "description": "Ceiling on deep child fetches. Discovery is unaffected.", "default": 50 }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum bounded retry count before a fetch is reported as failed or blocked.", "default": 3 }, "deduplicate": { "title": "Deduplicate results", "type": "boolean", "description": "Deduplicate on marketplace + ASIN + resolved delivery location. Discovery sources are merged into discoveredFrom rather than emitted twice.", "default": true }, "allowResidentialFallback": { "title": "Use residential reliability for full product modes", "type": "boolean", "description": "Detail, Intelligence and Monitor modes use marketplace-pinned residential proxies by default for reliable localized results. Turn this off to try the cheaper automatic tier and accept a higher block rate.", "default": true }, "fastResidentialFallback": { "title": "Allow residential fallback in Fast mode", "type": "boolean", "description": "Off by default to protect the economy price. When enabled, a blocked Fast request may use a residential proxy on its single retry, improving recovery while increasing platform cost.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Amazon requires proxies. High-volume users can supply their own external proxy URLs here, which keeps that traffic off the platform bill entirely.", "default": { "useApifyProxy": true } }, "schemaVersion": { "title": "Expected schema version", "type": "string", "description": "Echo of the output schema your integration expects. A mismatch produces a run warning, never a failure.", "default": "1.5" }, "compareWithDatasetId": { "title": "Previous dataset ID", "type": "string", "description": "Prior Amazon Product Intelligence dataset used for field-level monitoring changes. Required in monitor mode." } } }, "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 } } } } } } } } } }