{
"openapi": "3.0.1",
"info": {
"title": "Canada Business Registry Scraper - Companies & Leads",
"description": "Search Canada's official business registries in one run - federal (Corporations Canada) plus Ontario, Quebec, BC, Alberta, Manitoba, Saskatchewan and Nova Scotia: legal name, status, business number, entity type, city and incorporation date. Official government API - no key, no browser.",
"version": "0.1",
"x-build-id": "FVIM1UD03RAn6i7Dd"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~canada-business-registry-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-canada-business-registry-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/scrapesage~canada-business-registry-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-canada-business-registry-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/scrapesage~canada-business-registry-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-canada-business-registry-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": {
"searchQueries": {
"title": "Search queries",
"type": "array",
"description": "Company names, keywords or business/corporation numbers to search across Canada's business registries, one per line - e.g. Shopify, plumbing, 847871746. Leave empty and the run returns a small free sample.",
"items": {
"type": "string"
}
},
"searchQueriesFromFile": {
"title": "Import search queries from a file",
"type": "string",
"description": "Bulk-load search queries. Either paste the whole list (one per line), or give a single link to a public .txt/.csv, a Google Sheet/Drive link, or an Apify key-value-store record. A file that cannot be read says so and charges nothing."
},
"registrySources": {
"title": "Only these registries",
"type": "array",
"description": "Keep only records from the selected registries. Leave empty for all eight participating registries.",
"items": {
"type": "string",
"enum": [
"CC",
"ON",
"QC",
"BC",
"AB",
"MB",
"SK",
"NS"
],
"enumTitles": [
"Corporations Canada - federal (CC)",
"Ontario (ON)",
"Quebec (QC)",
"British Columbia (BC)",
"Alberta (AB)",
"Manitoba (MB)",
"Saskatchewan (SK)",
"Nova Scotia (NS)"
]
}
},
"statuses": {
"title": "Only these statuses",
"type": "array",
"description": "Keep only companies in the selected registration status. Leave empty for both.",
"items": {
"type": "string",
"enum": [
"Active",
"Inactive"
],
"enumTitles": [
"Active (Active)",
"Inactive (Inactive)"
]
}
},
"maxItemsPerQuery": {
"title": "Max companies per query",
"minimum": 1,
"type": "integer",
"description": "How many companies to collect for each search query.",
"default": 100
},
"maxItems": {
"title": "Max companies (total)",
"minimum": 1,
"type": "integer",
"description": "Overall cap across all queries. You are only charged for companies actually saved.",
"default": 1000
},
"outputFields": {
"title": "Output fields (leave empty for all)",
"type": "array",
"description": "Pick the fields you want and every record is trimmed to exactly those - handy for lean CSV/Sheets exports.",
"items": {
"type": "string",
"enum": [
"type",
"name",
"alternateName",
"mrasId",
"registrySource",
"registryName",
"jurisdiction",
"businessNumber",
"registryEntityId",
"alternateId",
"entityType",
"mrasEntityType",
"status",
"statusDate",
"statusNotes",
"incorporationDate",
"city",
"province",
"country",
"homeJurisdictionName",
"homeJurisdictionRegistry",
"hierarchy",
"registryUrl",
"searchQuery",
"scrapedAt"
],
"enumTitles": [
"Record type (type)",
"Company name (name)",
"Alternate name (alternateName)",
"MRAS ID (mrasId)",
"Registry code (registrySource)",
"Registry name (registryName)",
"Jurisdiction (jurisdiction)",
"Business number (businessNumber)",
"Registry entity ID (registryEntityId)",
"Alternate ID (alternateId)",
"Entity type (entityType)",
"MRAS entity type (mrasEntityType)",
"Status (status)",
"Status date (statusDate)",
"Status notes (statusNotes)",
"Incorporation date (incorporationDate)",
"City (city)",
"Province (province)",
"Country (country)",
"Home jurisdiction name (homeJurisdictionName)",
"Home jurisdiction registry (homeJurisdictionRegistry)",
"Hierarchy (hierarchy)",
"Registry URL (registryUrl)",
"Search query (searchQuery)",
"Scraped at (scrapedAt)"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}