Payload/API Response

The current API version returns a one-level JSON file that conforms to a simple tabular structure. The JSON files are similarly structured across all indicators but will conform to the indicator specific categories in the tables below.

The JSON file returned contains two components: data and meta . Data contains all variables, labels, and values associated with the LMI data. Meta contains information about the paginated response. The API has a limit of 1000 records per page, so pagnation is required by the API user for large responses.

Table of Payload Structure

Column Name	Data Type	Description	Indicator Category Inclusion
source	String	Name of data source (e.g., “LFS-RTRA”, “Vicinity Jobs”).	All
as_of_date	String	Date indicator of when the data was updated in the LMIC Data Hub. Standard format is: “YYYY-MM-DD”	All
ref_date	String	------	Work Requirements
date	String	Date indicator of reference period. First of the month is used for monthly data. Standard format is: “YYYY-MM-DD”	Standard and Job Postings
time_dimension	String	Indicates the frequency of the estimate. Possible values are “monthly”, “quarterly” and “annual”	Standard and Job Postings
country	String	Returns “Canada”	All
provinces_territories	String	Two-character province or territory code (e.g, “ON”, “QC”, “YT”). A NULL value indicates that the record is national.	All
cma	String	English/French name of Census Metropolitan Area. A NULL value indicates data are national, provincial/ territorial or for an economic region.	Standard Indicators
er	String	English/French name of Economic Region. A NULL value indicates data are national or provincial/ territorial level data.	All
census_division	String	English/French name for Census division. A NULL value indicates data are national, provincial/ territorial, or economic region level. If this value is not NULL the economic region value is also not NULL	Job Postings and Work Requirements
sex	String	English/French name of sex label related to the data. Not NULL for all records. Possible values are: “Both sexes”, “Males”, “Females”	Standard Indicators
age	String	English/French name of age label related to the data. Not NULL for all records. Examples: “15 years and over”; “15 to 24 years”	Standard Indicators
noc_level	Numeric	Occupation level of detail (1 to 4). Also includes the special values “-1” and “-2” indicating, respectively, unknown occupation and occupations known but too small to report independently are thus rolled up into an “Other” group. NULL values indicate observation is aggregated across all occupations. See NOC Structure for further details.	All
noc	String	Occupation code. NULL values indicate observation is aggregated across all occupations. See NOC Structure for further details.	All
noc_title	String	English/French name of title of occupational category.	All
naics_level	Numeric	Sector/industry level of detail (2 to 4)*. Also includes the special value “0” which indicates the occupational group is non-standard (such groupings appear only in certain CODR tables). NULL values indicate observation is aggregated across all sectors. See NAICS Structure for further details.	Standard Indicators
naics_title	String	English/French name of title of sector/industry category.	Standard Indicators
naics	String	Sector/ industry code. See NAICS Structure for further details.	Standard Indicators
seasonality_adjusted	String	English/French name of label for transformations applied to data. Default is “unadjusted”.	Indicators Standard
work_requirement	String	English/French name of label of work requirement items based on Vicinity Jobs’ taxonomy.	Work Requirements
indicator_name	String	English/French name of label for indicator, e.g., “Employment level”	All
indicator_value	Numeric	Numerical value of the indicator. Percentages formatted as a fraction of 100	All