{ "openapi": "3.0.1", "info": { "title": "Statistics Canada Housing Market Data Scraper", "description": "Scrape official Statistics Canada housing data: new housing price index, CMHC housing starts/completions, average rents, vacancy rates, condo price index, building permits, mortgage rate, and unsold new-home inventory - by city/CMA. Free government data, no login required.", "version": "1.0", "x-build-id": "Ic3ezfbPJNc9L2EzX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~statistics-canada-housing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-statistics-canada-housing-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/crawlerbros~statistics-canada-housing-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-statistics-canada-housing-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/crawlerbros~statistics-canada-housing-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-statistics-canada-housing-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", "required": [ "mode" ], "properties": { "mode": { "title": "Dataset", "enum": [ "newHousingPriceIndex", "housingStarts", "housingStartsByMarket", "housingStartsSAAR", "averageRents", "buildingPermits", "vacancyRates", "condoApartmentPriceIndex", "mortgageRate", "newlyCompletedUnoccupiedHousing", "absorptionsUnabsorbedInventory", "absorptionsUnabsorbedInventoryCA" ], "type": "string", "description": "Which official Statistics Canada housing table to scrape.", "default": "newHousingPriceIndex" }, "geography": { "title": "Geography (mode = New housing price index)", "enum": [ "Alberta", "Atlantic Region", "British Columbia", "Calgary, Alberta", "Canada", "Charlottetown, Prince Edward Island", "Edmonton, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kelowna, British Columbia", "Kitchener-Cambridge-Waterloo, Ontario", "London, Ontario", "Manitoba", "Montréal, Quebec", "New Brunswick", "Newfoundland and Labrador", "Nova Scotia", "Ontario", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Prairie Region", "Prince Edward Island", "Quebec", "Québec, Quebec", "Regina, Saskatchewan", "Saint John, Fredericton, and Moncton, New Brunswick", "Saskatchewan", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba" ], "type": "string", "description": "Used only for mode = New housing price index. Pick a Canadian CMA, province, region, or \"Canada\".", "default": "Toronto, Ontario" }, "customGeography": { "title": "Custom geography override (advanced)", "type": "string", "description": "Free-text Statistics Canada geography name for a smaller city not in the dropdown (e.g. \"Brockville, Ontario\" — supported by the Average rents dataset). Overrides whichever geography dropdown applies to the selected mode. Must match Statistics Canada's exact naming for the selected dataset; not every geography is published for every dataset." }, "housingStartsGeography": { "title": "Geography (mode = Housing starts)", "enum": [ "Abbotsford-Mission, British Columbia", "Barrie, Ontario", "Brantford, Ontario", "Calgary, Alberta", "Census metropolitan areas", "Edmonton, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "London, Ontario", "Moncton, New Brunswick", "Montréal excluding Saint-Jérôme, Quebec", "Montréal, Quebec", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Peterborough, Ontario", "Québec, Quebec", "Regina, Saskatchewan", "Saguenay, Quebec", "Saint John, New Brunswick", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba" ], "type": "string", "description": "Used only for mode = CMHC housing starts / under construction / completions. Selected census metropolitan areas only (narrower coverage than the Housing starts by dwelling type and market mode).", "default": "Toronto, Ontario" }, "buildingPermitsGeography": { "title": "Geography (mode = Residential building permits)", "enum": [ "Abbotsford-Mission, British Columbia", "Alberta", "Alberta - total census metropolitan area", "Barrie, Ontario", "Belleville - Quinte West, Ontario", "Brantford, Ontario", "British Columbia", "British Columbia - total census metropolitan area", "Calgary, Alberta", "Canada", "Canada - total census metropolitan area", "Chilliwack, British Columbia", "Drummondville, Quebec", "Edmonton, Alberta", "Fredericton, New Brunswick", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kamloops, British Columbia", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "Lethbridge, Alberta", "London, Ontario", "Manitoba", "Manitoba - total census metropolitan area", "Moncton, New Brunswick", "Montréal, Quebec", "Nanaimo, British Columbia", "New Brunswick", "New Brunswick - total census metropolitan area", "Newfoundland and Labrador", "Newfoundland and Labrador - total census metropolitan area", "Northwest Territories", "Nova Scotia", "Nova Scotia - total census metropolitan area", "Nunavut", "Ontario", "Ontario - total census metropolitan area", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part", "Ottawa-Gatineau, Québec part", "Peterborough, Ontario", "Prince Edward Island", "Quebec", "Quebec - total census metropolitan area", "Québec, Quebec", "Red Deer, Alberta", "Regina, Saskatchewan", "Saguenay, Quebec", "Saint John, New Brunswick", "Saskatchewan", "Saskatchewan - total census metropolitan area", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba", "Yukon" ], "type": "string", "description": "Used only for mode = Residential building permits. Seasonally adjusted and constant-dollar figures are published for provinces and most CMAs, not just \"Canada\" — if a specific combination returns no data, try \"Unadjusted, current\" or geography = \"Canada\".", "default": "Canada" }, "priceIndexComponent": { "title": "Price index component (mode = New housing price index)", "enum": [ "Total (house and land)", "House only", "Land only" ], "type": "string", "description": "Which component of the New Housing Price Index to return.", "default": "Total (house and land)" }, "housingEstimateType": { "title": "Estimate type (mode = Housing starts)", "enum": [ "Housing starts", "Housing under construction", "Housing completions" ], "type": "string", "description": "Which CMHC housing estimate to return.", "default": "Housing starts" }, "housingUnitType": { "title": "Unit type (mode = Housing starts)", "enum": [ "Total units", "Single-detached units", "Semi-detached units", "Row units", "Apartment and other unit types" ], "type": "string", "description": "Dwelling type to filter by.", "default": "Total units" }, "averageRentsGeography": { "title": "Geography (mode = Average rents)", "enum": [ "Abbotsford-Mission, British Columbia", "Alma, Quebec", "Amos, Quebec", "Asbestos, Quebec", "Baie-Comeau, Quebec", "Barrie, Ontario", "Bathurst, New Brunswick", "Bay Roberts, Newfoundland and Labrador", "Belleville, Ontario", "Bonnyvill No. 87, Alberta", "Bracebridge, Ontario", "Brandon, Manitoba", "Brantford, Ontario", "Brighton, Ontario", "Brock, Ontario", "Brockville, Ontario", "Brooks, Alberta", "Bécancour, Quebec", "Calgary, Alberta", "Campbell River, British Columbia", "Campbellton, New Brunswick part, New Brunswick/Quebec", "Campbellton, Quebec part, New-Brunswick/Quebec", "Camrose, Alberta", "Canmore, Alberta", "Cape Breton, Nova Scotia", "Carbonear, Newfoundland and Labrador", "Centre Wellington, Ontario", "Charlottetown, Prince Edward Island", "Chatham-Kent, Ontario", "Chester, Nova Scotia", "Chibougamau, Quebec", "Chilliwack, British Columbia", "Clearwater County, Alberta", "Cobourg, Ontario", "Cold Lake, Alberta", "Collingwood, Ontario", "Corner Brook, Newfoundland and Labrador", "Cornwall, Ontario", "Courtenay, British Columbia", "Cowansville, Quebec", "Cranbrook, British Columbia", "Dawson Creek, British Columbia", "Dolbeau-Mistassini, Quebec", "Drummondville, Quebec", "Duncan, British Columbia", "Dunnville, Ontario", "East Hants, Nova Scotia", "Edmonton, Alberta", "Edmundston, New Brunswick", "Elliot Lake, Ontario", "Erin, Ontario", "Essex, Ontario", "Estevan, Saskatchewan", "Fergus, Ontario", "Foothills No. 13, Alberta", "Fort Erie, Ontario", "Fort St. John, British Columbia", "Fredericton, New Brunswick", "Gander, Newfoundland and Labrador", "Gaspé, Quebec", "Granby, Quebec", "Grand Falls-Windsor, Newfoundland and Labrador", "Grande Prairie, Alberta", "Gravenhurst, Ontario", "Greater Napanee, Ontario", "Greater Sudbury, Ontario", "Guelph, Ontario", "Haldimand County, Ontario", "Halifax, Nova Scotia", "Halton Hills, Ontario", "Hamilton, Ontario", "Hanover, Manitoba", "Hawkesbury, Ontario part, Ontario/Quebec", "Hawkesbury, Quebec part, Ontario/Quebec", "High River, Alberta", "Huntsville, Ontario", "Ingersoll, Ontario", "Joliette, Quebec", "Kamloops, British Columbia", "Kapuskasing, Ontario", "Kawartha Lakes, Ontario", "Kelowna, British Columbia", "Kenora, Ontario", "Kentville, Nova Scotia", "Kincardine, Ontario", "Kings Subdivision, Ontario", "Kingston, Ontario", "Kirkland Lake, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "Kitimat, British Columbia", "La Baie, Quebec", "La Tuque, Quebec", "Labrador City, Newfoundland and Labrador", "Lachute, Quebec", "Lacombe County, Alberta", "Lacombe, Alberta", "Lambton Shores, Ontario", "Leamington, Ontario", "Leduc, Alberta", "Les Îles-de-la-Madeleine, Quebec", "Lethbridge, Alberta", "Lincoln, Ontario", "Lloydminster, Alberta part, Saskachewan/Alberta", "Lloydminster, Saskatchewan part, Saskatchewan/Alberta", "London, Ontario", "Lunenburg, Nova Scotia", "Mackenzie No. 23, Alberta", "Magog, Quebec", "Matane, Quebec", "Meaford, Ontario", "Medicine Hat, Alberta", "Midland, Ontario", "Milton, Ontario", "Mirabel, Quebec", "Miramichi, New Brunswick", "Mission, British Columbia", "Mississippi Mills, Ontario", "Moncton, New Brunswick", "Mont-Laurier, Quebec", "Montmagny, Quebec", "Montréal, Quebec", "Moose Jaw, Saskatchewan", "Mountain View County, Alberta", "Nanaimo, British Columbia", "Nanticoke, Ontario", "New Glasgow, Nova Scotia", "Newcastle, Ontario", "Norfolk, Ontario", "North Battleford, Saskatchewan", "North Bay, Ontario", "North Cowichan, British Columbia", "North Grenville, Ontario", "North Perth, Ontario", "Okotoks, Alberta", "Orangeville, Ontario", "Orillia, Ontario", "Oromocto, New Brunswick", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Owen Sound, Ontario", "Parksville, British Columbia", "Pembroke, Ontario", "Pembroke, Quebec part, Ontario/Quebec", "Penticton, British Columbia", "Petawawa, Ontario", "Peterborough, Ontario", "Port Alberni, British Columbia", "Port Hope, Ontario", "Portage La Prairie, Manitoba", "Powell River, British Columbia", "Prince Albert, Saskatchewan", "Prince Edward, Ontario", "Prince George, British Columbia", "Prince Rupert, British Columbia", "Prévost, Quebec", "Queens, Nova Scotia", "Quesnel, British Columbia", "Québec, Quebec", "Rawdon, Quebec", "Red Deer County, Alberta", "Red Deer, Alberta", "Regina, Saskatchewan", "Rimouski, Quebec", "Rivière-du-Loup, Quebec", "Roberval, Quebec", "Rouyn-Noranda, Quebec", "Saguenay, Quebec", "Saint John, New Brunswick", "Saint-Félicien, Quebec", "Saint-Georges, Quebec", "Saint-Hyacinthe, Quebec", "Saint-Jean-sur-Richelieu, Quebec", "Saint-Jérôme, Quebec", "Saint-Lin--Laurentides, Quebec", "Sainte- Sophie, Quebec", "Sainte-Adèle, Quebec", "Sainte-Marie, Quebec", "Salaberry-de-Valleyfield, Quebec", "Salmon Arm, British Columbia", "Sarnia, Ontario", "Saskatoon, Saskatchewan", "Saugeen Shores, Ontario", "Sault Ste. Marie, Ontario", "Scugog, Ontario", "Selkirk, Manitoba", "Sept-Îles, Quebec", "Shawinigan, Quebec", "Sherbrooke, Quebec", "Smiths Falls, Ontario", "Sorel-Tracy, Quebec", "South Huron, Ontario", "Spruce Grove, Alberta", "Squamish, British Columbia", "St. Andrews, Ontario", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "St. Thomas, Ontario", "Steinbach, Manitoba", "Stratford, Ontario", "Strathmore, Alberta", "Strathroy, Ontario", "Summerland, British Columbia", "Summerside, Prince Edward Island", "Swift Current, Saskatchewan", "Sylvan Lake, Alberta", "Temiskaming Shores, Ontario", "Terrace, British Columbia", "The Nation, Ontario", "Thetford Mines, Quebec", "Thompson, Manitoba", "Thunder Bay, Ontario", "Tillsonburg, Ontario", "Timmins, Ontario", "Toronto, Ontario", "Trail, British Columbia", "Trent Hills, Ontario", "Trenton, Ontario", "Trois-Rivières, Quebec", "Truro, Nova Scotia", "Val-d'Or, Quebec", "Vancouver, British Columbia", "Vernon, British Columbia", "Victoria, British Columbia", "Victoriaville, Quebec", "Wallaceburg, Ontario", "Wasaga Beach, Ontario", "West Grey, Ontario", "West Hants, Nova Scotia", "West Nipissing, Ontario", "Wetaskiwin County No. 10, Alberta", "Wetaskiwin, Alberta", "Weyburn, Saskatchewan", "Whitehorse, Yukon", "Williams Lake, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba", "Wood Buffalo, Alberta", "Woodstock, Ontario", "Yarmouth, Nova Scotia", "Yellowhead County, Alberta", "Yellowknife, Northwest Territories", "Yorkton, Saskatchewan" ], "type": "string", "description": "Used only for mode = CMHC average rents. Broadest geography coverage of any mode here (244 areas with a population of 10,000 and over), including many smaller cities not offered by the other modes.", "default": "Toronto, Ontario" }, "housingStartsByMarketGeography": { "title": "Geography (mode = Housing starts by dwelling type and market)", "enum": [ "Abbotsford-Mission, British Columbia", "Alberta", "All census agglomerations 50,000 and over", "Barrie, Ontario", "Belleville, Ontario", "Brantford, Ontario", "British Columbia", "Calgary, Alberta", "Canada", "Cape Breton, Nova Scotia", "Charlottetown, Prince Edward Island", "Chatham-Kent, Ontario", "Chilliwack, British Columbia", "Cornwall, Ontario", "Courtenay, British Columbia", "Drummondville, Quebec", "Edmonton, Alberta", "Fredericton, New Brunswick", "Granby, Quebec", "Grande Prairie, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kamloops, British Columbia", "Kawartha Lakes, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "Lethbridge, Alberta", "London, Ontario", "Manitoba", "Medicine Hat, Alberta", "Moncton, New Brunswick", "Montréal excluding Saint-Jérôme, Quebec", "Montréal, Quebec", "Nanaimo, British Columbia", "New Brunswick", "Newfoundland and Labrador", "Norfolk, Ontario", "North Bay, Ontario", "Nova Scotia", "Ontario", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Peterborough, Ontario", "Prince Edward Island", "Prince George, British Columbia", "Quebec", "Québec, Quebec", "Red Deer, Alberta", "Regina, Saskatchewan", "Rimouski, Quebec", "Saguenay, Quebec", "Saint John, New Brunswick", "Saint-Hyacinthe, Quebec", "Saint-Jean-sur-Richelieu, Quebec", "Saint-Jérôme, Quebec", "Sarnia, Ontario", "Saskatchewan", "Saskatoon, Saskatchewan", "Sault Ste. Marie, Ontario", "Shawinigan, Quebec", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Total census metropolitan areas", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Vernon, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba", "Wood Buffalo, Alberta" ], "type": "string", "description": "Used only for mode = CMHC housing starts by dwelling type and intended market. Broader geography coverage (86 centres of 10,000+) than the main Housing starts mode, including provinces, CMAs, and smaller census agglomerations. Note: Statistics Canada only publishes this dwelling-type/market-type breakdown at the city (CMA) level up to the present; the \"Canada\" and individual-province rows in this breakdown were discontinued in 2002 and only return historical data through then. Choose a city for current data.", "default": "Toronto, Ontario" }, "dwellingUnitType": { "title": "Dwelling unit type (mode = Housing starts by dwelling type and market)", "enum": [ "Total units", "Single units", "Semi-detached units", "Row units", "Apartment and other types of units" ], "type": "string", "description": "Type of dwelling for the housing-starts-by-market figure.", "default": "Total units" }, "marketType": { "title": "Intended market (mode = Housing starts by dwelling type and market)", "enum": [ "Homeowner", "Rental", "Condo", "Co-op", "Other market" ], "type": "string", "description": "The intended market of the housing starts: homeowner (built for the owner), rental, condominium, co-operative, or other.", "default": "Homeowner" }, "rentStructureType": { "title": "Structure type (mode = Average rents)", "enum": [ "Row and apartment structures of three units and over", "Apartment structures of three units and over", "Apartment structures of six units and over", "Row structures of three units and over" ], "type": "string", "description": "Building structure type for the rental universe.", "default": "Row and apartment structures of three units and over" }, "rentUnitType": { "title": "Unit type (mode = Average rents)", "enum": [ "Bachelor units", "One bedroom units", "Two bedroom units", "Three bedroom units" ], "type": "string", "description": "Bedroom count for the average-rent figure.", "default": "Two bedroom units" }, "vacancyRatesGeography": { "title": "Geography (mode = Apartment vacancy rate)", "enum": [ "Abbotsford-Mission, British Columbia", "Barrie, Ontario", "Brantford, Ontario", "Calgary, Alberta", "Census metropolitan areas", "Edmonton, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "London, Ontario", "Moncton, New Brunswick", "Montréal excluding Saint-Jérôme, Quebec", "Montréal, Quebec", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Peterborough, Ontario", "Québec, Quebec", "Regina, Saskatchewan", "Saguenay, Quebec", "Saint John, New Brunswick", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba" ], "type": "string", "description": "Used only for mode = CMHC apartment vacancy rate.", "default": "Toronto, Ontario" }, "permitStructureType": { "title": "Structure type (mode = Residential building permits)", "enum": [ "Total residential and non-residential", "Total major permits residential and non-residential", "Total minor residential and non-residential", "Total residential", "Total major residential project", "Total minor residential project", "Single dwelling building total", "Major single dwelling projects", "Minor single dwelling projects", "Single total", "Single", "Single condominium", "Mobile home", "Cottage", "Multiple dwelling building total", "Major multiple dwelling projects", "Minor multiple dwelling projects", "Double total", "Double", "Double condominium", "Row total", "Row", "Row condominium", "Apartment total", "Apartment", "Apartment condominium", "Total demolitions", "Demolition single - detached", "Demolition cottage", "Demolition semi-detached", "Demolition row", "Demolition apartment", "Total non-residential", "Total major non-residential projects", "Total minor non-residential projects", "Total industrial", "Total major industrial projects", "Total minor industrial projects", "Factories, plants", "Maintenance building", "Plant for manufacturing, processing and assembling goods", "Transportation, utilities", "Communication building", "Transportation terminal", "Utility building", "Mining and agriculture", "Mining building", "Agriculture", "Total commercial", "Total major commercial projects", "Total minor commercial projects", "Trade and services", "Motor vehicle show room (new and used) - car dealership, used car, motorcycle and tractor sale", "Retail and wholesale outlets", "Retail complex - plaza, mall, shopping center, store and office building", "Special building use - funeral director, crematorium, mausoleum", "Warehouses", "Service stations", "Office buildings", "Office building - consultant's office, doctor's office, insurance company, bank, taxi stand, office with cafeteria, office with smoke shop", "Office complex, office and store, office and apartment", "Recreation", "Theatre and performing art center - movie theatre, concert hall, opera house, cultural center", "Indoor recreational building - sports complex, tennis court and squash, community center, arena, curling club, swimming pool", "Outdoor recreational building - country club, golf club campground facilities, outdoor skating rink, outdoor swimming pool", "Hotels, restaurants", "Convention center, exhibition building", "Hotel, hotel and motel, motor hotel", "Motel, cabin for tourism", "Other accommodation - student's residence, boarding house, religious residence, hostel, dormitory", "Restaurant, bar, tavern, night club, diner, donut shop", "Laboratories", "Total institutional and governmental", "Total major institutional and governmental projects", "Total minor institutional and governmental projects", "Schools, education", "Elementary school, kindergarten", "Secondary school, high school, junior high school", "Post-secondary institution - technical institute, trade school", "University", "Library, museum, art gallery, aquarium, botanical garden, archive building, scientific center", "Medical, hospital", "Hospital general - military, specialized", "Clinic - health unit, out-patient clinic, first aid station", "Welfare, home", "Churches, religion", "Government buildings", "Government legislative and administration building other than office building - city hall, court of justice, embassy, parliament and senate building", "Other government building - police station, prison, fire station, military building" ], "type": "string", "description": "Type of building the permit is for. Includes broad residential/non-residential totals plus every fine-grained StatCan building-type category (single/double/row/apartment, condominium subtypes, demolitions, and non-residential categories like commercial, industrial, institutional, and governmental buildings).", "default": "Total residential and non-residential" }, "permitTypeOfWork": { "title": "Type of work (mode = Residential building permits)", "enum": [ "Types of work, total", "New dwelling units total", "New residential and non-residential constructions, total", "New construction", "Foundation", "Superstructure or part of a new building", "Mechanical", "Installation of a pre-fabricated building", "Additional value to previous permit(s)", "Improvements total", "Addition to existing building (structural extension) for non-residential only", "Alterations and improvements", "Garage and carport for residential construction, only", "Conversions total", "Conversion from single to multiple dwelling", "Conversion from multiple to multiple dwelling", "Conversion from non-residential to residential building", "Deconversion total", "Deconversion from single to non-residential building", "Deconversion from multiple to multiple or single dwelling or non-residential building", "Inground swimming pools for residential construction, only", "Demolitions for residential dwellings" ], "type": "string", "description": "Category of construction work the permit covers.", "default": "Types of work, total" }, "permitVariable": { "title": "Variable to return (mode = Residential building permits)", "enum": [ "Value of permits", "Number of dwelling-units created", "Number of dwelling-units lost", "Number of dwelling-units demolished", "Number of permits" ], "type": "string", "description": "Which figure to return for the permits series: a dollar value or a unit/permit count.", "default": "Value of permits" }, "seasonalAdjustment": { "title": "Seasonal adjustment (mode = Residential building permits)", "enum": [ "Unadjusted, current", "Seasonally adjusted, current", "Unadjusted, constant dollars", "Seasonally adjusted, constant dollars" ], "type": "string", "description": "Whether the permits series is raw or seasonally adjusted, and in current or constant dollars. Published for most geographies (Canada, provinces, and CMAs), not just \"Canada\" — if a combination returns no data for your geography, try \"Unadjusted, current\".", "default": "Unadjusted, current" }, "condoApartmentPriceIndexGeography": { "title": "Geography (mode = New condominium apartment price index)", "enum": [ "Calgary, Alberta", "Edmonton, Alberta", "Halifax, Nova Scotia", "Montréal, Quebec", "Nine census metropolitan area composite", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Québec, Quebec", "Toronto, Ontario", "Vancouver, British Columbia", "Victoria, British Columbia" ], "type": "string", "description": "Used only for mode = New condominium apartment price index. Published for a small set of major census metropolitan areas only.", "default": "Toronto, Ontario" }, "housingStartsSAARGeography": { "title": "Geography (mode = Housing starts, seasonally adjusted)", "enum": [ "Abbotsford-Mission, British Columbia", "Alberta", "Atlantic provinces", "Barrie, Ontario", "Brantford, Ontario", "British Columbia", "Calgary, Alberta", "Canada", "Edmonton, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "London, Ontario", "Manitoba", "Moncton, New Brunswick", "Montréal, Quebec", "New Brunswick", "Newfoundland and Labrador", "Nova Scotia", "Ontario", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario", "Ottawa-Gatineau, Quebec part, Quebec", "Peterborough, Ontario", "Prairie provinces", "Prince Edward Island", "Quebec", "Québec, Quebec", "Regina, Saskatchewan", "Saguenay, Quebec", "Saint John, New Brunswick", "Saskatchewan", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba" ], "type": "string", "description": "Used only for mode = CMHC housing starts, seasonally adjusted at annual rates. This is the headline monthly housing-starts figure most often quoted in the news (e.g. \"housing starts rose to 250,000 units SAAR\"). Covers Canada, every province, and 40+ CMAs.", "default": "Canada" }, "housingStartsSAARUnitType": { "title": "Unit type (mode = Housing starts, seasonally adjusted)", "enum": [ "Total units", "Single-detached units", "Semi-detached units", "Row units", "Apartment and other unit types", "Multiples" ], "type": "string", "description": "Dwelling type to filter by. Used only for mode = CMHC housing starts, seasonally adjusted at annual rates.", "default": "Total units" }, "newlyCompletedUnoccupiedHousingGeography": { "title": "Geography (mode = Newly completed unoccupied housing)", "enum": [ "Abbotsford-Mission, British Columbia", "Barrie, Ontario", "Belleville, Ontario", "Brandon, Manitoba", "Brantford, Ontario", "Calgary, Alberta", "Cape Breton, Nova Scotia", "Census agglomerations 50,000 and over", "Census metropolitan areas", "Census metropolitan areas and census agglomerations of 50,000 and over", "Charlottetown, Prince Edward Island", "Chatham-Kent, Ontario", "Chilliwack, British Columbia", "Cornwall, Ontario", "Courtenay, British Columbia", "Drummondville, Quebec", "Edmonton, Alberta", "Fredericton, New Brunswick", "Granby, Quebec", "Grande Prairie, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kamloops, British Columbia", "Kawartha Lakes, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "Lethbridge, Alberta", "London, Ontario", "Medicine Hat, Alberta", "Moncton, New Brunswick", "Montréal, Quebec", "Nanaimo, British Columbia", "Norfolk, Ontario", "North Bay, Ontario", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Peterborough, Ontario", "Prince George, British Columbia", "Québec, Quebec", "Red Deer, Alberta", "Regina, Saskatchewan", "Rimouski, Quebec", "Saguenay, Quebec", "Saint John, New Brunswick", "Saint-Hyacinthe, Quebec", "Saint-Jean-sur-Richelieu, Quebec", "Sarnia, Ontario", "Saskatoon, Saskatchewan", "Sault Ste. Marie, Ontario", "Shawinigan, Quebec", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Vernon, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba", "Wood Buffalo, Alberta" ], "type": "string", "description": "Used only for mode = CMHC newly completed and unoccupied housing. Census metropolitan areas and census agglomerations of 50,000+ — this measures the unsold/unoccupied completed-home inventory overhang, a key housing-market-slack indicator.", "default": "Toronto, Ontario" }, "unoccupiedHousingUnitType": { "title": "Unit type (mode = Newly completed unoccupied housing)", "enum": [ "Total units", "Single-detached and semi-detached units", "Single-detached units", "Semi-detached units", "Row, apartment and other units", "Row units", "Apartment and other units" ], "type": "string", "description": "Dwelling type to filter by.", "default": "Total units" }, "absorptionsGeography": { "title": "Geography (mode = Absorptions and unabsorbed inventory, CMA)", "enum": [ "Abbotsford-Mission, British Columbia", "Barrie, Ontario", "Brantford, Ontario", "Calgary, Alberta", "Census metropolitan areas", "Edmonton, Alberta", "Greater Sudbury, Ontario", "Guelph, Ontario", "Halifax, Nova Scotia", "Hamilton, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Kitchener-Cambridge-Waterloo, Ontario", "London, Ontario", "Moncton, New Brunswick", "Montréal excluding Saint-Jérôme, Quebec", "Montréal, Quebec", "Oshawa, Ontario", "Ottawa-Gatineau, Ontario part, Ontario/Quebec", "Ottawa-Gatineau, Ontario/Quebec", "Ottawa-Gatineau, Quebec part, Ontario/Quebec", "Peterborough, Ontario", "Québec, Quebec", "Regina, Saskatchewan", "Saguenay, Quebec", "Saint John, New Brunswick", "Saskatoon, Saskatchewan", "Sherbrooke, Quebec", "St. Catharines-Niagara, Ontario", "St. John's, Newfoundland and Labrador", "Thunder Bay, Ontario", "Toronto, Ontario", "Trois-Rivières, Quebec", "Vancouver, British Columbia", "Victoria, British Columbia", "Windsor, Ontario", "Winnipeg, Manitoba" ], "type": "string", "description": "Used only for mode = CMHC absorptions and unabsorbed inventory (by CMA). Census metropolitan areas only — for smaller cities, use the \"by smaller city/census agglomeration\" mode instead.", "default": "Toronto, Ontario" }, "absorptionsCAGeography": { "title": "Geography (mode = Absorptions and unabsorbed inventory, smaller city/CA)", "enum": [ "All census agglomerations 50,000 and over", "Abbotsford-Mission, British Columbia", "Barrie, Ontario", "Belleville, Ontario", "Brantford, Ontario", "Cape Breton, Nova Scotia", "Charlottetown, Prince Edward Island", "Chatham-Kent, Ontario", "Chilliwack, British Columbia", "Cornwall, Ontario", "Courtenay, British Columbia", "Drummondville, Quebec", "Fredericton, New Brunswick", "Granby, Quebec", "Grande Prairie, Alberta", "Guelph, Ontario", "Kamloops, British Columbia", "Kawartha Lakes, Ontario", "Kelowna, British Columbia", "Kingston, Ontario", "Lethbridge, Alberta", "Medicine Hat, Alberta", "Moncton, New Brunswick", "Nanaimo, British Columbia", "Norfolk, Ontario", "North Bay, Ontario", "Peterborough, Ontario", "Prince George, British Columbia", "Red Deer, Alberta", "Rimouski, Quebec", "Saint-Hyacinthe, Quebec", "Saint-Jean-sur-Richelieu, Quebec", "Saint-Jérôme, Quebec", "Sarnia, Ontario", "Sault Ste. Marie, Ontario", "Shawinigan, Quebec", "Vernon, British Columbia", "Wood Buffalo, Alberta" ], "type": "string", "description": "Used only for mode = CMHC absorptions and unabsorbed inventory (by smaller city/census agglomeration). Census agglomerations of 50,000 and over only — for large metro areas, use the \"by CMA\" mode instead.", "default": "All census agglomerations 50,000 and over" }, "completedDwellingUnitsStatus": { "title": "Status (mode = Absorptions and unabsorbed inventory, CMA or smaller city/CA)", "enum": [ "Absorptions", "Unabsorbed inventory" ], "type": "string", "description": "Whether to return absorptions (newly completed homes that sold/rented that period) or unabsorbed inventory (newly completed homes still unsold/unoccupied at period end). Used by both absorptions modes.", "default": "Absorptions" }, "absorptionsUnitType": { "title": "Unit type (mode = Absorptions and unabsorbed inventory, CMA or smaller city/CA)", "enum": [ "Total units", "Single detached units", "Semi-detached units" ], "type": "string", "description": "Dwelling type to filter by. Used by both absorptions modes.", "default": "Total units" }, "dateFrom": { "title": "Reference period from", "type": "string", "description": "Earliest reference period to include, inclusive. Use \"YYYY-MM\" for monthly datasets (New housing price index, Housing starts, Building permits) or \"YYYY\" for the annual Average rents dataset. Leave blank for no lower bound." }, "dateTo": { "title": "Reference period to", "type": "string", "description": "Latest reference period to include, inclusive. Same format as 'Reference period from'. Leave blank for no upper bound." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records. Records are returned most-recent period first.", "default": 100 } } }, "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 } } } } } } } } } }