{ "openapi": "3.0.1", "info": { "title": "Amazon Product Finder - ASIN Search by Filters", "description": "Find Amazon products by criteria instead of by ASIN. Filter on price, sales rank, rating, reviews, category, brand and dozens more - including historical values. Returns up to 10,000 matching ASINs per run. Errors are never charged.", "version": "0.1", "x-build-id": "HwGOQc9bwQpnamYpu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cyprusapi~amazon-product-finder/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cyprusapi-amazon-product-finder", "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/cyprusapi~amazon-product-finder/runs": { "post": { "operationId": "runs-sync-cyprusapi-amazon-product-finder", "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/cyprusapi~amazon-product-finder/run-sync": { "post": { "operationId": "run-sync-cyprusapi-amazon-product-finder", "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": { "marketplace": { "title": "Marketplace", "enum": [ "com", "co.uk", "de", "fr", "it", "es", "nl", "ca", "com.mx", "com.br", "com.au", "co.jp", "in" ], "type": "string", "description": "Which Amazon marketplace to search. Prices below are interpreted in this marketplace's currency.", "default": "com" }, "maxItems": { "title": "Maximum ASINs", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many matching ASINs this run may return, at most 10,000. Billing is one charge per ASIN delivered. Note that a page never holds fewer than 50 rows upstream, so a very small cap saves time but not much money.", "default": 10 }, "titleQuery": { "title": "Title keywords", "type": "string", "description": "Space-separated keywords the product title must contain, up to 50. Whole words only - no partial matches. Put a phrase in double quotes (\"digital camera\"), and prefix a word with a minus to exclude it (-refurbished)." }, "brands": { "title": "Brands", "type": "array", "description": "Match any of these brands, case-insensitive. Up to 50 entries.", "default": [], "items": { "type": "string" } }, "manufacturers": { "title": "Manufacturers", "type": "array", "description": "Match any of these manufacturers, case-insensitive. Up to 50 entries.", "default": [], "items": { "type": "string" } }, "rootCategories": { "title": "Root category IDs", "type": "array", "description": "Only products inside these Amazon root categories (browse node IDs), for example 172282 for Electronics on amazon.com. Up to 50 entries.", "default": [], "items": { "type": "string" } }, "categoriesInclude": { "title": "Include category IDs", "type": "array", "description": "Only products listed directly in these sub-categories (browse node IDs). Up to 50 entries.", "default": [], "items": { "type": "string" } }, "categoriesExclude": { "title": "Exclude category IDs", "type": "array", "description": "Drop products listed directly in these sub-categories (browse node IDs). Up to 50 entries.", "default": [], "items": { "type": "string" } }, "priceType": { "title": "Which price to filter on", "enum": [ "buyBox", "new", "amazon", "used", "newFba", "listPrice" ], "type": "string", "description": "The price series that the minimum and maximum price below apply to. Buy Box is the price a customer actually pays; New is the lowest new offer; Amazon is Amazon's own offer.", "default": "buyBox" }, "minPrice": { "title": "Minimum price", "pattern": "^\\d+(\\.\\d{1,2})?$", "type": "string", "description": "Lowest acceptable current price, in the marketplace's currency (for example 25 for $25.00). Leave empty for no lower bound. Lowest price to include, e.g. \"24.99\". Decimals are allowed - enter the price as shown on Amazon, in the marketplace currency." }, "maxPrice": { "title": "Maximum price", "pattern": "^\\d+(\\.\\d{1,2})?$", "type": "string", "description": "Highest acceptable current price, in the marketplace's currency. Leave empty for no upper bound. Highest price to include, e.g. \"199.00\". Decimals are allowed - enter the price as shown on Amazon, in the marketplace currency." }, "minSalesRank": { "title": "Minimum sales rank", "minimum": 0, "type": "integer", "description": "Lower bound on the current sales rank. A higher rank number means a slower seller, so use this to exclude the very top of a category." }, "maxSalesRank": { "title": "Maximum sales rank", "minimum": 0, "type": "integer", "description": "Upper bound on the current sales rank, for example 50000 to keep only reasonably fast sellers." }, "minRating": { "title": "Minimum rating (stars)", "pattern": "^\\d+(\\.\\d{1,2})?$", "type": "string", "description": "Lowest acceptable star rating, from 0 to 5. Products without a rating are excluded once this is set. Star rating from 1 to 5, decimals allowed, e.g. \"4.3\"." }, "maxRating": { "title": "Maximum rating (stars)", "pattern": "^\\d+(\\.\\d{1,2})?$", "type": "string", "description": "Highest acceptable star rating, from 0 to 5. Useful for finding weak listings in a strong category. Star rating from 1 to 5, decimals allowed, e.g. \"4.3\"." }, "minReviewCount": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Lowest acceptable number of reviews." }, "maxReviewCount": { "title": "Maximum review count", "minimum": 0, "type": "integer", "description": "Highest acceptable number of reviews, for example 50 to find niches that are not yet crowded." }, "minMonthlySold": { "title": "Minimum units sold last month", "minimum": 0, "type": "integer", "description": "Lower bound on Amazon's \"bought in past month\" figure. Amazon publishes it for a minority of products only, so this filter also excludes everything without the figure." }, "maxMonthlySold": { "title": "Maximum units sold last month", "minimum": 0, "type": "integer", "description": "Upper bound on Amazon's \"bought in past month\" figure." }, "minOfferCountNew": { "title": "Minimum number of new offers", "minimum": 0, "type": "integer", "description": "Lower bound on how many new marketplace offers the product currently has." }, "maxOfferCountNew": { "title": "Maximum number of new offers", "minimum": 0, "type": "integer", "description": "Upper bound on how many new marketplace offers the product currently has, for example 3 to find products with little competition." }, "productType": { "title": "Product type", "enum": [ "any", "standard", "downloadable", "ebook", "variationParent" ], "type": "string", "description": "Restrict to one kind of catalogue entry. Variation parents carry only a sales rank and their child variations.", "default": "any" }, "availability": { "title": "Amazon availability", "type": "array", "description": "Keep only products whose Amazon offer is in one of these states. Leave empty to accept any state.", "items": { "type": "string", "enum": [ "noAmazonOffer", "inStock", "preorder", "unknown", "backorder", "delayed" ], "enumTitles": [ "No Amazon offer", "In stock", "Pre-order", "Unknown", "Back-order", "Shipping delayed" ] }, "default": [] }, "onlyWithReviews": { "title": "Only products that have reviews", "type": "boolean", "description": "Drop products without a single review.", "default": false }, "onlyBuyBoxByAmazon": { "title": "Only products where Amazon holds the Buy Box", "type": "boolean", "description": "Keep only products whose Buy Box is currently won by Amazon itself.", "default": false }, "excludeAdultProducts": { "title": "Exclude adult products", "type": "boolean", "description": "Drop everything flagged as an adult product.", "default": false }, "sortBy": { "title": "Sort results by", "enum": [ "salesRank", "price", "rating", "reviewCount", "monthlySold", "salesRankDrops30", "salesRankDrops90", "trackingSince", "lastPriceChange" ], "type": "string", "description": "Which field orders the result set. The default is the current sales rank, ascending - best sellers first.", "default": "salesRank" }, "sortOrder": { "title": "Sort direction", "enum": [ "asc", "desc" ], "type": "string", "description": "Ascending starts with the smallest value, which for sales rank means the best sellers.", "default": "asc" }, "advancedFilters": { "title": "Advanced filters (raw JSON)", "type": "object", "description": "Anything the fields above do not cover, merged into the query as-is. Keys follow the pattern __, for example {\"deltaPercent90_BUY_BOX_SHIPPING_gte\": 20, \"isLowest90_NEW\": true, \"outOfStockPercentage90_lte\": 5}. Prices here are integers in the smallest currency unit (cents), and dates are in the upstream minute format - the fields above do that conversion for you, this one does not. A key set here overrides the matching field above. \"page\" and \"perPage\" are ignored: paging is driven by \"Maximum ASINs\". See the README for the full grammar.", "default": {} }, "includeSearchInsights": { "title": "Include search insights", "type": "boolean", "description": "Adds aggregate statistics over the entire match set - average Buy Box price, average rating, share sold by Amazon, top brands and sellers - stored as SEARCH_INSIGHTS in the key-value store. Charged as a separate event, only when the statistics are actually returned.", "default": false }, "maxWaitSeconds": { "title": "Maximum wait for capacity (seconds)", "minimum": 0, "maximum": 900, "type": "integer", "description": "If the shared data capacity is momentarily used up, wait up to this long for it to refill. Anything still unserved afterwards is reported as currently unavailable - and never charged.", "default": 60 }, "apiKey": { "title": "Your own data provider key (optional)", "type": "string", "description": "Advanced: run this Actor against your own upstream account instead of the bundled capacity. Leave empty to use the included capacity." } } }, "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 } } }, "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 } } } } } } } } } }