{ "openapi": "3.0.1", "info": { "title": "YellowPages.ca Scraper & API - Canada Business Leads, Phones", "description": "YellowPages.ca scraper and API: Canadian business leads by search term and city (plumber, Toronto ON) or yellowpages.ca URLs. One result = one business: name, phones, website, address, rating, hours, services, social links. No login, no start fee. $0.70 per 1,000, lowest paid YellowPages.ca price.", "version": "1.0", "x-build-id": "qQ5udEkE9GuFVD1qb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rel8ble~yellowpages-ca-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rel8ble-yellowpages-ca-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/rel8ble~yellowpages-ca-scraper/runs": { "post": { "operationId": "runs-sync-rel8ble-yellowpages-ca-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/rel8ble~yellowpages-ca-scraper/run-sync": { "post": { "operationId": "run-sync-rel8ble-yellowpages-ca-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", "type": "array", "description": "What to search: business types, categories or names in English or French, one per line, e.g. \"plumber\", \"dentist\", \"restaurants\", \"Electricians & Electrical Contractors\", \"avocat\". Every term is searched in every location below.", "items": { "type": "string" } }, "locations": { "title": "Locations", "type": "array", "description": "Where to search: Canadian cities as \"City PROVINCE\", one per line, e.g. \"Toronto ON\", \"Montreal QC\", \"Vancouver BC\", \"Calgary AB\". A postal code (e.g. \"M5V 2T6\") also works.", "items": { "type": "string" } }, "startUrls": { "title": "YellowPages.ca URLs", "type": "array", "description": "Optional. Search result pages (https://www.yellowpages.ca/search/si/1/plumber/Ottawa+ON) and/or single business pages (https://www.yellowpages.ca/bus/Ontario/Toronto//.html), one per line. Use these instead of, or on top of, search terms x locations.", "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max businesses per search term + location", "minimum": 0, "type": "integer", "description": "Optional. Businesses saved per search-location pair, integer >= 0. Default 100; 0 = every listing (up to 100 result pages, about 2,500 unique businesses). You pay per business, so start small.", "default": 100 }, "scrapeDetails": { "title": "Open each business page (hours, geo, social links, service areas)", "type": "boolean", "description": "Optional boolean. true (default) = also open every business page for full opening hours, coordinates, social links, international phone, specialties, service areas, languages, payment methods and the full description. false = result-list data only (name, phones, website, address, categories, services, rating): about 25x fewer requests. Same price either way.", "default": true }, "includeSponsored": { "title": "Include sponsored placements", "type": "boolean", "description": "Optional boolean. true (default) = keep the paid placements YellowPages shows at the top of each page (they are real businesses, flagged sponsored: true; duplicates are removed). false = organic results only.", "default": true }, "requireWebsite": { "title": "Only businesses with a website", "type": "boolean", "description": "Optional filter. Skip businesses without a website. Skipped businesses are not charged.", "default": false }, "requirePhone": { "title": "Only businesses with a phone number", "type": "boolean", "description": "Optional filter. Skip businesses without a phone number. Skipped businesses are not charged.", "default": false }, "minRating": { "title": "Min rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Optional filter, 0-5. Skip businesses rated below this (unrated businesses are skipped too). Skipped businesses are not charged." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional, advanced. Parallel requests, integer 1-20. Default 8. Leave unset.", "default": 8 }, "maxRequestRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional, advanced. Retries per failed or blocked request, integer 0-20; each retry uses a new session. Default 6.", "default": 6 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional, advanced. Leave as is. Default {\"useApifyProxy\": false} = automatic: direct connection first, and only requests that get blocked are retried through Apify Proxy (datacenter, then Canadian residential). Set your own Apify Proxy groups or proxy URLs to force them for every request.", "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }