{ "openapi": "3.0.1", "info": { "title": "Competitor Price Monitoring API - Matched SKU Prices, Stock", "description": "Competitor price monitoring for your matched SKUs: every store's price, regular price, previous price, savings, promotions, shipping and stock, per SKU lookups and on-demand live prices from the Wiser Price Intelligence API. Read only. Bring your own key.", "version": "0.1", "x-build-id": "QFpz86mHRhlTirrpu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~competitor-price-monitoring-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-competitor-price-monitoring-api", "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/nabeelbaghoor~competitor-price-monitoring-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-competitor-price-monitoring-api", "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/nabeelbaghoor~competitor-price-monitoring-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-competitor-price-monitoring-api", "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": { "service": { "title": "What to read", "enum": [ "bulkProducts", "productBySku", "livePrices" ], "type": "string", "description": "One service per run. All matched SKUs pages through every SKU in the catalog environment your key belongs to, with every competitor listing matched to it, and needs no identifiers, so it is the default. Competitor listings for a SKU reads the listings for each SKU code you give. Live competitor price asks the provider to fetch the current price of each competitor product id you give, from the product page itself, which is slower and cached by the provider for one hour.", "default": "bulkProducts" }, "identifiers": { "title": "SKUs or competitor product ids", "type": "array", "description": "One per line. For competitor listings for a SKU, your own SKU codes as they appear in your catalog. For live competitor price, the competitor product id, which is the productId column of any row this actor returns. All matched SKUs reads none.", "items": { "type": "string" } }, "crawlRecencyHours": { "title": "Crawled within the last hours", "minimum": 1, "type": "integer", "description": "All matched SKUs only. Return only competitor listings the provider crawled within this many hours, for example 24 for a daily feed. Left blank, every active listing is returned." }, "startPage": { "title": "Start page", "minimum": 1, "type": "integer", "description": "All matched SKUs only. The page to start from. Each page holds up to 1,000 of your SKUs with all their listings, and the actor keeps reading later pages until the last one or the maximum results." }, "matchType": { "title": "Match type", "enum": [ "any", "exact", "equivalent" ], "type": "string", "description": "All matched SKUs only, because only that route reports it. Exact keeps listings of the identical product; equivalent keeps comparable products the provider matched as equivalents. Applied by this actor to the provider's answer.", "default": "any" }, "storeNames": { "title": "Only these stores", "type": "array", "description": "Keep only listings from these stores, one store name per line, written as the provider names it in the storeName column. Case does not matter. Applied by this actor to the provider's answer; left empty, every store is kept.", "items": { "type": "string" } }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only listings the provider saw in stock. Applied by this actor to the provider's answer.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. One page of all matched SKUs can hold thousands of listings, so this is what bounds a run and its cost.", "default": 1000 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 200, "type": "integer", "description": "Pacing ceiling. The provider allows 200 requests per minute per key and also caps monthly usage per key, so the default sits at half the per-minute limit to leave room for anything else using the same key.", "default": 100 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own price intelligence API key, which your account manager issues per catalog environment. This actor is bring-your-own-key and never ships a key of its own. Leave blank to use the DATA_API_KEY environment secret instead. The provider documents the key as a query parameter only, so that is how it travels, and no request URL is ever logged or stored." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 } } } } } } } } } }