{ "openapi": "3.0.1", "info": { "title": "E-commerce Location Scraper", "description": "Collect every store unit (location) for a restaurant chain from its store-locator URL.", "version": "0.0", "x-build-id": "sCfM0EKzNtrGmxzNc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/e-commerce~e-commerce-location-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-e-commerce-e-commerce-location-scraper", "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/e-commerce~e-commerce-location-scraper/runs": { "post": { "operationId": "runs-sync-e-commerce-e-commerce-location-scraper", "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/e-commerce~e-commerce-location-scraper/run-sync": { "post": { "operationId": "run-sync-e-commerce-e-commerce-location-scraper", "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": [ "locationsUrls" ], "properties": { "locationsUrls": { "title": "Restaurant chains", "uniqueItems": true, "type": "array", "description": "Select the restaurant chains to collect store locations for. The scraper returns every store unit of each selected chain with its address, city, state, ZIP, phone, and URL.", "items": { "type": "string", "enum": [ "https://www.subway.com", "https://www.tacobell.com", "https://www.dominos.com", "https://littlecaesars.com", "https://www.pizzahut.com", "https://www.bk.com", "https://www.wendys.com", "https://www.starbucks.com", "https://www.starbucks.ca", "https://www.popeyes.com", "https://www.popeyeschicken.ca", "https://www.mcdonalds.com", "https://www.dunkindonuts.com", "https://www.chipotle.com", "https://www.kfc.com", "https://www.dairyqueen.com", "https://www.chick-fil-a.com", "https://www.papajohns.com", "https://www.jerseymikes.com", "https://www.jimmyjohns.com", "https://www.wingstop.com", "https://www.pandaexpress.com", "https://www.baskinrobbins.com", "https://www.jackinthebox.com", "https://www.panerabread.com", "https://www.tropicalsmoothiecafe.com", "https://www.wafflehouse.com", "https://www.ihop.com", "https://www.applebees.com", "https://www.fiveguys.com", "https://www.hardees.com", "https://www.auntieannes.com", "https://www.smoothieking.com", "https://www.buffalowildwings.com", "https://www.dennys.com", "https://www.marcos.com", "https://www.firehousesubs.com", "https://www.chilis.com", "https://www.whataburger.com", "https://www.dutchbros.com", "https://www.culvers.com", "https://www.zaxbys.com", "https://www.papamurphys.com", "https://www.coldstonecreamery.com", "https://www.timhortons.com", "https://www.arbys.com", "https://www.krispykrunchy.com", "https://www.crumblcookies.com", "https://www.togos.com", "https://www.sonicdrivein.com", "https://www.huntbrotherspizza.com", "https://www.roundtablepizza.com", "https://www.longhornsteakhouse.com", "https://www.foxtailcoffee.com", "https://www.pizzapatron.com", "https://www.walk-ons.com", "https://www.manhattanbagel.com", "https://www.acburger.com", "https://www.jimnnicks.com", "https://www.mcmenamins.com", "https://www.theoriginalpizzaking.com", "https://www.dirtydoughcookies.com", "https://www.mogeteeusa.com", "https://www.chickenkitchen.com", "https://www.eastcoastwings.com", "https://www.gravitycoffee.com", "https://www.dontortaco.com", "https://www.tinroofbars.com" ], "enumTitles": [ "Subway", "Taco Bell", "Domino's", "Little Caesars", "Pizza Hut", "Burger King", "Wendy's", "Starbucks (US)", "Starbucks (Canada)", "Popeyes (US)", "Popeyes (Canada)", "McDonald's", "Dunkin'", "Chipotle", "KFC", "Dairy Queen", "Chick-fil-A", "Papa Johns", "Jersey Mike's", "Jimmy John's", "Wingstop", "Panda Express", "Baskin Robbins", "Jack in the Box", "Panera Bread", "Tropical Smoothie Cafe", "Waffle House", "IHOP", "Applebee's", "Five Guys", "Hardee's", "Auntie Anne's", "Smoothie King", "Buffalo Wild Wings", "Denny's", "Marco's Pizza", "Firehouse Subs", "Chili's", "Whataburger", "Dutch Bros Coffee", "Culver's", "Zaxby's", "Papa Murphy's", "Cold Stone Creamery", "Tim Hortons", "Arby's", "Krispy Krunchy Chicken", "Crumbl Cookies", "Togo's", "Sonic Drive-In", "Hunt Brothers Pizza", "Round Table Pizza", "Longhorn Steakhouse", "Foxtail Coffee Co", "Pizza Patron", "Walk-On's Sports Bistreaux", "Manhattan Bagel", "Arctic Circle", "Jim 'N Nick's Bar-B-Q", "McMenamins", "The Original Pizza King", "Dirty Dough", "Moge Tee", "Chicken Kitchen", "East Coast Wings + Grill", "Gravity Coffee", "Don Tortaco Mexican Grill", "The Tin Roof" ] }, "default": [ "https://www.subway.com" ] }, "maxLocationsPerChain": { "title": "Maximum locations per chain", "minimum": 1, "type": "integer", "description": "The maximum number of store locations to collect for each selected chain. Applied independently to every chain, not as a shared run total.", "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 } } } } } } } } } }