{ "openapi": "3.0.1", "info": { "title": "Retail Chain Locations & Openings Tracker", "description": "Get every store location for any retail, restaurant or service chain — straight from its own public store locator. Run on a schedule to track store openings & closings. Pay-per-result, no enterprise contract.", "version": "0.0", "x-build-id": "Xg1PDKjztNFDnyfNn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/monteva~retail-chain-locations-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-monteva-retail-chain-locations-tracker", "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/monteva~retail-chain-locations-tracker/runs": { "post": { "operationId": "runs-sync-monteva-retail-chain-locations-tracker", "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/monteva~retail-chain-locations-tracker/run-sync": { "post": { "operationId": "run-sync-monteva-retail-chain-locations-tracker", "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": [ "targets" ], "properties": { "targets": { "title": "Chain websites or store-locator URLs", "type": "array", "description": "One or more retail/restaurant/service chain websites (e.g. `examplechain.com`) or direct store-locator URLs (e.g. `https://www.examplechain.com/store-locator`). The Actor auto-detects the locator backend (Storemapper, Stockist, Uberall, Locally, embedded JSON, JSON-LD, sitemap location pages).", "items": { "type": "string" } }, "changeTracking": { "title": "Track openings & closings", "type": "boolean", "description": "Compare each run against the previous snapshot of the same chain and tag every location as `initial`, `added`, `removed` or `unchanged`. Run this Actor on a schedule (e.g. weekly) to get a continuous openings/closings feed per chain.", "default": true }, "pushUnchanged": { "title": "Include unchanged locations in output", "type": "boolean", "description": "If disabled, repeat runs only output `added` and `removed` locations (pure monitoring mode — fewer results, lower cost). The first run always outputs the full list.", "default": true }, "maxLocationsPerBrand": { "title": "Max locations per chain (test limit)", "minimum": 0, "type": "integer", "description": "Limit the number of locations extracted per chain (0 = no limit). Prefilled with a small value for a cheap first test run. Set to 0 for the full list and to enable change tracking. While a test limit is active, no snapshot is saved, so change tracking stays accurate.", "default": 0 }, "maxDetailPages": { "title": "Max sitemap pages per chain", "minimum": 0, "type": "integer", "description": "Upper bound for individual location pages fetched in the sitemap fallback (used for chains without an open locator API, e.g. Yext-powered sites). Set 0 to disable the sitemap fallback.", "default": 300 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the key-value store that holds per-chain snapshots for change tracking. Use different names to keep separate tracking universes (e.g. per client).", "default": "retail-chain-locations-state" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy used for fetching. On by default (Apify Proxy) — most store locators sit behind CDNs/bot-protection that reject bare datacenter IPs. For heavily protected chains, switch to the RESIDENTIAL group here. To disable, set useApifyProxy to false.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }