{
"openapi": "3.0.1",
"info": {
"title": "Amazon Deals Scraper",
"description": "Amazon Today's Deals and discounts: lightning deals with end time and % claimed, coupons, outlet and every category collection, on 22 marketplaces. Deal price, list price, % off, badge, deal type, optional product details, only-new mode. Export to JSON, CSV or Excel, or via API. No login.",
"version": "1.0",
"x-build-id": "gkT9WlsPQtOtJ0Thm"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~amazon-deals-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-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/steadyscrape~amazon-deals-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-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/steadyscrape~amazon-deals-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-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",
"properties": {
"collections": {
"title": "Deal pages or collections",
"type": "array",
"description": "One per line: a link to an Amazon deals page, copied from the address bar after picking a collection or filters on the site (https://www.amazon.com/deals?bubble-id=deals-collection-lightning-deals, https://www.amazon.co.uk/deals, a /gp/goldbox link), or a collection's name as the page labels it on the marketplace below (Lightning deals, Coupons, Outlet, Electronics, Kitchen…; lightning and coupons work on every marketplace). A link's domain picks its marketplace. Leave it empty for all of the marketplace's Today's Deals.",
"items": {
"type": "string"
}
},
"marketplace": {
"title": "Marketplace for collection names",
"enum": [
"com",
"ca",
"com.mx",
"com.br",
"co.uk",
"de",
"fr",
"it",
"es",
"nl",
"com.be",
"ie",
"se",
"pl",
"com.tr",
"co.jp",
"in",
"com.au",
"sg",
"ae",
"sa",
"eg"
],
"type": "string",
"description": "Where a collection given by name is read, and whose Today's Deals an empty list reads. amazon.in currently sends its deals page to its festival page; that page is read.",
"default": "com"
},
"maxDealsPerCollection": {
"title": "Max deals per collection",
"minimum": 1,
"maximum": 500,
"type": "integer",
"description": "How many deals to read from each collection, in Amazon's order. Amazon lists at most 500 per collection.",
"default": 100
},
"minDiscountPercent": {
"title": "Minimum discount (%)",
"minimum": 0,
"maximum": 99,
"type": "integer",
"description": "Only deals at least this much off, filtered by Amazon itself (the page's Discount filter). 0 keeps every deal.",
"default": 0
},
"fourStarsAndUp": {
"title": "4 stars & up only",
"type": "boolean",
"description": "Only products rated 4 stars and up (the page's Customer Reviews filter, applied by Amazon).",
"default": false
},
"includeDetails": {
"title": "Include product details",
"type": "boolean",
"description": "Also read each deal's product page: rating, review count, the product page price, availability, seller, ships from and Best Sellers Rank. Charged as a deal with details; a deal whose product page cannot be read is charged as a plain deal.",
"default": false
},
"onlyNewDeals": {
"title": "Only new deals",
"type": "boolean",
"description": "For scheduled runs: leave out (free) the deals an earlier run with the same collections and filters already delivered. A product that comes back as a new deal is delivered again. The memory lives in your account's key-value store steadyscrape-amazon-deals-state.",
"default": false
},
"residentialFallback": {
"title": "Fall back to residential proxies",
"type": "boolean",
"description": "When Amazon refuses the run's own IP and the datacenter proxies, retry through residential proxies of the marketplace's country (included in the price: you pay per deal, not per proxy byte). Off: those collections come back with status blocked, unpaid.",
"default": 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
},
"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
}
}
}
}
}
}
}
}
}
}