{
"openapi": "3.0.1",
"info": {
"title": "Yellow Pages Canada Scraper: Business Leads & Phones",
"description": "Scrape Yellow Pages Canada (yellowpages.ca) and PagesJaunes.ca business data by type and city or postal code: name, address, phone, website, rating, categories and coordinates; optionally each business page (hours, services, socials, fax). No login. Export to JSON, CSV or Excel, or via API.",
"version": "1.0",
"x-build-id": "EFvmsFsilU6FGXTDn"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/steadyscrape~canada-yellow-pages-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-steadyscrape-canada-yellow-pages-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/steadyscrape~canada-yellow-pages-scraper/runs": {
"post": {
"operationId": "runs-sync-steadyscrape-canada-yellow-pages-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/steadyscrape~canada-yellow-pages-scraper/run-sync": {
"post": {
"operationId": "run-sync-steadyscrape-canada-yellow-pages-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": "Business types or names",
"type": "array",
"description": "What to search, one per line, as you would type it on the site: Plumbers, Dentists, Restaurants, Real Estate Agents, Lawyers, Roofing Contractors, or a business name. Each term is searched in every place. Up to 50.",
"items": {
"type": "string"
}
},
"locations": {
"title": "Places",
"type": "array",
"description": "Where to search, one per line: a city with its province (Toronto ON, Montréal QC, Calgary AB, Gander NL), a neighbourhood (North York ON) or a postal code (M5V 2T6, results sorted by distance). Up to 200.",
"items": {
"type": "string"
}
},
"site": {
"title": "Language of the directory",
"enum": [
"yellowpages.ca",
"pagesjaunes.ca"
],
"type": "string",
"description": "Both sites list the same businesses; pagesjaunes.ca gives categories, descriptions and labels in French (the way Quebec businesses write them). Links below keep their own site.",
"default": "yellowpages.ca"
},
"startUrls": {
"title": "Yellow Pages links",
"type": "array",
"description": "Links copied from yellowpages.ca or pagesjaunes.ca, one per line: a results page (https://www.yellowpages.ca/search/si/1/Plumbers/Toronto+ON) is walked like a search from that page on; a business page (https://www.yellowpages.ca/bus/Ontario/Toronto/…/123456.html) is read on its own and charged as a business with details. Sorted or filtered results, review and map pages are closed to automated readers by the site's robots.txt and are free rows. Up to 5,000.",
"items": {
"type": "string"
}
},
"maxResultsPerSearch": {
"title": "Max businesses per search",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Stop each term in each place (and each results link) after this many businesses. Toronto lists about 1,800 plumbers, 35 a page. The run's spending limit is respected too.",
"default": 100
},
"includeDetails": {
"title": "Read each business page (business-with-details)",
"type": "boolean",
"description": "Also read every business's own Yellow Pages page: description, every category, all phone numbers with their labels (toll-free, fax), every website, Facebook / Instagram / LinkedIn / X / YouTube / TikTok profiles, opening hours per day, payment methods, products and services, brands, specialties, languages spoken and service areas. Charged as business-with-details instead of business.",
"default": 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
}
}
}
}
}
}
}
}
}
}