{ "openapi": "3.0.1", "info": { "title": "Store Locator Scraper with Change Detection", "description": "Store locator scraper: every store location of a brand with address, coordinates and hours, plus store openings, closures, moves and hours changes on repeat runs.", "version": "0.1", "x-build-id": "mYMRv1vkZAFsfj4YZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/finaldynamics~store-locator-scraper-change-detection/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-finaldynamics-store-locator-scraper-change-detection", "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/finaldynamics~store-locator-scraper-change-detection/runs": { "post": { "operationId": "runs-sync-finaldynamics-store-locator-scraper-change-detection", "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/finaldynamics~store-locator-scraper-change-detection/run-sync": { "post": { "operationId": "run-sync-finaldynamics-store-locator-scraper-change-detection", "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": [ "locatorUrls" ], "properties": { "locatorUrls": { "title": "Locator page URLs", "type": "array", "description": "The brand's store locator page, for example https://www.brand.com/stores. The actor recognises the locator platform and reads the same location list the page shows.", "items": { "type": "string" } }, "country": { "title": "Country filter", "type": "string", "description": "Optional ISO 3166-1 alpha-2 code. When set, only locations in that country are kept (applied before the diff)." }, "maxLocations": { "title": "Max locations", "type": "integer", "description": "Cap on how many locations to scrape this run. 0 means no cap. Closure reporting is disabled whenever a cap is used because the crawl is incomplete.", "default": 0 }, "includeHours": { "title": "Include hours", "type": "boolean", "description": "Add opening hours to each row, one field per weekday (mon to sun). Turn off to leave hours empty.", "default": true }, "diffAgainstDatasetId": { "title": "Previous dataset id", "type": "string", "description": "The dataset from an earlier complete run, to compare against. Each location is then marked new, closed, moved, hours_changed or unchanged." }, "emitUnchanged": { "title": "Emit unchanged rows", "type": "boolean", "description": "Also deliver locations that did not change, so this run's dataset is a complete list you can compare against next time. Turn off only for a changes-only export you will not compare against later.", "default": true }, "monitorStateStoreId": { "title": "Recurring monitor state store ID", "type": "string", "description": "Optional key-value store where the actor keeps the full location list between scheduled runs, so each run reports openings, closures, moves and hours changes without you passing a dataset ID. Use one store per brand schedule and let runs finish one at a time." }, "monitorMaxLocations": { "title": "Monitor location safety limit", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum active locations staged in a recurring monitor run. Oversized or incomplete runs emit no rows and no per-row charges.", "default": 10000 } } }, "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 } } } } } } } } } }