{ "openapi": "3.0.1", "info": { "title": "Amazon Price & Buy Box Scraper", "description": "Scrapes price, Buy Box winner, availability and the full offer list per ASIN across 18 Amazon marketplaces — with watchlist history, change detection and cross-marketplace checks. Errors never charged.", "version": "0.0", "x-build-id": "KM6ZvKVYfVCF57CVd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cyprusapi~amazon-price-buybox/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cyprusapi-amazon-price-buybox", "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-price-buybox/runs": { "post": { "operationId": "runs-sync-cyprusapi-amazon-price-buybox", "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-price-buybox/run-sync": { "post": { "operationId": "run-sync-cyprusapi-amazon-price-buybox", "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": { "asins": { "title": "ASINs", "type": "array", "description": "Plain ASINs (10 chars, e.g. B0CZ9LH53B) to check on 'marketplace'. Duplicates within one run are checked once — use includeHistory to also get past results for the same ASIN.", "items": { "type": "string" } }, "productUrls": { "title": "Amazon URLs", "type": "array", "description": "Product page URLs (/dp/… or /gp/product/…, marketplace auto-detected from the domain) — or search (/s?k=…) and category/chart URLs (/gp/bestsellers/…, /b?node=…) to collect ASINs from first. Multiple marketplaces per run are fine.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "de", "com", "co.uk", "fr", "it", "es", "ca", "com.au", "co.jp", "in", "nl", "se", "pl", "be", "mx", "br", "ae", "sa" ], "type": "string", "description": "Marketplace for the plain ASINs above. URLs always auto-detect their own marketplace.", "default": "com" }, "alsoCheckMarketplaces": { "title": "Also check on other marketplaces", "type": "array", "description": "Cross-marketplace price comparison: every resolved ASIN is additionally checked on each of these marketplaces (same ASIN, other domain). Valid codes: de, com, co.uk, fr, it, es, ca, com.au, co.jp, in, nl, se, pl, be, mx, br, ae, sa. Each marketplace check is one charged result.", "items": { "type": "string" } }, "maxAsinsPerListUrl": { "title": "Max ASINs per list URL", "minimum": 1, "maximum": 100, "type": "integer", "description": "Cap for ASINs collected from one search/category URL (each collected ASIN is then checked and charged like a direct one).", "default": 20 }, "includeAllOffers": { "title": "Include full offer list", "type": "boolean", "description": "Additionally fetch the 'All offers' page per ASIN and parse every offer (seller, seller ID, price, condition, shipping, delivery, ships-from, Prime). Powers lowestOffer and sellerCount. One extra page per ASIN.", "default": true }, "maxOffers": { "title": "Max offers per ASIN", "minimum": 1, "maximum": 100, "type": "integer", "description": "Upper bound of offers parsed per ASIN when 'Include full offer list' is on.", "default": 20 }, "monitorMode": { "title": "Monitor mode (change detection)", "type": "boolean", "description": "Compare every ASIN against its last stored snapshot in the watchlist: you get changeDetected, changes[] (price / Buy Box seller / stock / list price / coupon), priceDelta and a plain-English changeSummary. Pricing can charge 'unchanged' confirmations cheaper than real changes.", "default": false }, "watchlistId": { "title": "Watchlist ID", "type": "string", "description": "Name of the watchlist this run belongs to. All snapshots are stored per watchlist (key-value store 'price-history-'), so keep it stable across scheduled runs. Different watchlists never mix histories.", "default": "default" }, "includeHistory": { "title": "Include price history", "type": "boolean", "description": "Attach past stored snapshots of the same marketplace+ASIN (newest first, excluding the current check) to each result item. Every successful check is recorded automatically — also without monitor mode.", "default": false }, "historyLimit": { "title": "History limit", "minimum": 0, "maximum": 200, "type": "integer", "description": "How many past snapshots to attach per ASIN when 'Include price history' is on (0 = all stored, up to 200 kept per ASIN).", "default": 10 }, "requestDelayMs": { "title": "Delay between ASINs (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Extra pause between consecutive ASIN checks (on top of natural page-load pacing). Raise it if you see bot-detection errors.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Residential proxies are strongly recommended. Custom proxies can be added as proxyUrls (http://user:pass@host:port).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "proxiesByMarketplace": { "title": "Per-marketplace proxies", "type": "object", "description": "Optional: {\"de\": [\"http://user:pass@host:port\", …], \"co.uk\": […]}. Geo-pinned proxies per marketplace — exit-IP country should match the marketplace, otherwise Amazon serves wrong currencies or bot-gates. Proxy tier chain per task: this explicit pool FIRST; otherwise the bundled shared pool (we cover it); on blocked/transport the run falls back to Apify datacenter, then Apify residential. With useApifyProxy off and no pool at all: single direct attempt." } } }, "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 } } } } } } } } } }