Every tool the server exposes

Use for retrieving actual census data (counts or rates) for one or more geographies (by DGUID, from statcan_census_profile_search_geography) crossed with one or more characteristics (by code, from statcan_census_profile_search_characteristic), for a given gender breakdown. Multiple geography_codes or characteristic_codes are combined (every geography x every characteristic). Returns each value alongside its data-quality flag and confidence interval when the upstream API supplies one -- do not drop a flagged or interval-bounded value silently.

Keywords

census, population, dwelling, income, age, demographics, statistics Canada, 2021 census, SDMX

Mots-clés

recensement, population, logement, revenu, âge, démographie, Statistique Canada, recensement de 2021

Use for finding a characteristic code (needed by statcan_census_profile_get_data) by keyword, e.g. "population", "median household income", "dwelling", "commute". An empty query returns every characteristic. Each match includes parent_code when the characteristic is a sub-item of a broader one in the profile table's own hierarchy (e.g. "0 to 4 years" is a child of "0 to 14 years", itself a child of "Total - Age groups of the population") -- use this to tell a summary row from its breakdown rows rather than treating all 2,631 characteristics as a flat list.

Keywords

census, characteristic, variable, population, income, dwelling, age, language, education, housing, commuting

Mots-clés

recensement, caractéristique, variable, population, revenu, logement, âge, langue, éducation, navettage

Use for finding a geography's DGUID code (needed by statcan_census_profile_get_data) by place name substring, at a chosen level (province, census division, census subdivision/ municipality, census metro area, census tract, dissemination area, forward sortation area, health region, economic region, federal electoral district, population centre, designated place). An empty query returns every geography at that level.

Keywords

census, geography, DGUID, place name, municipality, province, census subdivision, census tract, forward sortation area, FSA

Mots-clés

recensement, géographie, DGUID, nom de lieu, municipalité, province, subdivision de recensement, secteur de recensement, région de tri d'acheminement

Use for retrieving 2016 census values (counts or rates) for a geography found via statcan_census_profile_2016_list_geographies, optionally scoped to one topic (population, income, housing, labour, education, language, mobility, immigration and citizenship, ethnic origin, visible minority, Aboriginal peoples, journey to work, language of work, families/households/marital status). Values include separate total/male/female breakdowns and any suppression/quality symbol alongside the numeric value -- do not drop a flagged value silently. Set include_notes=True for the full explanatory footnote text. This is distinct from statcan_census_profile_* (2021) and covers only the 2016 census.

Keywords

census 2016, population, dwelling, income, age, demographics, statistics Canada, census profile

Mots-clés

recensement 2016, population, logement, revenu, âge, démographie, Statistique Canada, profil du recensement

Use for finding a geography's DGUID code (needed by statcan_census_profile_2016_get_data) for the 2016 census, at a chosen level (province, census division, census subdivision, census metro area, census tract, dissemination area, forward sortation area, health region, economic region, federal electoral district, population centre, designated place). Optionally filter to one province/territory. Each result also carries global non-response rates and a data-quality flag.

Keywords

census 2016, geography, DGUID, place name, municipality, census subdivision, CMA, geographic code

Mots-clés

recensement 2016, géographie, DGUID, nom de lieu, municipalité, subdivision de recensement, RMR, code géographique

Use for resolving the actual downloadable file (a compressed CSV or TAB archive covering every geography at that level, for all topics) for a pre-2021 census, given a level key from statcan_census_profile_archive_list_geography_levels. Files can be large (tens to hundreds of megabytes for fine-grained levels like dissemination areas). Only CSV and TAB formats are covered -- IVT (a proprietary Beyond 20/20 format) uses a different, separate resolver not implemented here. lang="fr" returns StatCan's French-language file for every year.

Keywords

census, archive, historical, download, CSV, TAB, comprehensive download file, census profile

Mots-clés

recensement, archive, historique, téléchargement, fichier de téléchargement global, profil du recensement, fichier en français, CSV

Use for discovering what level keys (needed by statcan_census_profile_archive_get_download_link) and file formats exist for one archived census (2001, 2006, 2011, or 2016) before the 2021 Census Profile (covered by statcan_census_profile_* instead). Coverage genuinely narrows going back in time: 2016 has 34 geography groupings, 2011 has 14, 2006 and 2001 each have 5. Level keys are the same in both languages, so lang does not change this list; pass it to the download-link tool for French files.

Keywords

census, archive, historical, 2001, 2006, 2011, 2016, bulk download, comprehensive download file

Mots-clés

recensement, archive, historique, téléchargement en bloc, fichier de téléchargement global, niveau géographique, format de fichier, profil du recensement

Use for downloading a table found with statcan_census_tables_search (by pid). Checks which formats exist and their sizes. When only the IVT exists, returns an R snippet using mountainMath's canivt to read it. Some SDMX files are very large; check size_bytes first.

Keywords

census table download, CSV, SDMX, IVT, Beyond 20/20, canivt, full table, census

Mots-clés

téléchargement, tableau du recensement, CSV, SDMX, IVT, Beyond 20/20, tableau complet, recensement

Use for census cross-tabulations by topic and geography, e.g. "income household type" or "language dissemination areas", with the catalogue number and PID of each table. Every word must appear in the title. 2021 census tables are StatCan tables: use wds_search_cubes. StatCan retired the 2011 Census tabulations (the 2011 NHS ones remain); copies are on Borealis, see borealis_search_ivt. Titles are in English; lang is accepted for consistency.

Keywords

census data tables, cross-tabulation, 2016 census, 2011 National Household Survey, 2006 census, Beyond 20/20, topic-based tabulations, census

Mots-clés

tableaux de données du recensement, totalisations croisées, recensement de 2016, Enquête nationale auprès des ménages, recensement de 2006, Beyond 20/20, tableaux thématiques, recensement

Use for finding what data StatCan has released recently -- new or updated tables, survey results, analytical products -- optionally filtered to one subject (e.g. "housing", "labour", "prices_and_price_indexes"). Covers the last 100 days. Each release has a title, a canonical URL (either a Daily article or a catalogue-number product page), a publication timestamp, and a plain-text summary. Use "all" for every subject in one call.

Keywords

The Daily, release bulletin, new data, recent releases, what's new, StatCan announcement, Statistics Canada, latest statistics

Mots-clés

Le Quotidien, bulletin de diffusion, nouvelles données, diffusions récentes, quoi de neuf, annonce de Statistique Canada, Statistique Canada, dernières statistiques

Use for finding when StatCan first or last released something on a topic, or listing every historical release matching a keyword, going back to 2012 -- statcan_daily_get_releases only covers the last 100 days via the official Atom feeds. query matches against the release title and reference period (e.g. "second quarter 2020"); leave it empty to browse by date range alone. start_date and end_date are "YYYY-MM-DD" and filter to releases on or between those dates (inclusive); omit either to leave that side open. Results are returned most-recent-first.

Keywords

The Daily, historical, archive, past releases, release history, when was, Statistics Canada, release date

Mots-clés

Le Quotidien, historique, archive, diffusions passées, historique des diffusions, quand, Statistique Canada, date de diffusion

Use for bulk-downloading every table/vector data and metadata update StatCan released on one business day, as a single ZIP -- the preferred mechanism (per StatCan's own developer guidance) for large updates, rather than re-fetching individual tables one at a time. date is "YYYY-MM-DD". A Delta File only exists for business days that had a release (weekends and holidays will report exists=False); check exists before treating the url as downloadable. The ZIP carries both English and French metadata, so lang has no effect.

Keywords

StatCan, delta file, bulk update, daily update, all tables, full refresh, changed data, download

Mots-clés

Statistique Canada, fichier delta, mise à jour en bloc, mise à jour quotidienne, tous les tableaux, actualisation complète, données modifiées, téléchargement

Use for inspecting a layer's queryable fields (e.g. CSDUID, DGUID, CSDNAME, PRUID) and its maxRecordCount before calling statcan_geo_query_layer -- service is a name from statcan_geo_list_services (e.g. "Cartographic_boundary_files"), layer_id a small integer identifying one geography level within that service (e.g. layer 9 = CSD, layer 12 = DA for 2021's Cartographic boundary files -- layer numbering is not fixed across years/services and should be discovered, not assumed). The language comes from service itself, so lang has no effect here.

Keywords

statcan, geography, layer, schema, fields, arcgis, boundary file, geometry type

Mots-clés

statcan, géographie, couche, schéma, champs, arcgis, fichier de limites, type de géométrie

Use for discovering what geography boundary products exist for a given year before drilling into a service's layers. A census year (e.g. "2021") publishes a full suite (Cartographic/Digital boundary files, Agricultural/Population ecumene boundary files, Road Network File, each in English and French) with every geography level; an intercensal year publishes only a smaller CSD-level update and the Road Network File -- this genuinely varies year to year and is discovered live, not hardcoded. Years 2019-2025 confirmed live; nothing older is served here (use statcan_census_profile_archive_* for older bulk boundary/data downloads instead). Only the lang edition of each product is listed: French services (e.g. "Fichiers_des_limites_cartographiques") carry French layer names and field aliases.

Keywords

statcan, geography, boundary files, geospatial, arcgis, census geography, cartographic, digital boundary file

Mots-clés

