{ "openapi": "3.0.1", "info": { "title": "Price Comparison Tool — Compare Store Prices", "description": "Compare product prices across supported stores with UPC/name matching, availability, shipping, seller, review, and best-price evidence.", "version": "1.0", "x-build-id": "bXnOOhX2Rb3DeSw7d" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~price-comparison/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-price-comparison", "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/junipr~price-comparison/runs": { "post": { "operationId": "runs-sync-junipr-price-comparison", "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/junipr~price-comparison/run-sync": { "post": { "operationId": "run-sync-junipr-price-comparison", "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": { "products": { "title": "Products", "type": "array", "description": "Products to compare. Each item can have a name, upc, or urls field. Max 100 products per run. Example: [{\"name\": \"AirPods Pro 2\"}, {\"upc\": \"194253397175\"}, {\"urls\": [\"https://www.amazon.com/dp/B0D1XD1ZV3\"]}]", "default": [ { "name": "AirPods Pro 2" } ] }, "stores": { "title": "Stores to Compare", "type": "array", "description": "Which stores to include in the price comparison. Valid values: amazon, walmart, target, bestbuy, homedepot", "items": { "type": "string" }, "default": [ "amazon", "walmart", "target", "bestbuy", "homedepot" ] }, "amazonDomain": { "title": "Amazon Domain", "type": "string", "description": "Amazon regional domain for pricing. Examples: amazon.com, amazon.co.uk, amazon.ca, amazon.de.", "default": "amazon.com" }, "includeThirdPartySellers": { "title": "Include Third-Party Sellers", "type": "boolean", "description": "Include third-party/marketplace seller prices in addition to direct retail prices.", "default": false }, "includeUsedCondition": { "title": "Include Used/Renewed Listings", "type": "boolean", "description": "Include used, renewed, or refurbished product listings.", "default": false }, "matchStrictness": { "title": "Match Strictness", "enum": [ "strict", "moderate", "loose" ], "type": "string", "description": "How strictly to match the same product across different stores. Strict = exact model match only. Moderate = same product, different packaging OK. Loose = similar products included.", "default": "moderate" }, "maxResultsPerStore": { "title": "Max Results Per Store", "minimum": 1, "maximum": 5, "type": "integer", "description": "Maximum product matches to return per store. Min: 1, Max: 5. Useful with loose matching to see multiple options.", "default": 1 }, "includeOutOfStock": { "title": "Include Out-of-Stock", "type": "boolean", "description": "Include products that are currently out of stock. Availability will be marked accordingly.", "default": true }, "includePriceHistory": { "title": "Include Price History", "type": "boolean", "description": "Attempt to include recent price history data where available.", "default": false }, "includeShippingDetails": { "title": "Include Shipping Details", "type": "boolean", "description": "Include shipping cost and estimated delivery information per store.", "default": true }, "includeReviews": { "title": "Include Reviews", "type": "boolean", "description": "Include product rating and review count per store.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxy is strongly recommended — Amazon, Walmart, and Target have anti-bot protection. Defaults to Apify residential proxy (requires paid Apify plan). Free-plan users can provide their own residential proxy URL.", "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 } } } } } } } } } }