{ "openapi": "3.0.1", "info": { "title": "YellowPages Chain Locations Scraper", "description": "Build a store locator dataset for any US retail brand. Enter a name like Starbucks or AutoZone and get every YellowPages location with address, phone, GPS, categories, hours and ratings as structured JSON — ideal for site selection and competitor mapping. Pay only for the results you get.", "version": "1.0", "x-build-id": "8mPyER8Fekv22rVtc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axlymxp~yellowpages-chain-locations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axlymxp-yellowpages-chain-locations-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/axlymxp~yellowpages-chain-locations-scraper/runs": { "post": { "operationId": "runs-sync-axlymxp-yellowpages-chain-locations-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/axlymxp~yellowpages-chain-locations-scraper/run-sync": { "post": { "operationId": "run-sync-axlymxp-yellowpages-chain-locations-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", "properties": { "brands": { "title": "Brand names", "type": "array", "description": "Retail or franchise brand names to resolve to YellowPages chain IDs, e.g. Starbucks, Walgreens, AutoZone. Each brand is swept across all anchor locations.", "default": [ "Starbucks" ], "items": { "type": "string" } }, "chainIds": { "title": "Chain IDs", "type": "array", "description": "Known YellowPages chain IDs to scrape directly, skipping brand-name resolution. Starbucks is 100032.", "default": [], "items": { "type": "string" } }, "anchorLocations": { "title": "Anchor locations", "type": "array", "description": "US metro anchors used for the geo sweep. chain_search requires an anchor location; large radiuses overlap, and the actor deduplicates locations by ypid.", "default": [ "Seattle, WA", "San Francisco, CA", "Los Angeles, CA", "Phoenix, AZ", "Denver, CO", "Dallas, TX", "Houston, TX", "Chicago, IL", "Minneapolis, MN", "Atlanta, GA", "Miami, FL", "New York, NY", "Boston, MA" ], "items": { "type": "string" } }, "radiusMiles": { "title": "Radius in miles", "minimum": 1, "type": "integer", "description": "Radius override sent to YellowPages chain_search for each anchor. 500 miles was verified to expand Starbucks coverage substantially.", "default": 500 }, "maxLocationsPerBrand": { "title": "Max locations per brand", "minimum": 1, "type": "integer", "description": "Stop collecting a brand after this many unique, deduplicated locations.", "default": 2000 }, "maxItems": { "title": "Max locations total", "minimum": 1, "type": "integer", "description": "Global run cap across all brands and chain IDs.", "default": 5000 }, "includeDetails": { "title": "Include full location details", "type": "boolean", "description": "Fetch each location's detail endpoint to enrich rows with merchant website, email, expanded hours, services, payment methods and other profile fields. Off by default for high-volume chain runs.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The mobile YellowPages API does not require a proxy, so this can normally stay disabled.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }