Returns working API query examples with valid parameter combinations for the specified dataset. Use this endpoint to understand the required and optional parameters for querying actual data, including geography specifications and available variables.
From spec: Returns example API queries and valid geography combinations for the dataset, useful for understanding how to construct requests.
Usage Tips
- The 'get' parameter lists variables that can be retrieved
- The 'fips' section shows available geographic levels and their required parent levels
- Example values use FIPS codes (e.g., '06' for California)
- Use wildcard '*' to retrieve all values for a geographic level
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)
Get example queries for 2022 ACS 5-Year dataprobe-gate
Demonstrates retrieving example API calls showing valid parameter combinations for the 2022 American Community Survey 5-year estimates dataset.