statcan, géographie, fichiers de limites, géospatial, arcgis, géographie du recensement, limites cartographiques, fichier numérique des limites

Use for finding a geography's DGUID/UID by name (e.g. where="CSDNAME='Toronto'"), or retrieving boundary polygons for mapping. where is a standard SQL-style predicate against the layer's own field names from statcan_geo_get_layer_detail (e.g. "PRUID='35' AND CSDNAME LIKE '%Toronto%'"); leave the default "1=1" to match every feature in the layer. Leave return_geometry false (the default) for a lightweight attribute-only query -- polygon boundaries can be large, and most lookups only need the UID/DGUID/name columns. When return_geometry is true, geometry is reprojected to out_sr (WGS84 lat/lon, EPSG:4326, by default -- the service's native spatial reference is EPSG:3347, Statistics Canada Lambert). Each layer enforces its own maxRecordCount as a hard per-request cap regardless of result_record_count (6000 confirmed for 2021's Cartographic boundary layers); check exceeded_transfer_limit on the result and page further with result_offset if more features remain. Confirmed live: this host intermittently returns HTTP 500 on an otherwise-valid request (roughly one in three to five calls, a load-balanced backend with some unhealthy nodes) -- already mitigated by this client's normal retry behavior, so a rare persisting failure is a genuine outage, not a malformed request. The language comes from service, so lang has no effect here.

Keywords

statcan, geography, query, boundary, dguid, csd, da, fsa, cma, arcgis, geospatial, polygon, geojson

Mots-clés

statcan, géographie, requête, limites, dguid, sdr, ad, rta, rmr, arcgis, géospatial, polygone, geojson

Use for quick current-value lookups for named indicators (e.g. "population", "consumer price index", "GDP", "unemployment rate") -- the same feeds that power My StatCan, statcan.gc.ca's home page, and The Daily's own indicator widgets. dataset="economic" is a curated subset of major economic indicators; "homepage" is the subset shown on StatCan's own home page; "all" covers every tracked indicator (2,362 confirmed live). Each result carries its reference period, a growth-rate summary versus the prior period, and a link to the Daily article that released it. geo_code filters to one geography (0 = Canada, province/territory codes otherwise -- call with a wide query first to see which codes exist in this dataset).

Keywords

StatCan, indicator, current value, latest statistics, growth rate, population, CPI, GDP, unemployment

Mots-clés

Statistique Canada, indicateur, valeur actuelle, dernières statistiques, taux de croissance, population, IPC, PIB, taux de chômage, emploi, inflation, indice des prix à la consommation

Use for which variable measures something (query matches names, labels and value labels, e.g. "tenure", "smok"), what each code means, column positions for fixed-width files, and which weights to use (final and bootstrap/replicate). Reads only the codebook files inside the ZIP. url comes from statcan_pumf_list_files.

Keywords

codebook, data dictionary, variables, value labels, survey weights, bootstrap weights, record layout, PUMF

Mots-clés

dictionnaire de données, variables, étiquettes de valeurs, poids d'enquête, poids bootstrap, FMGD, disposition, Statistique Canada

Use for the download links for one PUMF, e.g. 71M0001X (monthly LFS files by year) or 98M0001X (Census individuals and hierarchical files, 1991-2021). Next: statcan_pumf_get_codebook with a ZIP url.

Keywords

PUMF download, microdata file, ZIP, survey year, edition, catalogue number, Statistics Canada, year

Mots-clés

téléchargement FMGD, fichier de microdonnées, ZIP, année d'enquête, numéro de catalogue, édition, Statistique Canada, année

Use for seeing the data files, user guides and codebook files in a StatCan PUMF ZIP (read with HTTP range requests, a few KB), and their uncompressed sizes. File names are listed as stored in the ZIP, so lang has no effect.

Keywords

ZIP contents, PUMF files, user guide, record layout, codebook, data file size, data file, archive

Mots-clés

contenu du ZIP, fichiers FMGD, guide de l'utilisateur, dictionnaire de données, taille, disposition des enregistrements, fichier de données, archive ZIP

Use for which surveys publish respondent-level microdata on a topic (e.g. "health", "labour", "spending"), with catalogue numbers such as 71M0001X (Labour Force Survey) or 98M0001X (Census). Next: statcan_pumf_list_files for the downloads.

Keywords

PUMF, microdata, public use microdata file, survey microdata, respondent records, Labour Force Survey, CCHS, census

Mots-clés

FMGD, microdonnées, fichier de microdonnées à grande diffusion, données d'enquête, EPA, ESCC, recensement, Statistique Canada

Use for population estimates from survey microdata, e.g. labour force status by province from the LFS, or mean hourly earnings. rows are up to 3 codebook variables to group by; filters keep only the listed codes (e.g. {"PROV": ["48"]}); share gives percentages within each group of all but the last row variable. Uses the survey weight (default: the codebook's main weight) and returns unweighted counts, flagging small cells. Standard errors and CVs come from the survey's documented replicate weights where verified (2021 Census individuals). The first call downloads the file (may take a minute or two; retry if it times out).

Keywords

weighted estimate, tabulation, crosstab, microdata analysis, survey weight, population estimate, PUMF, LFS

Mots-clés

estimation pondérée, totalisation, tableau croisé, microdonnées, poids d'enquête, estimation de population, FMGD, Statistique Canada

Use for understanding a classification (e.g. NAICS) before drilling into its categories.

Keywords

statcan, classification, detail, naics, rdaas, levels, version, background

Mots-clés

statcan, classification, détail, scian, rdaas, niveaux, version, contexte

Use for listing every code/category within a classification (e.g. all NAICS sectors and subsectors). Confirmed live: RDaaS itself returns no category data for the CURRENT released NAICS (2022.1.0) specifically -- retired NAICS versions and the NAICS Trade Variant return full data, so this is not a NAICS-wide gap. If you hit this empty case on current NAICS, use rdaas_get_concordance_maps on the "NAICS Canada 2017.3.0 to 2022.1.0" concordance instead -- its target_code/target_descriptor fields are the same current-NAICS codes and descriptions.

Keywords

statcan, classification, categories, codes, naics, rdaas, tree, detailed

Mots-clés

statcan, classification, catégories, codes, scian, rdaas, arborescence, détaillé

Use for checking whether a term is deliberately excluded from a classification rather than simply missing.

Keywords

statcan, exclusions, classification, rdaas, excluded, terms, naics, Statistics Canada

Mots-clés

statcan, exclusions, classification, rdaas, exclu, termes, scian, non couvert

Use for retrieving a single term-to-code mapping already identified via rdaas_get_classification_indexes.

Keywords

statcan, index entry, classification, rdaas, term, code, Statistics Canada, NAICS

Mots-clés

statcan, entrée d'index, classification, rdaas, terme, code, correspondance, identifiant

Use for finding which code a plain-language term maps to.

Keywords

statcan, index, classification, rdaas, terms, alternate names, naics, Statistics Canada

Mots-clés

statcan, index, classification, rdaas, termes, noms alternatifs, scian, correspondance de termes

Use for discovering what values audience/status accept before filtering a search.

Keywords

statcan, rdaas, filters, search, audience, status, classification, Statistics Canada

Mots-clés

statcan, rdaas, filtres, recherche, public cible, statut, classification, valeurs valides

Use for confirming which two classification versions a concordance connects before requesting its code maps.

Keywords

statcan, concordance, detail, rdaas, source, target, classification, Statistics Canada

Mots-clés

statcan, concordance, détail, rdaas, source, cible, classification, connexion

Use for converting a code from one classification version to its equivalent(s) in another version.

Keywords

statcan, code map, concordance, rdaas, mapping, convert, naics, Statistics Canada

Mots-clés

statcan, correspondance de codes, concordance, rdaas, conversion, scian, table de conversion, codes

Use for discovering what values audience/status accept before filtering a concordance search.

Keywords

statcan, rdaas, filters, search, concordance, audience, status, Statistics Canada

Mots-clés

statcan, rdaas, filtres, recherche, concordance, public cible, statut, valeurs valides

Use for retrieving detail on a specific excluded term identified elsewhere.

Keywords

statcan, term exclusion, rdaas, excluded, definition, lookup, classification, reference data

Mots-clés

statcan, exclusion de terme, rdaas, terme exclu, définition, recherche, classification, données de référence

Use for finding the classification id for a topic before requesting its full detail, categories, or concordances.

Keywords

statcan, naics, classification, search, rdaas, standard, geographical, occupational, codes

Mots-clés

statcan, scian, classification, recherche, rdaas, norme, géographique, professionnelle, codes

Use for finding a concordance id before requesting its code maps.

Keywords

statcan, concordance, correspondence, rdaas, naics, version, mapping, Statistics Canada

Mots-clés

statcan, concordance, correspondance, rdaas, scian, version, conversion, recherche

Use for finding analytical publications, "Stats in brief" (many of these are also Daily articles republished with a catalogue number), and journal/periodical series -- distinct from statcan_reference_search_documents (methodology/definitions catalogue), from actual data (WDS/SDMX/RDaaS), and from The Daily's release bulletin (statcan_daily_*). Covers 10,841+ documents. Each result carries a catalogue number (e.g. "46-28-0001"), a category (e.g. "Journals and periodicals"), a description, and a release date. An empty query returns the full unfiltered catalogue (paginate with page/count to browse it).

Keywords

StatCan, analysis, analytical article, stats in brief, journal, periodical, working paper, insights

Mots-clés

Statistique Canada, analyse, article analytique, coup d'œil sur, revue, périodique, document de travail, études

Use for finding a data product's catalogue number, especially one with no WDS/SDMX discovery path of its own -- most notably Public Use Microdata Files (PUMFs; category "Public use microdata", e.g. catalogue number 71M0001X for the Labour Force Survey PUMF, 98M0001X for the Census). Most other results here are ordinary table PIDs also reachable via statcan_wds_*/statcan_sdmx_*, so prefer those tools for routine table search -- use this one when the product itself (a PUMF, a boundary file, a bulk archive) is the target, not a table's time series. Covers 13,342+ items. For a PUMF, pass its catalogue_number to statcan_pumf_list_files for the download ZIPs. An empty query returns the full unfiltered catalogue (paginate with page/count to browse it).

Keywords

StatCan, PUMF, public use microdata file, geographic boundary file, bulk data, data product, Statistics Canada, download

Mots-clés

Statistique Canada, FMGD, fichier de microdonnées à grande diffusion, fichier de limites géographiques, données en bloc, produit de données, téléchargement, cartes géographiques

Use for finding methodology guides, technical reference documents, survey documentation, geographic file specifications, and other "Definitions, data sources and methods"-style publications -- distinct from actual data (WDS/SDMX/RDaaS) and from The Daily's release bulletin (statcan_daily_*). Covers 2,031 documents. Each result carries a catalogue number (e.g. "16-511-X"), a category (e.g. "Surveys and statistical programs – Documentation", "Geographic files and documentation"), a description, and a release date. An empty query returns the full unfiltered catalogue (paginate with page/count to browse it).

Keywords

StatCan, definitions, data sources and methods, DSDM, methodology, technical reference guide, survey documentation, catalogue number

Mots-clés

Statistique Canada, définitions, sources de données et méthodes, méthodologie, guide de référence technique, documentation d'enquête, numéro au catalogue, publications techniques

Use for retrieving an SDG indicator's actual time series. Each observation's disaggregations field carries whatever breakdown columns that specific indicator publishes (e.g. Geography, Pillar) -- these vary per indicator and are not fixed across the framework, confirmed live.

Keywords

statcan, SDG, indicator data, time series, sustainable development goals, observations, Statistics Canada, indicator values

Mots-clés

statcan, ODD, données d'indicateur, série chronologique, objectifs de développement durable, observations, Statistique Canada, valeurs de l'indicateur

Use for understanding what an indicator (e.g. "12-1-1") actually measures before requesting its data with statcan_sdg_get_indicator_data. code comes from statcan_sdg_search_indicators; the same code can mean a different indicator in the "canada" vs. "global" framework, so pass the same framework used to find it.

Keywords

statcan, SDG, indicator metadata, goal, target, definition, source, sustainable development

Mots-clés

statcan, ODD, métadonnées d'indicateur, objectif, cible, définition, source, développement durable

Use for finding an indicator's code before requesting its metadata or data. framework selects which indicator set: "canada" (86 indicators, Canada's own national reporting framework) or "global" (251 indicators, Canada's reporting against the UN's own Global Indicator Framework) -- distinct, differently-numbered indicator sets on the same "Open SDG" platform, confirmed live; pick the one matching what the caller means by "SDG indicator X.Y.Z". Leave query empty to list every indicator in that framework. This data has no WDS/SDMX cube/PID equivalent -- it is not otherwise reachable through any other tool in this codebase.

Keywords

statcan, SDG, sustainable development goals, indicator, UN, 2030 agenda, goal, target

Mots-clés

statcan, ODD, objectifs de développement durable, indicateur, ONU, programme 2030, objectif, cible

Use for fetching only the dimension combination you need rather than the full table. key is a dot-separated string of member ids, one per non-time dimension, in dimension-position order (empty segment = wildcard; use sdmx_get_key_for_dimension instead of a wildcard on a >30-code dimension). last_n_observations cannot be combined with start_period/end_period — StatCan rejects that combination.

Keywords

statcan, sdmx, data, filtered, key, dimensions, query, observations, slice

Mots-clés

statcan, sdmx, données, filtré, clé, dimensions, requête, observations, découpage

Use for querying a dimension with more than ~30 codes (e.g. detailed geography or occupation) — StatCan's SDMX API returns a sparse, unpredictable sample if that dimension is left wildcarded instead. Splice the returned or_key into the dot-separated key at this dimension's position before calling sdmx_get_data.

Keywords

statcan, sdmx, wildcard, or key, large dimension, leaf codes, sparse sample, geography, occupation

Mots-clés

statcan, sdmx, caractère générique, clé OR, grande dimension, codes terminaux, échantillon partiel, géographie, profession

Use for understanding a table's dimensions before building an SDMX query key, or before calling sdmx_get_key_for_dimension on a large dimension.

Keywords

statcan, sdmx, structure, dimensions, codelist, dsd, keys, Statistics Canada

Mots-clés

statcan, sdmx, structure, dimensions, liste de codes, dsd, clés, classification

Use for fetching one specific series via SDMX when you already have its vector ID (resolves the vector to a productId/coordinate internally, then builds the matching SDMX key).

Keywords

statcan, sdmx, vector, data, observations, series, query, Statistics Canada

Mots-clés

statcan, sdmx, vecteur, données, observations, série, requête, identifiant de vecteur

Use for the genuine "Definitions, data sources and methods" content for one specific survey or statistical program -- its active/inactive status, collection frequency, a plain-language description, and its subject classifications -- found via statcan_surveys_search_surveys. This comes from IMDB (Integrated Metadata Base), a separate, older system from the Reference/ Analysis catalogues; its full methodology sections (target population, sampling, data sources, data accuracy) are linked via detail_url rather than fully parsed here, since they are long prose sections better read directly than flattened into fields.

Keywords

StatCan, IMDB, survey metadata, methodology, target population, data quality, survey status, survey frequency

Mots-clés

Statistique Canada, BMDI, métadonnées d'enquête, méthodologie, population cible, statut de l'enquête, fréquence, description de l'enquête

Use for finding a survey's numeric ID (needed by statcan_surveys_get_survey_metadata) by name -- covers both active and inactive/discontinued surveys and statistical programs. Distinct from statcan_reference_search_documents/search_analysis (documents about surveys) and from statcan_daily_* (release bulletin) -- this is the master list of the surveys/programs themselves. An empty query returns the full directory.

Keywords

StatCan, survey, statistical program, survey directory, survey ID, Statistics Canada, data source, survey list

Mots-clés

Statistique Canada, enquête, programme statistique, répertoire des enquêtes, numéro d'enquête, source de données, liste des enquêtes, enquêtes statistiques

Use for bulk historical retrieval across several series at once, filtered by release date (not reference period). start_release_datetime/end_release_datetime must be full "YYYY-MM-DDTHH:MM" (e.g. "2024-01-01T08:30") — WDS rejects a bare date with HTTP 406.

Keywords

statcan, bulk, vectors, date range, release date, history, wds, Statistics Canada

Mots-clés

statcan, en masse, vecteurs, vecteurs multiples, plage de dates, date de diffusion, historique, wds

Use for detecting which tables were updated, e.g. after the daily 8:30am ET release.

Keywords

statcan, changed, updated, cube, table, release, today, wds

Mots-clés

statcan, modifié, mis à jour, cube, tableau, diffusion, aujourd'hui, wds

Use for fetching only what changed for a specific series identified by productId/coordinate rather than vector ID.

Keywords

statcan, changed, coordinate, delta, updated data, wds, Statistics Canada, revisions

Mots-clés

statcan, modifié, coordonnée, écart, données mises à jour, changements, tableau, wds

Use for fetching only what changed rather than the full latest-N window, after wds_get_changed_series_list flags a vector.

Keywords

statcan, changed, vector, delta, updated data, wds, Statistics Canada, revisions

Mots-clés

statcan, modifié, vecteur, écart, données mises à jour, série, changements, wds

Use for detecting updated series for a scheduled refresh. WDS documents this method as always reflecting today's changes — it does not accept a date parameter (unlike wds_get_changed_cube_list).

Keywords

statcan, changed, updated, series, release, today, wds, refresh

Mots-clés

statcan, modifié, mis à jour, série, diffusion, aujourd'hui, wds, actualisation

Use for decoding any numeric code returned by another WDS tool, e.g. applying a scalarFactorCode multiplier to a raw value.

Keywords

statcan, code sets, decode, scalar factor, frequency, symbol, status, uom, wds, lookup

Mots-clés

statcan, ensembles de codes, décoder, facteur d'échelle, fréquence, symbole, statut, unité de mesure, wds, référence

Use for understanding a table's structure before requesting data, finding the coordinate/member IDs needed for a data query.

Keywords

statcan, metadata, dimensions, members, productId, cube, structure, footnotes, wds

Mots-clés

statcan, métadonnées, dimensions, membres, productId, cube, structure, notes de bas de page, wds

Use for retrieving a specific historical window (e.g. 2015-01-01 to 2020-12-01) rather than "latest N." start_ref_period/end_ref_period must be full "YYYY-MM-DD" — WDS rejects an abbreviated "YYYY-MM" with HTTP 406.

