Provides comprehensive metadata for every variable including labels, concepts (descriptions), predicate types, and the group they belong to. Variables include estimates (E), margins of error (M), and annotations (A/MA). Use this to find specific variable codes needed for data queries and understand what each variable represents.
From spec: Returns all available variables (data fields) for a specific dataset. Each variable includes a description, concept, and metadata. Variable codes ending in 'E' are estimates, 'M' are margins of error.
Usage Tips
- Variables ending in 'E' are estimates, 'M' are margins of error
- 'predicateType' indicates data type (int, float, string, fips-for/in)
- 'predicateOnly' variables like 'for' and 'in' are for geographic filtering only
- 'group' links variables to their parent table/group
- Variables starting with '_' like '_GEOCOMP' are internal fields
Parameters (2)
dataset(string, path, required)
Dataset path. Common values: 'acs/acs5' (ACS 5-year), 'acs/acs1' (ACS 1-year), 'dec/sf1' (Decennial Summary File 1), 'cbp' (County Business Patterns)
year(string, path, required)
Vintage (year) of the dataset. Examples: 2022, 2020, 2010
Constraints: {'pattern': '^\\d{4}$'}
Examples (2)
List all variables for 2022 ACS 5-Year dataprobe-gate
Demonstrates retrieving comprehensive variable metadata including labels, concepts, groups, and data types for all available data fields.