{ "openapi": "3.0.1", "info": { "title": "Ecommerce Price Scraper 1", "version": "0.0", "x-build-id": "3pYgjCmyAXKpd3Z9v" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fipper_ai~Ecommerce-Price-Scraper-1/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fipper_ai-Ecommerce-Price-Scraper-1", "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/fipper_ai~Ecommerce-Price-Scraper-1/runs": { "post": { "operationId": "runs-sync-fipper_ai-Ecommerce-Price-Scraper-1", "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/fipper_ai~Ecommerce-Price-Scraper-1/run-sync": { "post": { "operationId": "run-sync-fipper_ai-Ecommerce-Price-Scraper-1", "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": [ "start_urls" ], "properties": { "start_urls": { "title": "Store or category URLs", "type": "array", "description": "Store home pages, collection pages, category pages, or direct product URLs.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Store, category, collection, or product page URL to start crawling from.", "editor": "textfield", "pattern": "^https?://.+" } }, "required": [ "url" ], "additionalProperties": false } }, "max_pages": { "title": "Max pages", "minimum": 1, "type": "integer", "description": "Hard limit for pages visited.", "default": 500 }, "max_products": { "title": "Max products", "minimum": 1, "type": "integer", "description": "Hard limit for product records saved.", "default": 250 }, "max_depth": { "title": "Max crawl depth", "minimum": 0, "type": "integer", "description": "How many link levels to follow from each start URL.", "default": 4 }, "same_domain_only": { "title": "Same domain only", "type": "boolean", "description": "Only follow links on the same domain as the start URLs.", "default": true }, "product_url_patterns": { "title": "Product URL patterns", "type": "array", "description": "URL fragments that usually identify product pages.", "items": { "type": "string" }, "default": [ "/products/", "/product/", "/p/", "/item/", "/dp/" ] }, "include_patterns": { "title": "Include URL patterns", "type": "array", "description": "Optional regex patterns URLs must match.", "items": { "type": "string" }, "default": [] }, "exclude_patterns": { "title": "Exclude URL patterns", "type": "array", "description": "Regex patterns to skip.", "items": { "type": "string" }, "default": [ "/cart", "/checkout", "/account", "/login", "/logout", "/search", "sort=", "filter=" ] }, "price_selectors": { "title": "Price selectors", "type": "array", "description": "Optional CSS selectors for price text.", "items": { "type": "string" }, "default": [ "[itemprop='price']", ".price", ".product-price", "[class*='price']" ] }, "title_selectors": { "title": "Title selectors", "type": "array", "description": "Optional CSS selectors for product title.", "items": { "type": "string" }, "default": [ "h1", "[itemprop='name']", ".product-title" ] }, "capture_screenshots": { "title": "Capture screenshots", "type": "boolean", "description": "Save product page screenshots to the key-value store.", "default": true }, "detect_changes": { "title": "Detect changes", "type": "boolean", "description": "Compare price, availability, and content hash with the previous run.", "default": true }, "snapshot_store_name": { "title": "Snapshot store name", "type": "string", "description": "Key-value store used to remember previous product state.", "default": "commerce-price-monitor-snapshots" }, "wait_ms": { "title": "Wait after load", "minimum": 0, "type": "integer", "description": "Extra wait before extracting product data.", "default": 1000 } } }, "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 } } } } } } } } } }