Keywords

statcan, reference period, range, history, vectors, wds, date range, Statistics Canada

Mots-clés

statcan, période de référence, plage, plage de dates, historique, vecteurs, données historiques, wds

Use for fetching data when you have a productId/coordinate but not yet the vector ID.

Keywords

statcan, coordinate, observations, latest, data, wds, productId, Statistics Canada

Mots-clés

statcan, coordonnée, observations, dernières données, données, wds, productId, tableau

Use for fetching recent values of one or more known time series. Note: scalarFactorCode in each observation is NOT pre-applied to value — see statcan.wds.apply_scalar_factor if a scaled figure is needed.

Keywords

statcan, vector, observations, latest, data, time series, wds, values

Mots-clés

statcan, vecteur, observations, dernières données, données, série chronologique, wds, valeurs

Use for bulk/offline analysis of an entire table rather than individual series — hands back a URL, does not fetch the file.

Keywords

statcan, csv, download, full table, bulk, export, wds, Statistics Canada

Mots-clés

statcan, csv, téléchargement, tableau complet, en masse, exportation, wds, données complètes

Use for bulk retrieval in SDMX format rather than CSV — hands back a URL, does not fetch the file.

Keywords

statcan, sdmx, xml, download, full table, bulk, export, wds

Mots-clés

statcan, sdmx, xml, téléchargement, tableau complet, en masse, exportation, wds

Use for converting a table/dimension-position pair (from wds_get_cube_metadata) into a vector ID for later reuse.

Keywords

statcan, coordinate, vector, resolve, productId, series info, wds, Statistics Canada

Mots-clés

statcan, coordonnée, vecteur, résoudre, conversion, productId, information de série, identifiant, wds

Use for figuring out which table and dimension-position a known vector belongs to.

Keywords

statcan, vector, resolve, productId, coordinate, series info, wds, Statistics Canada

Mots-clés

statcan, vecteur, résoudre, conversion, productId, coordonnée, information de série, identifiant, wds

Use for a full inventory scan, building a local index, checking total table count. Prefer wds_search_cubes for a topic search.

Keywords

statcan, list, inventory, all cubes, catalogue, wds, productId, full list, tables

Mots-clés

statcan, liste, inventaire, tous les cubes, catalogue, wds, productId, liste complète, tableaux

Use for finding a StatCan table's productId when you only know a topic, discovering which tables cover a subject before requesting metadata or data.

Keywords

statcan, statistics canada, table, cube, search, productId, discover, wds, catalogue, browse, labour force, unemployment rate, employment, GDP by industry, CPI, population estimates, retail trade, wages, trade, time series

Mots-clés

statcan, statistique canada, tableau, cube, recherche, productId, découverte, wds, catalogue, parcourir, population active, taux de chômage, emploi, PIB par industrie, IPC, estimations de population, commerce de détail, salaires, commerce, séries chronologiques

Use for where a bill stands (e.g. second reading, royal assent), who sponsored it, whether it became law, and every House vote on it. session like '45-1', number like 'C-2'.

Keywords

bill status, reading, royal assent, sponsor, LEGISinfo, legislation, House vote, Parliament

Mots-clés

état du projet de loi, lecture, sanction royale, parrain, LEGISinfo, législation, vote, Parlement

Use for a committee's full name, its acronym in each session (e.g. FINA, ETHI) with the ourcommons.ca page, its subcommittees, and its 10 most recent meetings. committee is a slug from parliament_list_committees, e.g. 'finance' or 'public-accounts'. lang="fr" returns the French name and French noscommunes.ca pages.

Keywords

committee profile, committee acronym, subcommittee, committee meetings, standing committee, House of Commons, ourcommons, committee history

Mots-clés

profil du comité, sigle du comité, sous-comité, réunions du comité, comité permanent, Chambre des communes, historique du comité, travaux du comité

Use for who testified before a committee (witness name, title and organization), what MPs and witnesses said, and links to the minutes, notice and webcast. committee slug, session like '45-1' and meeting number come from parliament_search_committee_meetings. Page through the transcript with offset; limit=0 returns witnesses only. Text is plain; lang="fr" returns the French transcript, witness titles and French minutes and notice pages (noscommunes.ca).

Keywords

committee testimony, witness, evidence, committee transcript, hearing, minutes, webcast, what was said in committee

Mots-clés

témoignages, témoin, liste des témoins, qui a témoigné, comparution, transcription de la réunion, procès-verbal, webdiffusion, délibérations du comité, audience

Use for an MP's email, phone, ourcommons.ca page and every term (party, riding, dates). slug like 'ziad-aboultaif'.

Keywords

MP profile, contact, email, riding history, party history, member of Parliament, term, MP

Mots-clés

profil du député, coordonnées, courriel, circonscription, historique, parti, mandat, député

Use for party positions on a vote and, with include_ballots, how every MP voted (MP slugs). session like '45-1', number is the vote number from parliament_search_votes.

Keywords

vote breakdown, party vote, ballot, how did MPs vote, division, House of Commons, dissent, recorded vote

Mots-clés

résultat du vote, vote des partis, vote des députés, appel nominal, Chambre des communes, dissidence, vote par appel nominal, Parlement

Use for which committees exist (e.g. Finance, Health, Public Accounts) and the slug the other committee tools take. session like '44-1' (default: the current session; data from 39-1, 2006); keyword filters on the English or French name, ignoring case and accents, e.g. "santé", "sante" or "ethics". lang="fr" returns French names. Subcommittees are listed by parliament_get_committee.

Keywords

committee, standing committee, special committee, House of Commons committee, parliamentary committee, FINA, Parliament, committee list

Mots-clés

comité, comité permanent, comité spécial, comités de la Chambre des communes, comité parlementaire, liste des comités, Parlement, commission parlementaire

Use for finding bills by a word in the English or French title or by number (e.g. "housing", "logement", "C-2"; case, accents and apostrophe style are ignored), bills sponsored by an MP (sponsor slug from parliament_search_politicians), private members' bills, or bills introduced since a date. session is like '45-1' (default: the current session). Newest first. Source is OpenParliament.ca (unofficial). Follow up with parliament_get_bill.

Keywords

bill, legislation, House of Commons, Parliament, LEGISinfo, private member's bill, government bill, Senate bill, act

Mots-clés

projet de loi, législation, Chambre des communes, Parlement, LEGISinfo, projet de loi émanant d'un député, loi, Sénat

Use for a committee's meetings (committee slug), all committee meetings in a session or date range (YYYY-MM-DD), or only public or only in camera (private) meetings. Shows whether a transcript exists; upcoming meetings on notice appear with future dates. Read one with parliament_get_committee_meeting. Results carry no text, so lang has no effect.

Keywords

committee meeting, hearing, committee schedule, in camera, committee evidence, sitting, House of Commons committee, testimony

Mots-clés

réunion de comité, séance du comité, audience, à huis clos, témoignages, calendrier des comités, comité de la Chambre des communes, comparution

Use for who said what about a topic in Parliament, e.g. "pharmacare" or an exact phrase in quotes ("housing crisis"), since 1994. Returns 15 hits per page with date, speaker (MP slug), party and excerpt, by relevance or date. Read a full sitting with parliament_search_speeches. Hits come from openparliament.ca's English-only search page, so lang has no effect.

Keywords

Hansard search, debate transcript, what did MPs say, parliamentary debate, committee testimony, quote, speech, mention

Mots-clés

recherche hansard, débats parlementaires, transcription, ce qu'ont dit les députés, témoignages en comité, citation, mention, discours

Use for current MPs, their party and riding, and the slug other parliament_ tools take. include_former adds past MPs (name only). Party and riding names come back in English, so lang has no effect.

Keywords

MP, member of Parliament, riding, constituency, House of Commons, party, caucus, politician

Mots-clés

député, députée, circonscription, Chambre des communes, parti, caucus, élu, parlementaire

Use for what an MP said in the House or in committee (politician slug), the full debate of one sitting (debate_date, YYYY-MM-DD), or speeches between dates. Text is plain, in English or French.

Keywords

Hansard, debate, speech, question period, committee evidence, transcript, House of Commons, said

Mots-clés

hansard, débats, intervention, période des questions, témoignages en comité, transcription, Chambre des communes, discours

Use for recent votes, votes in a session or date range (YYYY-MM-DD), votes on one bill (session and bill), and passed or failed motions, with yea/nay totals. Use parliament_get_vote for party and MP ballots.

Keywords

vote, division, recorded vote, House of Commons, motion, yeas, nays, Parliament, roll call

Mots-clés

vote, vote par appel nominal, Chambre des communes, motion, pour, contre, Parlement, scrutin

Use for discovering all the series in a themed group before fetching their observations together, e.g. FX_RATES_DAILY (daily exchange rates for ~27 currencies) or CPI_MONTHLY (Total CPI plus core-inflation measures such as CPI-trim, CPI-median, CPI-common).

Keywords

bank of canada, boc, valet, group, detail, member series, cpi, exchange rates, commodity prices, metadata

Mots-clés

banque du canada, valet, groupe, détail, séries membres, IPC, taux de change, prix des produits de base, métadonnées

Use for fetching all series in a themed group at once, e.g. every daily exchange rate in FX_RATES_DAILY or the full CPI_MONTHLY family (Total CPI, CPI-trim, CPI-median, CPI-common), without listing each series name individually. start_date/end_date and recent/recent_weeks/recent_months/ recent_years are mutually exclusive, same as boc_get_observations.

Keywords

bank of canada, boc, valet, group, observations, data, exchange rates, cpi, inflation, commodity prices, time series, history, recent, date range

Mots-clés

banque du canada, valet, groupe, observations, données, taux de change, IPC, inflation, prix des produits de base, série chronologique, historique, plage de dates

Use for fetching exchange rate history, interest rate history, CPI/inflation history, or commodity price history for one or more named series in a single call (series_names accepts multiple codes at once, e.g. ["FXUSDCAD", "FXEURCAD"]). start_date/end_date (each "YYYY-MM-DD") and recent/recent_weeks/recent_months/recent_years are mutually exclusive - Valet rejects mixing them. Series requested together are merged into one row per date only when they share the same publication frequency; mixing frequencies (e.g. a daily FX rate with monthly CPI) returns separate rows, each carrying only its own series - check each row's values keys rather than assuming every requested series appears in every row.

Keywords

bank of canada, boc, valet, observations, data, exchange rate, interest rate, policy rate, prime rate, cpi, inflation, commodity price, time series, history, recent, date range

Mots-clés

banque du canada, valet, observations, données, taux de change, taux d'intérêt, taux directeur, taux préférentiel, IPC, inflation, prix des matières premières, série chronologique, historique, plage de dates

Use for confirming what a series code actually measures before requesting its observations, e.g. FXUSDCAD (USD/CAD daily exchange rate), V39079 (target for the overnight rate / policy rate), V80691311 (prime rate), V41690973 (Total CPI).

Keywords

bank of canada, boc, valet, series, detail, metadata, description, label, lookup

Mots-clés

banque du canada, valet, série, détail, métadonnées, description, étiquette, recherche par code, consulter

Use for a full inventory scan of themed series groupings. Prefer boc_search_groups for a topic search - this returns the entire catalogue.

Keywords

bank of canada, boc, valet, list, groups, inventory, catalogue, full list

Mots-clés

banque du canada, valet, liste, groupes, inventaire, catalogue, liste complète, parcourir

Use for a full inventory scan or building a local index. Prefer boc_search_series for a topic search - this returns the entire catalogue.

Keywords

bank of canada, boc, valet, list, inventory, all series, catalogue, full list

Mots-clés

banque du canada, valet, liste, inventaire, toutes les séries, catalogue, liste complète, parcourir

Use for finding a themed group of related series (e.g. daily exchange rates, the CPI family including CPI-trim/median/common, weekly/monthly/annual commodity price indexes) when you want several related series at once rather than one series name.

Keywords

bank of canada, boc, valet, group, series group, search, find, cpi, exchange rates, commodity prices, discover

Mots-clés

banque du canada, valet, groupe, groupe de séries, recherche, trouver, IPC, taux de change, prix des produits de base, découvrir

Use for finding a Valet series name when you only know a topic - exchange rates, interest rates (policy rate, prime rate), CPI/ inflation measures, commodity prices, and hundreds of other monetary/financial series.

Keywords

bank of canada, boc, valet, series, search, find, exchange rate, interest rate, policy rate, prime rate, cpi, inflation, commodity price, discover

Mots-clés

banque du canada, valet, série, recherche, trouver, taux de change, taux d'intérêt, taux directeur, taux préférentiel, IPC, inflation, prix des matières premières, découvrir

Use for finding registered/pending/expunged/abandoned Canadian trademarks by owner name, mark text, goods/services description, application or registration number, Nice classification, Vienna design-code, or CIPO status. Returns application number, mark name and type, current status, Nice classes, and any logo image URLs. An empty criteria is a deliberate match-all against the entire register (over 2 million records). Results are ranked by the upstream API and max_return only caps how many top-ranked matches come back in one call -- there is no way to page past that count. The search API answers in English only (status and mark-type labels), confirmed live 2026-09-23, so lang has no effect.

Keywords

CIPO, ISED, trademark, brand, mark, owner, applicant, Nice classification, Vienna code, trademark status, registered, abandoned, expunged

Mots-clés

OPIC, ISDE, recherche de marques de commerce, marque de commerce, marque, propriétaire, demandeur, classification de Nice, code de Vienne, statut de la marque, enregistrée, abandonnée, radiée

Use for how much the federal government has committed to cleantech projects: total ($29 billion), number of agreements, median agreement, for-profit share, non-repayable share, and totals by purpose (development, business support, adoption); agreement value by year; share of agreements by province or territory; value by cleantech subsector; plus the page's methodology notes. The Clean Growth Hub publishes these only as a web page and PDF; this tool reads them into numbers (dollars, not billions). For project-level records, query the grants and contributions DataStore table named in records_resource_id with ckan_datastore_search(portal='federal'). lang picks English or French labels and notes; the numbers are the same.

Keywords

clean technology, cleantech, federal investment, Clean Growth Hub, CTDS, green funding, grants and contributions, renewable energy, subsector, ISED, NRCan

Mots-clés

technologies propres, investissement fédéral, Carrefour de la croissance propre, stratégie de données, financement vert, subventions et contributions, énergie renouvelable, sous-secteur

Use for getting a federal (not provincial) corporation's current status, legal/operating names, registered addresses, director limits, annual-return filing history, and incorporation/by-law activities, given its numeric corporation id or 9-digit business number (as found in another dataset or a filing). This is a single-record lookup, not a name search -- there is no documented endpoint to search by corporation name.

Keywords

Corporations Canada, ISED, ISDE, federal corporation, business number, BN, corporate registry, director, annual return, incorporation, by-laws, company status

Mots-clés

Corporations Canada, ISDE, société fédérale, numéro d'entreprise, NE, registre des sociétés, administrateur, rapport annuel, incorporation, règlements, statut de l'entreprise

Use for understanding the columns of the IP Horizons patent or industrial design tables before downloading them: each variable's English and French name, type and description, grouped by table (e.g. patent 'main', 'interested_party', 'ipc_classification'), plus coverage-period, delimiter and encoding notes. CIPO publishes no dictionary for the trademark files. Every field carries both languages, so lang has no effect.

Keywords

IP Horizons, CIPO, data dictionary, codebook, patent variables, industrial design, column definitions, field descriptions, metadata, schema

Mots-clés

Horizons PI, OPIC, dictionnaire de données, livre de codes, variables des brevets, dessin industriel, définitions des colonnes, description des champs, métadonnées

Use for a Canadian patent or application's title (EN/FR), filing and grant dates, status, PCT numbers, and its owners, inventors, applicants and agents with their city and country. Set include_classifications=True to add its IPC classes, which reads a much larger file. Data is as of the latest quarterly release, not live. The first call downloads the needed table (tens to hundreds of MB) into a local cache; if it times out, the download continues and a retry a few minutes later answers from the cache. lang has no effect: titles come in both languages.

Keywords

patent lookup, patent number, Canadian patent, CIPO, IP Horizons, patent owner, inventor, applicant, filing date, grant date, IPC class, intellectual property

Mots-clés

recherche de brevet, numéro de brevet, brevet canadien, OPIC, Horizons PI, titulaire du brevet, inventeur, demandeur, date de dépôt, date d'octroi, classe CIB, propriété intellectuelle

Use for finding the download links for Canada's complete patent, industrial design or trademark registers as researcher bulk data, by table (e.g. patent 'main', 'claim', 'abstract', 'disclosure', 'interested_party', 'priority_claim', 'ipc_classification') and patent-number range. Each file is a ZIP of one pipe-delimited UTF-8 CSV, refreshed quarterly; large tables are split by patent number. latest_only=True keeps each table's newest release folder only. Pair with ised_ip_horizons_get_dictionary for column meanings; for a live search of individual trademarks use ised_cipo_search_trademarks. Resource names on open.canada.ca are inconsistent, so table and range come from each download URL. Both languages share one file set, so lang has no effect.

Keywords

IP Horizons, CIPO, patent data, bulk download, industrial design, trademark data, intellectual property, inventor, applicant, IPC classification, patent claims, researcher dataset

Mots-clés

Horizons PI, OPIC, données sur les brevets, téléchargement en vrac, dessin industriel, marques de commerce, propriété intellectuelle, inventeur, demandeur, classification CIB, revendications

Use for finding the Canadian patents of a company or inventor (party_name, a case-insensitive substring; party_type narrows to owner, inventor, applicant or agent), patents in a technology class (ipc like 'H01M', 'H01M 8' or 'H01M 8/04'), by title words (English or French), or by filing-date range. Filters combine with AND. Returns the newest matches by filing date and the total match count across all ~3.2 million records since 1869. Data is as of the latest quarterly release. Each filter type downloads its table once into a local cache on first use; the IPC table is ~740 MB and can take many minutes, so a first call may time out while the download continues in the background; retry later. Follow up with ised_ip_horizons_get_patent for parties and classes. lang has no effect.

Keywords

patent search, Canadian patents, patent owner, assignee, inventor, company patents, IPC classification, technology class, filing date, CIPO, IP Horizons, innovation

Mots-clés

recherche de brevets, brevets canadiens, titulaire, cessionnaire, inventeur, brevets d'une entreprise, classification CIB, domaine technologique, date de dépôt, OPIC, Horizons PI

Use for finding radio/wireless spectrum licence sites by licensee, service type, location, or frequency, out of ~840,000 records refreshed monthly. Filter with an ArcGIS SQL where clause on fields such as LICENSEE, SERVICE, PROV, TRANSMIT_FREQ, RECEIVE_FREQ, LATITUDE, LONGITUDE, STUCT_HT (structure/tower height), TX_PWR (transmit power).

Keywords

ISED, ISDE, spectrum, radio licence, wireless, telecommunications, frequency, licensee, transmitter, antenna, tower, Spectrum Management System, SMS

Mots-clés

ISDE, spectre, licence radio, sans fil, télécommunications, fréquence, titulaire de licence, émetteur, antenne, tour, Système de gestion du spectre, SGS

Use for getting the direct, official download URL for a specific published edition of a CMHC data table (e.g. October 2022 rather than the current default) - geography_id/edition_id come from cmhc_dt_get_table's geographies/editions lists; omit either to get the most recent edition / first geography option. Raises a clear error if the id is not one of that table's known options, rather than silently returning nothing.

Keywords

cmhc, housing, download link, excel file, data table, historical edition, geography, publication, direct link, xlsx

Mots-clés

schl, logement, lien de téléchargement, fichier excel, tableau de données, édition historique, géographie, publication, lien direct

Use for confirming what a table covers and which geography_id/ edition_id values cmhc_dt_get_download_url will accept for it, before requesting a specific historical edition or geography. slug comes from cmhc_dt_list_tables.

Keywords

cmhc, housing, data table, detail, description, geography, edition, publication date, document type, metadata

Mots-clés

schl, logement, tableau de données, détail, description, géographie, édition, date de publication, type de document, métadonnées

Use for browsing what official Excel table publications CMHC has for a topic, before fetching one table's detail or download link. category must be one of "rental-market", "household- characteristics", or "canadian-housing-survey-data-tables" (the last currently returns no tables - its own tables live elsewhere and are not yet mapped). Read docs://cmhc/well-known-categories for a sample of well-known table slugs in the first two categories.

Keywords

cmhc, housing, data tables, publications, excel, download, rental market, household characteristics, canadian housing survey, catalogue, list

Mots-clés

schl, logement, tableaux de données, publications, excel, téléchargement, marché locatif, caractéristiques des ménages, enquête canadienne sur le logement, catalogue, liste

Use for fetching actual CMHC Rental Market Survey vacancy rates/ rents, housing starts/completions, seniors' rental housing data, or any other category's numeric data - e.g. national historical rental vacancy rates by bedroom type, or current vacancy rates broken down by province. Pass row_field="TIMESERIES" for a historical time series (one row per period) or a province/centre-breakdown field from cmhc_get_table_options for a current cross-tabulation (one row per province/centre). Each returned cell carries CMHC's own reliability flag (a/b/c/d = Excellent/Very good/Good/Poor) alongside the value, value: 0 for a real, counted zero (flagged "-" by CMHC), or value: null with the raw marker in flag when data was suppressed ("**"/"n/a") or not applicable ("++") - see docs://cmhc/gotchas for the full legend. category_level_1/ category_level_2/column_field/row_field must come from cmhc_list_categories/cmhc_get_table_options first - an unrecognized combination raises a clear error rather than guessing. The result's available_filters lists extra narrowing dimensions this particular table supports beyond column_field/row_field (e.g. season: April/October, dwelling_type_desc_en: Row/Apartment for a Rental Market Survey table) - these genuinely change the returned values, not just a label; pass a subset as filters (e.g. {"dwelling_type_desc_en": "Row"}) on a follow-up call to narrow to just that slice. An unrecognized filter key/value raises a clear error rather than being silently ignored.

Keywords

cmhc, housing, hmip, rental market, vacancy rate, rent, average rent, housing starts, completions, time series, historical, data, table, province, bedroom type, reliability flag, filter, dwelling type, season

Mots-clés

schl, logement, pimh, marché locatif, taux d'inoccupation, loyer, loyer moyen, mises en chantier, achèvements, série chronologique, historique, données, tableau, province, type de chambre, indicateur de fiabilité, filtre, type de logement, saison

Use for finding which column_field/row_field pairs cmhc_get_table_data will accept for a given category (e.g. "Bedroom Type" vs "Year of Construction" as the column breakdown, "Historical Time Periods" for a time series vs "Provinces" for a current cross-tabulation) - a category/geography this doesn't return an option for will not resolve in cmhc_get_table_data either.

Keywords

cmhc, housing, hmip, table options, column field, row field, breakdown, bedroom type, time series, historical, provinces, discover

Mots-clés

schl, logement, pimh, options de tableau, champ colonne, champ ligne, répartition, type de chambre, série chronologique, historique, provinces, découvrir

Use for discovering what CMHC covers before requesting data - new housing construction (starts/completions), primary and secondary rental market (vacancy rates, rents), seniors' rental housing, population/households/housing stock, and core housing need. Read docs://cmhc/well-known-categories first - it already lists the common categories with their exact spelling. geography_type/geography_id default to "Country"/"1" (Canada); pass a province id from cmhc_list_provinces for province-level categories instead. Category names are language-dependent strings (not fixed codes) - the values this returns for lang="fr" must be passed back with lang="fr" to other cmhc_ tools.

Keywords

cmhc, housing, hmip, category, discover, rental market, vacancy rate, rent, housing starts, completions, seniors housing, core housing need, mortgage, corporation

Mots-clés

schl, logement, pimh, catégorie, découvrir, marché locatif, taux d'inoccupation, loyer, mises en chantier, achèvements, logements pour personnes âgées, besoins impérieux, hypothèque, société

Use for getting a geography_id (with geography_type="Province") to pass to cmhc_list_categories/cmhc_get_table_options/ cmhc_get_table_data for province-level data instead of national Canada-wide data. CMA/city-level geography is not yet supported by this module - only Canada and provinces.

Keywords

cmhc, housing, hmip, province, territory, geography, geography id, list, canada

Mots-clés

schl, logement, pimh, province, territoire, géographie, identifiant géographique, liste, canada

Use for the price at which the CDC buys and sells butter, set each year (usually effective February 1, sometimes mid-year such as May 2024 or September 2022) after its cost of production study and consultations. Each row keeps the published label ("2024 (May)", "2024 (mai)" with lang="fr") and an effective date. The CDC has not bought skim milk powder since 2017, so there is no powder support price. lang switches labels, notes and the linked page; values are identical in both languages.

Keywords

butter support price, support price, butter price, Canadian Dairy Commission, CDC, dairy policy, farm gate milk price, supply management

Mots-clés

prix de soutien du beurre, prix de soutien, prix du beurre, Commission canadienne du lait, CCL, politique laitière, prix du lait à la ferme, gestion de l'offre

Use for the price of milk components in classes 3(d) (restaurant pizza mozzarella), 4(a) (butter, powders), 4(m) (animal feed), and 5(a), 5(b), 5(c) (dairy ingredients for further processing and confectionery), from January 2002 to the latest announced month. year_from/year_to pick calendar years (default: the current year); milk_class filters one class ("5(a)", "5a", "3D"). Rows are sorted by month and class; a price the CDC does not set (0 or blank in its file) is None. For the butter support price use cdc_get_butter_support_prices; for class definitions, cdc_get_milk_classes. lang switches notes and the linked page.

Keywords

milk price, component pricing, special milk class, butterfat price, protein price, other solids, class 5, class 4(a), Canadian Dairy Commission, dairy ingredients, SMCPP

Mots-clés

prix du lait, prix des composants, classes spéciales, prix de la matière grasse, prix des protéines, autres solides, classe 5, classe 4(a), Commission canadienne du lait, ingrédients laitiers

Use for looking up what dairy products fall in classes 1 to 5 and their subclasses (1(a) fluid milk, 2(a) yogurt, 3(a)-3(d) cheeses, 4(a) butter and powders, 4(m) animal feed, 5(a)-5(c) ingredients for further processing), which provincial boards use to bill milk components. milk_class filters by class or prefix ("3", "3(c)", "4a"). lang="fr" returns the French product descriptions.

Keywords

milk class, harmonized milk classification, dairy product classes, class 1 fluid milk, cheese class, butter, yogurt, Canadian Dairy Commission

Mots-clés

classe de lait, classification harmonisée du lait, classes de produits laitiers, lait de consommation, crème, fromage, beurre, yogourt, Commission canadienne du lait

Use for the monthly total quota the CDC sets for Canada under the Canadian Milk Supply Management Committee, from January 2017 (the CDC publishes earlier years only by email request). Default: the latest year. Rows give year, month, kilograms of butterfat, the figure exactly as published and, for 2017-2018, the change from a year earlier. Notes flag months the pages omit (December 2018) and figures that are not valid numbers (March 2023). For actual farm production by province use cdc_query_market_data(dataset= "production"). lang switches notes and the linked pages.

Keywords

national milk production target, total quota, milk quota, butterfat, dairy production, supply management, CMSMC, Canadian Dairy Commission

Mots-clés

cible nationale de production laitière, quota total, quota de lait, matière grasse, production laitière, gestion de l'offre, CCGAL, Commission canadienne du lait

Use for seeing which dairy supply management data this server reaches (component prices, butter support price, national total quota, milk classes, production and milk class sales) and which tool returns each; and learning why provincial milk marketing boards (Dairy Farmers of Ontario, Les Producteurs de lait du Québec, Alberta Milk, BC Milk Marketing Board) and the national egg, chicken, turkey and hatching egg agencies have no tool (PDF only, captcha, or terms), with StatCan tables to use instead. No upstream call is made. lang="fr" returns French titles, notes and names (organizations without an official French name keep their own).

Keywords

Canadian Dairy Commission, CDC, dairy, supply management, marketing board, milk, quota, egg farmers, chicken farmers, turkey, catalogue

Mots-clés

Commission canadienne du lait, CCL, produits laitiers, gestion de l'offre, office de commercialisation, lait, quota, Producteurs de lait du Québec, producteurs d'œufs, producteurs de poulet, dindon, volaille, catalogue

Use for monthly farm milk production in litres by province (dataset="production", since January 2016); monthly milk sales by class and subclass for the ten provinces ("sales_p10") or the East and West pools ("sales_by_region", with region), since July 2020, as litres, kg and dollars of butterfat, protein and other solids (segment, e.g. "butterfat_revenue"); and farms shipping milk on August 1 by province ("farms"). Filters: province (two-letter code), milk_class ("4", "4A", "3(b)"), dates as YYYY, YYYY-MM or YYYY-MM-DD. Newest rows first, up to limit (max 5000). Revenue divided by kg sold gives an average price per kg. lang="fr" returns French labels (region "Est"/"Ouest" is accepted too).

Keywords

milk production, dairy sales, milk class sales, butterfat sales, dairy farms, P10, milk pool, Canadian Dairy Commission, provincial milk production

Mots-clés

production de lait, production laitière par province, ventes de produits laitiers, ventes par classe, ventes de matière grasse, fermes laitières, producteurs de lait, P10, mise en commun du lait, Commission canadienne du lait

Use for learning the dimension keys (e.g. 'province_territory', 'immigration_category_main_category', 'country_of_citizenship') and their exact values before filtering or grouping with ircc_monthly_query, and the first and last month covered (most tables run from January 2015 to the latest month). table_id comes from ircc_monthly_list_tables, e.g. 'ODP-PR-PT_IMMCAT'. Downloads the whole file (up to about 30 MB), cached for hours.

Keywords

IRCC table columns, dimensions, categories, province, country of citizenship, immigration category, coverage, codebook

Mots-clés

colonnes du tableau IRCC, dimensions, catégories, province, pays de citoyenneté, catégorie d'immigration, période couverte, dictionnaire de données

Use for finding the table to query for monthly counts of permanent residents (admissions by province, census metropolitan area, census subdivision, country of citizenship, immigration category, occupation, age, gender, French-speaking), Express Entry admissions and invited candidates, study permit holders (including by designated learning institution), work permit holders (TFWP, International Mobility Program, post-graduation work permits), transitions from temporary to permanent residence, and asylum claimants. query keeps tables whose id, title or dataset contain every word. Archived series (Syrian, Afghan, resettled refugees) are left out unless include_archived. Pass a table_id to ircc_monthly_describe_table, then ircc_monthly_query.

Keywords

immigration, permanent residents, admissions, newcomers, study permits, international students, work permits, temporary foreign workers, asylum claimants, refugees, IRCC monthly data

Mots-clés

immigration, résidents permanents, admissions, nouveaux arrivants, permis d'études, étudiants étrangers, permis de travail, travailleurs étrangers temporaires, demandeurs d'asile, réfugiés, données mensuelles d'IRCC

Use for monthly, quarterly or yearly counts of permanent residents, study and work permit holders, temporary-to-permanent transitions or asylum claimants, for a province, city (CMA or census subdivision), country of citizenship, immigration category or occupation. filters maps a dimension key to one value in English or French, e.g. {"province_territory": "Alberta"}. period sums to 'month', 'quarter' or 'year' (default: the table's finest). group_by lists the dimensions to keep; others are summed over (group_by=[] gives one total per period; omitted keeps every dimension). sort 'value_desc' ranks the largest groups (top countries); 'period' keeps the most recent limit rows in time order. Counts are rounded to 5 and 1-4 are suppressed ('--'), counted as 0 and reported per row in suppressed_cells, so sums are approximate. Tables overlap: the permanent resident tables are the same people cut by province, citizenship, age, gender, CMA or occupation, and Express Entry and French-speaking admissions are subsets of them, so total within one table and never add tables together.

Keywords

immigrants per month, permanent resident admissions by province, new permanent residents, international students by country, work permits by province, asylum claims, immigration trend, IRCC time series

Mots-clés

immigrants par mois, admissions de résidents permanents par province, nouveaux résidents permanents, étudiants étrangers par pays, permis de travail par province, demandes d'asile, tendance de l'immigration, série chronologique IRCC

Use for looking up a specific round found with ircc_list_express_entry_rounds, or a round number a user already knows. draw_number is a string, not an int: most rounds are plain numbers ("444"), but two rounds IRCC ran on the same day (2018-05-30) are published as "91a" and "91b" rather than separate sequential numbers.

Keywords

Express Entry, round, draw number, invitation, CRS cutoff, immigration, permanent residence, IRCC

Mots-clés

Entrée express, ronde, numéro de tirage, invitation, score limite SCG, immigration, résidence permanente, IRCC

Use for answering "what is the current CRS cutoff score" or "when was the last Express Entry draw" without knowing a draw number.

Keywords

Express Entry, latest round, current CRS cutoff, most recent draw, today, this week, immigration, permanent residence, IRCC

Mots-clés

Entrée express, dernière ronde, score limite SCG actuel, tirage le plus récent, aujourd'hui, cette semaine, immigration, résidence permanente, IRCC

Use for tracking CRS (Comprehensive Ranking System) cutoff score history, invitations issued per round, and candidate-pool score distribution over time. program filters by a case-insensitive substring match against the round's name and invited program(s), e.g. "Canadian Experience Class" or "Provincial Nominee". since (an ISO date) filters to rounds on or after that date. The upstream feed has no server-side filtering, so MapleStats fetches the full history once (cached for hours, since new rounds appear roughly weekly) and filters/limits locally.

Keywords

Express Entry, rounds of invitations, CRS, Comprehensive Ranking System, cutoff score, draw, invitations issued, immigration, permanent residence, Canadian Experience Class, Federal Skilled Worker, Provincial Nominee Program, category-based selection, IRCC

Mots-clés

Entrée express, rondes d'invitations, SCG, système de classement global, score limite, tirage, invitations émises, immigration, résidence permanente, catégorie de l'expérience canadienne, travailleurs qualifiés, programme des candidats des provinces, sélection fondée sur les catégories, IRCC

Use for reading the full text of a tender or award found by a search.

Keywords

CanadaBuys, notice detail, tender detail, award detail, reference number, solicitation, full description, procurement notice

Mots-clés

AchatsCanada, détail de l'avis, appel d'offres, avis d'attribution, numéro de référence, sollicitation, description complète, avis d'approvisionnement

Use for downloading the full CanadaBuys or pre-CanadaBuys (Buy and Sell) procurement history for research or bulk analysis.

Keywords

CanadaBuys, bulk download, legacy, Buy and Sell, historical tenders, historical awards, contract history, full dataset, CSV

Mots-clés

AchatsCanada, téléchargement en bloc, Achatsetventes, appels d'offres historiques, attributions historiques, historique des contrats, jeu de données complet, fichier CSV

Use for who won a government contract; which contracts a company has been awarded; how much a department spent on a procurement.

Keywords

CanadaBuys, contract award, award notice, supplier, vendor, winning bidder, contract value, federal spending, procurement, PSPC

Mots-clés

AchatsCanada, attribution de contrat, avis d'attribution, fournisseur, soumissionnaire retenu, valeur du contrat, dépenses fédérales, approvisionnement, marché public, SPAC

Use for historical federal contracts back to 2009; largest contracts a department signed; a company's federal contract history; sole-source (non-competitive) contracts and their justification.

Keywords

CanadaBuys, contract history, contracts awarded, federal contracts, supplier, vendor, sole source, non-competitive, amendment, contract value, government spending, PSPC

Mots-clés

AchatsCanada, historique des contrats, contrats octroyés, marchés fédéraux, fournisseur, fournisseur unique, non concurrentiel, modification, valeur du contrat, dépenses gouvernementales, SPAC

Use for finding open government contracts to bid on; listing what a department is currently buying; checking closing dates for a tender.

Keywords

CanadaBuys, tender, bid opportunity, RFP, RFQ, solicitation, procurement, government contract, PSPC, open tenders, closing date

Mots-clés

AchatsCanada, appel d'offres, occasion de soumission, demande de propositions, sollicitation, approvisionnement, marché public, SPAC, appels d'offres ouverts, date de clôture

Use for the values cgc_exports_query filters on (42 grain names including imported and 'US' grains, grades, elevator types PRIMARY, TERMINALS and CONTAINER, port regions, world regions, about 150 destination countries) and the months covered (January 2013 to the latest month, usually a few weeks behind). lang="fr" lists the French names ('R.P. de Chine', 'Silos Terminaux', 'Conteneurs').

Keywords

grain exports, destination countries, export markets, Canadian Grain Commission, licensed facilities, container exports, ports, wheat, canola

Mots-clés

exportations de grain, pays de destination, marchés d'exportation, Commission canadienne des grains, installations agréées, conteneurs, ports, céréales, blé, canola

Use for how much wheat, durum, canola, barley, oats, peas, lentils or soybeans Canada exported to China, Japan, the United States, Mexico or any other country, by month, calendar year or crop year (August to July), from licensed primary, terminal and container facilities, since January 2013. Filters take one value or a list (cgc_exports_describe lists them); region is the port region, elevator PRIMARY, TERMINALS or CONTAINER. With frequency 'month' and no group_by, rows are as published; otherwise values are summed per period over every column not in group_by (e.g. frequency='crop_year', group_by=['destination']), and months shows partial periods. Rows come in period order, largest first within a period; past limit the oldest periods are dropped. total_ktonnes sums every match. Thousands of tonnes. With lang="fr" names are French: elevator 'Silos des Prairies', 'Silos Terminaux' or 'Conteneurs', destination 'R.P. de Chine', 'Japon', 'États-Unis'; filters ignore case, accents, hyphens and spaces, and an unknown name lists the ones containing it.

Keywords

grain exports by country, canola exports to China, wheat exports, export destinations, monthly exports, crop year exports, Canadian Grain Commission, pulse exports, lentil exports, trade

Mots-clés

exportations de grain par pays, exportations de canola vers la Chine, exportations de blé, destinations d'exportation, exportations mensuelles, campagne agricole, Commission canadienne des grains, céréales, légumineuses, lentilles, commerce

Use for the first step before cgc_weekly_query: the weeks published so far (grain week and the Sunday it ends), and per worksheet its metrics, periods, grains, regions and grades. Worksheets: Primary (producer deliveries, shipments, stocks, condo storage by prairie province), Process (deliveries, shipments, milled grain and stocks at process elevators), Terminal Receipts, Terminal Exports, Terminal Stocks and Terminal Disposition (by port: Vancouver, Prince Rupert, Churchill, Thunder Bay, Bay & Lakes, St. Lawrence, and by grade), Primary Shipment Distribution, Feed Grains, Feed Grains Shipment Distribution, Producer Cars, Imported Grains, Summary (stocks by elevator type). crop_year is e.g. '2025-26' (August to July), from 2013-14; default: the latest. Values are thousands of tonnes. lang="fr" reads the French file: worksheet, metric, period, grain and region names are then French ('Silos primaires', 'Terminaux - exportations', 'Semaine en cours').

Keywords

Canadian Grain Commission, CGC, grain statistics weekly, GSW, crop year, grain handling, primary elevators, terminal elevators, grain stocks, canola, wheat

Mots-clés

Commission canadienne des grains, CCG, statistiques hebdomadaires sur le grain, campagne agricole, manutention du grain, silos primaires, silos terminaux, silos-élévateurs, stocks de grain, céréales, canola, blé

Use for producer deliveries of wheat, canola, barley, oats, peas or lentils to primary elevators by province; terminal exports and receipts by port (Vancouver, Prince Rupert, Thunder Bay, St. Lawrence) and grade; grain stocks in commercial storage; weekly or crop-year-to-date grain movement. worksheet is required (e.g. 'Primary', 'Terminal Exports', 'Summary'; cgc_weekly_describe lists them and their values). period is 'Current Week' (that week alone) or 'Crop Year' (to date). Filters take one value or a list. Omit group_by for the published rows; pass it (e.g. ['grain']) to sum the other columns per week, e.g. deliveries over all provinces; summing requires one metric and one period. latest_week_only keeps the newest week. Rows come in week order; past limit the latest are kept. Thousands of tonnes; rows without a region are national totals. From crop year 2013-14; updated each Thursday. With lang="fr" every name is French, e.g. worksheet 'Silos primaires', metric 'Livraisons', period 'Semaine en cours' or 'Campagne agricole', grain 'Blé', region 'Saskatchewan'; filters ignore case, accents, hyphens and spaces.

Keywords

grain deliveries, grain exports, grain stocks, primary elevator, terminal elevator, port of Vancouver, canola deliveries, wheat exports, crop year to date, thousand tonnes

Mots-clés

livraisons de grain, livraisons des producteurs, exportations de grain, stocks de grain, silo primaire, silo terminal, silo-élévateur, port de Vancouver, livraisons de canola, exportations de blé, céréales, orge, campagne agricole, milliers de tonnes

Use for confirming what a collection covers and which property names you can filter/sort/select by (e.g. province and alert_type for weather-alerts, STATION_NUMBER for hydrometric-realtime) before calling eccc_query_items - an unknown property name is silently ignored upstream and returns zero rows rather than an error, so checking here first avoids that trap.

Keywords

environment canada, eccc, msc, geomet, collection, detail, metadata, queryables, properties, schema, extent, bbox

Mots-clés

environnement canada, smc, geomet, collection, détail, métadonnées, propriétés interrogeables, schéma, étendue

Use for a full inventory scan. Prefer eccc_search_collections for a topic search, or docs://eccc/well-known-collections for the collections that matter most - this returns the entire catalogue, including many specialized downscaled-climate-projection families most callers will not need.

Keywords

environment canada, eccc, msc, geomet, weather, climate, list, inventory, all collections, catalogue, full list

Mots-clés

environnement canada, smc, geomet, météo, climat, liste, inventaire, toutes les collections, catalogue, liste complète

Use for fetching actual weather alerts, current surface observations (SWOB), AQHI readings/forecasts, climate normals or daily/hourly observations, hydrometric water level/flow, or any other MSC GeoMet collection's data - one generic query works across every collection (see docs://eccc/well-known-collections for good starting collection_id values and example filters). bbox is [west, south, east, north] in decimal degrees (WGS84). datetime_filter accepts a single RFC3339 datetime or an interval ("start/end", ".." for an open end) - support genuinely varies by collection and is not predictable from the collection's own metadata (confirmed: hydrometric-realtime supports it, weather-alerts does not and raises an error) - omit it and filter by filters/bbox instead if it fails. filters are exact-match property=value pairs (e.g. {"province": "ON"} or {"STATION_NUMBER": "05BL023"}) combined with AND. fields limits which properties come back (omit for all). sortby is a property name, prefixed with - for descending (e.g. "-publication_datetime"). limit is capped at 1000 per request - several collections here have hundreds of thousands of rows, so page with offset rather than requesting everything at once. Read docs://eccc/gotchas before relying on datetime_filter or on climate-stations' LATITUDE/LONGITUDE properties.

Keywords

environment canada, eccc, msc, geomet, weather alert, current conditions, swob, observation, aqhi, air quality, climate normal, hydrometric, water level, flow, marine forecast, query, data, filter, bbox, station

Mots-clés

environnement canada, smc, geomet, alerte météo, conditions actuelles, observation, cote air santé, qualité de l'air, normale climatique, hydrométrique, niveau d'eau, débit, prévision maritime, requête, données, filtre, station

Use for finding a collection id when you only know a topic - e.g. "alert", "aqhi", "climate normal", "hydrometric", "swob", "marine", "snowfall". Read docs://eccc/well-known-collections first - it already lists the collection ids that matter most, with example filters for each.

Keywords

environment canada, eccc, msc, geomet, weather, climate, collection, search, find, discover, dataset, catalogue

Mots-clés

environnement canada, smc, geomet, météo, climat, collection, recherche, trouver, découvrir, jeu de données, catalogue

Use for one account's monthly fee and how to waive it, included transactions, interest rate tiers, and the fees once included transactions run out: withdrawals (branch, ATM, other bank's ATM, abroad), transfers and Interac e-Transfers, overdraft protection, non-sufficient funds (NSF), debit purchases abroad, bill payments, cheque images and statements. product_id comes from fcac_search_bank_accounts; pass the same province, account_type, currency and groups used there, because the tool only opens an account from its result list. Every section is under sections.

Keywords

bank account fees, NSF fee, overdraft fee, ATM fee, e-Transfer fee, monthly fee waiver, minimum balance, savings interest rate, FCAC, chequing account

Mots-clés

frais de compte bancaire, frais d'insuffisance de fonds, chèque sans provision, frais de découvert, frais de guichet, frais de retrait, virement Interac, forfait bancaire, solde minimum, taux d'intérêt épargne, ACFC, compte-chèques

Use for one card's annual fees (first and additional card), purchase, cash advance and balance transfer interest rates, foreign currency conversion fee, minimum personal and household income, reward categories and how to redeem them, other benefits, and included insurance (travel medical, trip cancellation, rental car, and more). product_id comes from fcac_search_credit_cards; pass the same province, currency, student and secured values used there, because the tool only opens a card from its result list. Every section of the page is also returned under sections.

Keywords

credit card details, cash advance rate, balance transfer rate, foreign transaction fee, minimum income, card insurance, annual fee, FCAC, card benefits, rewards program

Mots-clés

détails de carte de crédit, taux d'avance de fonds, taux de transfert de solde, frais de conversion de devises, revenu minimum, assurance voyage, assurance carte, frais annuels, ACFC, avantages