{ "openapi": "3.0.1", "info": { "title": "Yellow Pages US Scraper - Business Listings & Phones", "description": "Search US Yellow Pages by trade and city or ZIP and get one row per business: name, phone, street address, city, state, ZIP, website, categories, years in business and the listing id. Ratings where Yellow Pages has them, roughly a third of listings. $0.60 per 1,000.", "version": "0.1", "x-build-id": "Bg1QAsOW11ZRJ35eP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dami_studio~yellow-pages-us-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dami_studio-yellow-pages-us-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/dami_studio~yellow-pages-us-scraper/runs": { "post": { "operationId": "runs-sync-dami_studio-yellow-pages-us-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/dami_studio~yellow-pages-us-scraper/run-sync": { "post": { "operationId": "run-sync-dami_studio-yellow-pages-us-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": { "searchTerms": { "title": "Search terms", "minItems": 0, "maxItems": 20, "type": "array", "description": "What to look for, the way you would type it into the directory's search box: a trade, a category or a business name. Examples: \"plumber\", \"dentist\", \"coffee shop\", \"personal injury lawyer\". Up to 20 per run.", "items": { "type": "string" } }, "locations": { "title": "US locations", "minItems": 0, "maxItems": 20, "type": "array", "description": "Where to look, as a US \"City, ST\" such as \"Austin, TX\" or a 5-digit ZIP code such as \"90210\". Every search term is run against every location, so 3 terms and 2 locations is 6 searches. Up to 20 per run, 30 searches per run in total.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum businesses", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Total rows to return across every search. The budget is shared evenly between the searches, so 6 searches and 300 rows gives you 50 of each. Results are paged 30 at a time. Keep it low while you are testing - you pay per business." }, "includeAds": { "title": "Include sponsored listings", "type": "boolean", "description": "Off by default, so you are only charged for the ordinary directory results. Turn it on to also get the sponsored placements at the top of the page; they are real local businesses and are marked with \"isAd\": true. A business that appears both as an ad and as an ordinary result is still only returned, and charged, once." }, "searchUrls": { "title": "Yellow Pages search URLs (optional)", "minItems": 0, "maxItems": 30, "type": "array", "description": "Instead of terms and locations, paste yellowpages.com search or category URLs directly - for example https://www.yellowpages.com/search?search_terms=plumber&geo_location_terms=Austin%2C+TX or https://www.yellowpages.com/austin-tx/plumber. Anything that is not a yellowpages.com URL is skipped with a free diagnostic row.", "items": { "type": "string" } }, "proxyUrls": { "title": "Your own proxy servers (optional)", "minItems": 0, "maxItems": 50, "type": "array", "description": "Leave this empty. By default the run rotates a large pool of addresses that cost you nothing per gigabyte. Fill it in only if you specifically want the traffic to leave through proxy servers you already pay for, in the form http://user:pass@host:port.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }