Discover Tables

The CMHC client includes bundled metadata for common NLQ targets across starts, completions, under construction, vacancy, availability, rent, and rental universe tables.

Browse surveys

const surveys = client.listSurveys();
console.log(surveys);

Browse table structure

const series = client.listSeries('Rms');
 
const dimensions = client.listDimensions({
  survey: 'Rms',
  series: 'Vacancy Rate',
});
 
const breakdowns = client.listBreakdowns({
  survey: 'Rms',
  series: 'Vacancy Rate',
  dimension: 'Bedroom Type',
});

Inspect filters

const filters = client.listFilters({
  survey: 'Rms',
  series: 'Vacancy Rate',
  dimension: 'Bedroom Type',
  breakdown: 'Historical Time Periods',
});
 
console.log(filters);

Use discovery before export when your UI or planner needs to present valid options. If a supported CMHC portal table is not bundled yet, pass tableCode directly in the export request.

Browse surveys

Browse table structure

Inspect filters

On this page