{ "openapi": "3.0.1", "info": { "title": "Amazon Stock & Buy Box Alert", "description": "Watch the Amazon buy box and stock level on any list of ASINs. Returns who is winning the buy box, who it ships from, the offer count and the stock state for each product, and alerts you the moment the buy box changes hands, the item sells out, or it comes back in stock.", "version": "0.1", "x-build-id": "ifXLzRnGDQT3pvm1x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~amazon-buybox-alert/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-amazon-buybox-alert", "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/arched_friend~amazon-buybox-alert/runs": { "post": { "operationId": "runs-sync-arched_friend-amazon-buybox-alert", "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/arched_friend~amazon-buybox-alert/run-sync": { "post": { "operationId": "run-sync-arched_friend-amazon-buybox-alert", "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": [ "asins" ], "properties": { "asins": { "title": "ASINs or product URLs", "type": "array", "description": "The products to watch, one per line. A bare ASIN such as B0FGJF172R works, and so does any full Amazon product URL.", "items": { "type": "string" } }, "marketplace": { "title": "Marketplace", "enum": [ "US", "UK", "DE", "FR", "IT", "ES", "CA", "JP", "IN", "AU", "MX", "BR", "NL", "SE", "PL" ], "type": "string", "description": "Which Amazon site to read the buy box from. Use a country code such as US, UK or DE, or a full domain such as amazon.co.uk.", "default": "US" }, "onlyChanged": { "title": "Only what changed since last run", "type": "boolean", "description": "Return only buy box changes, stock flips and price moves. Turn this on for scheduled monitoring so each run is a short alert list.", "default": false }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Keep only products Amazon currently shows as available.", "default": false }, "onlyOutOfStock": { "title": "Only products out of stock", "type": "boolean", "description": "Keep only products that are currently unavailable. Useful for spotting a rival who has sold out.", "default": false }, "onlyLowStock": { "title": "Only low stock warnings", "type": "boolean", "description": "Keep only products where Amazon warns that just a few are left.", "default": false }, "onlyThirdPartyBuyBox": { "title": "Only third-party buy box", "type": "boolean", "description": "Keep only products where a third-party seller holds the buy box rather than Amazon.", "default": false }, "onlyAmazonBuyBox": { "title": "Only Amazon-owned buy box", "type": "boolean", "description": "Keep only products where Amazon itself holds the buy box.", "default": false }, "maxConcurrency": { "title": "Parallel product pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many product pages to load at once. Lower this if you see blocks on a large list.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Amazon blocks datacentre IPs, so this defaults to Apify residential proxy pinned to the marketplace country. Changing it away from residential will cause blocks.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }