{ "openapi": "3.0.1", "info": { "title": "Amazon Deals Scraper", "description": "Scrape Amazon's Today's Deals grid (/deals) - discounted products with deal price, list price, savings amount/percent, deal type, brand and department IDs. Filter by category, brand, rating, price range and discount range across 20+ Amazon marketplaces.", "version": "1.0", "x-build-id": "ZCGpc1CkgHrdOUCKd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~amazon-deals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-amazon-deals-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/crawlerbros~amazon-deals-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-amazon-deals-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/crawlerbros~amazon-deals-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-amazon-deals-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": [ "marketplace" ], "properties": { "marketplace": { "title": "Amazon 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.eg", "amazon.ie", "amazon.com.be", "amazon.co.za" ], "type": "string", "description": "Which Amazon domain's Today's Deals page to scrape.", "default": "amazon.com" }, "dealType": { "title": "Deal type", "enum": [ "", "deals-collection-lightning-deals", "deals-collection-coupons", "us-outlet", "deals-collection-cml", "Lowest Price in 365 Days", "discounts-collection-for-you", "Premium", "SummerFavorites", "beauty", "fashion", "home", "toys-games", "electronics", "Devices", "kitchen", "everyday-essentials", "deals-collection-amazon-brands", "computer-accessories", "pet-supplies", "furniture", "tvs-accessories", "home-diy", "sport-outdoors", "grocery", "personal-care", "cell-phones-accessories", "small-business", "video-games", "lawn-garden", "automotive", "camera-photo", "books", "jewelry", "baby", "office-supplies", "musical-instruments", "deals-collection-refurbished" ], "type": "string", "description": "Only emit deals belonging to this collection bubble (the real filter chips Amazon shows atop the Deals page). Department-scoped bubbles (e.g. Customers' Most-Loved) are enforced by matching each deal's department IDs; tag-scoped bubbles (Lightning Deals, Coupons, Outlet) can't be verified per-deal from the grid data and pass through unfiltered. `(any deal type)` applies no filter.", "default": "" }, "category": { "title": "Category / department", "type": "string", "description": "Free-text filter matched against each deal's department/category name (case-insensitive substring, e.g. `Electronics`, `Home`, `Toys`). Leave empty for all categories.", "default": "" }, "brand": { "title": "Brand", "type": "string", "description": "Free-text filter matched against each deal's brand name (case-insensitive substring, e.g. `Anker`, `Samsung`). Leave empty for all brands.", "default": "" }, "minRating": { "title": "Minimum star rating (1-5)", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only emit deals with a star rating at or above this value. Deals without a visible rating pass through unless this is set." }, "priceMin": { "title": "Min deal price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop deals priced below this amount (in the marketplace's local currency)." }, "priceMax": { "title": "Max deal price", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop deals priced above this amount (in the marketplace's local currency)." }, "discountMin": { "title": "Min discount %", "minimum": 0, "maximum": 100, "type": "integer", "description": "Drop deals with a savings percentage below this value." }, "discountMax": { "title": "Max discount %", "minimum": 0, "maximum": 100, "type": "integer", "description": "Drop deals with a savings percentage above this value." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted deal records.", "default": 30 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard cap on how many grid pages (up to 30 items each) to walk (each page is a fresh in-browser fetch of the widget's own pagination request).", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy used to fetch the Deals page. AUTO (datacenter) is used by default; the actor escalates to residential automatically only after repeated block detections within a run.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }