# Census Bureau The Census Bureau Data API provides developers with access to a wide range of statistical data collected by the U.S. Census Bureau, facilitating integration into applications and data visualizations. - **Category:** analytics - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 81 - **Triggers:** 0 - **Slug:** `CENSUS_BUREAU` - **Version:** 20260316_00 ## Tools ### Geocode Address **Slug:** `CENSUS_BUREAU_GEOCODE_ADDRESS` Tool to geocode a single address to get latitude/longitude coordinates. Use when you need to convert a street address into geographic coordinates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `address` | string | Yes | Full address as a single line. Include street number, street name, city, state, and ZIP code for best results. Example: '4600 Silver Hill Rd, Washington, DC 20233' | | `benchmark` | string ("Public_AR_Current" | "Public_AR_Census2020") | No | Address benchmark dataset to use for geocoding. 'Public_AR_Current' uses the current dataset (recommended for most use cases). 'Public_AR_Census2020' uses the Census 2020 benchmark. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Address for Census Geographies **Slug:** `CENSUS_BUREAU_GEOCODE_ADDRESS_GEOGRAPHIES` Geocode an address and return Census geography identifiers including state, county, tract, block group, and block FIPS codes. This tool converts a physical address into geographic coordinates and returns detailed Census geography information including FIPS codes for various geographic levels (state, county, census tract, block group, block) plus additional geographies like congressional districts, places, and statistical areas. Use this when you need to link an address to Census geographic identifiers for data analysis or geographic queries. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `format` | string | No | Response format. Must be 'json' for this action. | | `address` | string | Yes | Full address as a single line (e.g., '1600 Pennsylvania Avenue NW, Washington, DC 20500'). Include street address, city, state, and ZIP code for best results. | | `vintage` | string | No | Geography vintage to use for FIPS code lookup. Common values: 'Current_Current' (default, most recent), 'Census2020_Current', 'ACS2022_Current', 'ACS2023_Current', 'ACS2024_Current', 'ACS2025_Current'. | | `benchmark` | string | No | Address benchmark dataset to use for geocoding. Common values: 'Public_AR_Current' (default, most recent), 'Public_AR_Census2020', 'Public_AR_ACS2025'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Address Parts **Slug:** `CENSUS_BUREAU_GEOCODE_ADDRESS_PARTS` Tool to geocode an address using separate components (street, city, state, ZIP) to get latitude/longitude coordinates. Use when you have address data in separate fields rather than a single line. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `zip` | string | No | ZIP code (5 or 9 digits). Optional but improves geocoding accuracy. | | `city` | string | No | City name. Optional but recommended for accurate geocoding. | | `state` | string | No | State abbreviation (2 letters). Optional but recommended for accurate geocoding. | | `street` | string | Yes | Street address including street number and name. Example: '4600 Silver Hill Rd' | | `benchmark` | string ("Public_AR_Current" | "Public_AR_Census2020") | No | Address benchmark dataset to use for geocoding. 'Public_AR_Current' uses the current dataset (recommended for most use cases). 'Public_AR_Census2020' uses the Census 2020 benchmark. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Address with Geography **Slug:** `CENSUS_BUREAU_GEOCODE_ADDRESS_WITH_GEOGRAPHY` Tool to geocode an address and return both coordinates and Census geography information. Use when you need geographic coordinates plus Census geographic identifiers like state FIPS, county FIPS, census tract, and block codes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | No | City name. Helps improve match accuracy but optional if state and ZIP are provided. | | `state` | string | No | State abbreviation (2 letters). Example: 'DC', 'NY', 'CA'. Recommended for accurate matching. | | `layers` | string | No | Geographic layers to return. Use layer codes (e.g., '10' for Census Blocks), 'all' for all available layers, or comma-separated codes for multiple layers. Common layer codes: 8=Census Block Groups, 10=Census Blocks, 14=Census Tracts. If omitted, default layers (state, county, tract, block) are returned. | | `street` | string | Yes | Street address including number and street name. Example: '4600 Silver Hill Rd' | | `vintage` | string | No | Geography vintage to use. Determines which census geography boundaries are returned. 'Current_Current' uses the most recent geography (recommended). 'Census2020_Current' uses Census 2020 geography. | | `benchmark` | string | No | Address benchmark dataset to use for geocoding. 'Public_AR_Current' uses the current dataset (recommended for most use cases). 'Public_AR_Census2020' uses the Census 2020 benchmark. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Coordinates **Slug:** `CENSUS_BUREAU_GEOCODE_COORDINATES` Reverse geocode latitude/longitude coordinates to Census geographic areas. Takes decimal degree coordinates and returns associated Census geographies including states, counties, tracts, blocks, congressional districts, and other Census-defined geographic boundaries. Use this tool to identify what Census geographic areas a specific location falls within. Note: This uses the Census Geocoding Services API, which has a different base URL than the standard Census data API (uses geocoding.geo.census.gov). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `x` | number | Yes | Longitude in decimal degrees (e.g., -77.0369 for Washington DC). Valid range: -180 to 180. | | `y` | number | Yes | Latitude in decimal degrees (e.g., 38.9072 for Washington DC). Valid range: -90 to 90. | | `format` | string ("json") | No | Output format for the response. Defaults to 'json'. Other options: 'jsonp', 'html'. | | `layers` | string | No | Comma-separated layer IDs to filter results (e.g., '8,12,84' for specific geographic levels). If not specified, returns all available layers including States, Counties, Tracts, Blocks, Congressional Districts, and more. | | `vintage` | string ("4" | "410" | "417" | "418" | "419" | "420" | "421" | "422" | "423" | "424" | "425") | No | Geography vintage identifier. Use '4' (Current_Current) for the most current vintage. Other options include ACS and Census vintages from different years. | | `benchmark` | string ("4" | "8" | "2020") | No | Benchmark version identifier. Use '4' (Public_AR_Current) for the most current benchmark. Other options: '8' (Public_AR_ACS2025), '2020' (Public_AR_Census2020). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Puerto Rico Address with Geography **Slug:** `CENSUS_BUREAU_GEOCODE_GEOGRAPHIES_ADDRESS_PR` Tool to geocode a Puerto Rico address and return coordinates plus Census geography data. Use for Puerto Rico addresses when you need geographic coordinates and Census identifiers like state, county, tract, and block codes. Supports urbanization names specific to Puerto Rico addressing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `urb` | string | No | Urbanization name for Puerto Rico addresses. Required with municipio for addresses with Urbanization. | | `zip` | string | No | ZIP code for Puerto Rico (must begin with 006, 007, or 009). Optional but improves accuracy. | | `city` | string | No | City name. Alternative to urb+municipio. Optional but recommended for accurate matching. | | `state` | string | No | State code (PR for Puerto Rico). Optional but recommended. | | `layers` | string | No | Geographic layers to return. Use layer codes (e.g., '10' for Census Blocks), 'all' for all available layers, or comma-separated codes for multiple layers. Common layer codes: 8=Census Block Groups, 10=Census Blocks, 14=Census Tracts. If omitted, default layers are returned. | | `street` | string | Yes | Street address including number and street name. Example: '1 Calle Fortaleza' | | `vintage` | string | No | Geographic vintage identifier. Determines which census geography boundaries are returned. 'Current_Current' uses the most recent geography (recommended). Can also use numeric ID like '4'. Must match benchmark spatially. | | `benchmark` | string | No | Benchmark identifier for address dataset. 'Public_AR_Current' uses the current dataset (recommended). 'Public_AR_Census2020' uses Census 2020 benchmark. Can also use numeric ID like '4'. | | `municipio` | string | No | Municipio name for Puerto Rico. Required with urb for addresses with Urbanization. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Batch Geocode Addresses with Geographies **Slug:** `CENSUS_BUREAU_GEOCODE_GEOGRAPHIES_BATCH` Batch geocode multiple addresses from a CSV file and return Census geography codes. Tool to geocode up to 10,000 addresses at once from a CSV file. Use when you need to convert addresses to geographic coordinates (latitude/longitude) and retrieve associated Census geography identifiers (state, county, tract, block FIPS codes). Input CSV format: Unique ID, Street address, City, State, ZIP Returns: Original data plus match status, coordinates, and geographic codes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `vintage` | string ("Current_Current" | "ACS2025_Current" | "ACS2024_Current" | "ACS2023_Current" | "ACS2022_Current" | "ACS2021_Current" | "Census2020_Current" | "Census2010_Current") | No | Geography vintage for FIPS codes and census geographies. Determines which geography boundaries are used. Use 'Current_Current' for the most current geography boundaries. | | `benchmark` | string ("Public_AR_Current" | "Public_AR_ACS2025" | "Public_AR_Census2020") | No | Address benchmark version to use for geocoding. Determines which address reference dataset is used. Use 'Public_AR_Current' for the most current addresses. | | `address_file` | object | Yes | CSV file containing addresses to geocode (up to 10,000 records). Format: Each line must contain 5 comma-separated fields: Unique ID, Street address, City, State, ZIP. Example row: 1,1600 Pennsylvania Avenue NW,Washington,DC,20500 | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Geocode Puerto Rico Address **Slug:** `CENSUS_BUREAU_GEOCODE_LOCATION_ADDRESS_PR` Tool to geocode a Puerto Rico address with urbanization to latitude/longitude coordinates. Use when geocoding addresses in Puerto Rico that include urbanization or municipio components. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `urb` | string | No | Urbanization name. Optional Puerto Rico-specific address component. | | `zip` | string | No | ZIP code with 006, 007, or 009 prefix. Optional but improves geocoding accuracy. | | `city` | string | No | City name. Optional but recommended for accurate geocoding. | | `state` | string | No | State abbreviation (must be 'PR' for Puerto Rico). Optional but recommended. | | `street` | string | Yes | Street address including street number and name. Required for Puerto Rico address geocoding. | | `benchmark` | string ("Public_AR_Current" | "Public_AR_Census2020") | No | Address benchmark dataset to use for geocoding. 'Public_AR_Current' uses the current dataset (recommended for most use cases). 'Public_AR_Census2020' uses the Census 2020 benchmark. | | `municipio` | string | No | Municipio name. Optional Puerto Rico-specific administrative division. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ACS 1-Year Estimates **Slug:** `CENSUS_BUREAU_GET_ACS1_YEAR_ESTIMATES` Tool to retrieve 1-year American Community Survey (ACS) estimates for a specified geography. Use when you need the most recent annual ACS data for a given area. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries. Required when querying sub-geographies like counties or tracts. Example: Use 'state:06' in 'in' when querying 'county:*' in 'for' to get all counties in California. | | `for` | string | Yes | Geography filter in 'type:code' format specifying the area to query. Use 'state:06' for California, 'us:1' for nationwide, 'state:*' for all states, 'county:*' for all counties (requires 'in' parameter). FIPS codes: CA=06, NY=36, TX=48, FL=12. | | `get` | string | Yes | Comma-separated list of variables or group specifiers to retrieve. Include 'NAME' to get geographic area names. Examples: 'NAME,B01001_001E' for total population from detailed tables, 'group(B01001)' for all variables in B01001 table, 'NAME,S0101_C01_001E' for subject table variable. | | `year` | integer | No | The year of ACS 1-year estimates to retrieve. ACS 1-year data is available from 2005 to 2024. Default is 2023. | | `table_type` | string ("detailed" | "subject" | "profile" | "cprofile") | No | The type of table to query. 'detailed' for detailed tables (B-tables like B01001), 'subject' for subject tables (S-tables like S0101), 'profile' for data profiles (DP-tables like DP02), 'cprofile' for comparison profiles (CP-tables like CP05). Default is 'detailed'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get ACS 5-Year Estimates **Slug:** `CENSUS_BUREAU_GET_ACS5_YEAR_ESTIMATES` Retrieve 5-year American Community Survey (ACS) estimates from the U.S. Census Bureau. The ACS 5-year estimates provide reliable data for all geographic areas by combining 5 years of survey data. Use this tool to get population demographics, income statistics, housing characteristics, and other socioeconomic data at various geographic levels (nation, state, county, tract, place, metro area, etc.). Returns data as a list of rows where the first row contains column headers (variable names and geography identifiers) and subsequent rows contain the data values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `year` | integer | Yes | Year of the ACS 5-year data release (2009-2023). The 5-year estimates combine data from 5 consecutive years ending in the specified year. | | `geo_in` | string | No | Parent geography filter using 'geography_type:code' format. Required when querying sub-state geographies like counties or tracts. Examples: 'state:06' (for counties in California), 'state:25 county:017' (for tracts in Middlesex County, MA). | | `geo_for` | string | Yes | Target geography using 'geography_type:code' format. Use '*' for all areas. Common types: 'us:1' (nation), 'state:*' (all states), 'state:06' (California), 'county:*' (all counties), 'tract:*' (census tracts), 'place:*' (cities/towns), 'metropolitan statistical area/micropolitan statistical area:*' (metro areas). Malformed geography syntax can silently return empty or mis-aggregated results without raising an error; verify NAME fields and record counts match expectations after each query. | | `variables` | string | Yes | Comma-separated ACS variable codes or table groups. Common variables: B01001_001E (total population), B19013_001E (median household income), B25001_001E (housing units). Use 'NAME' to include geography names. Use 'group(TABLE)' syntax (e.g., 'group(B01001)') to retrieve all variables in a table. Using 'group(TABLE)' retrieves all variables in a table and can produce very wide responses; request only needed variable codes when possible. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Community Resilience Estimates **Slug:** `CENSUS_BUREAU_GET_COMMUNITY_RESILIENCE_ESTIMATES` Retrieve U.S. Census Bureau Community Resilience Estimates (CRE) data. The CRE measures social vulnerability to disasters by estimating the number of individuals with risk factors (e.g., income, disability, housing) that may limit their capacity to absorb, recover from, and respond to the impacts of disasters. Key variables: - PRED0_E: Estimated persons with 0 risk factors (most resilient) - PRED12_E: Estimated persons with 1-2 risk factors - PRED3_E: Estimated persons with 3+ risk factors (most vulnerable) - POPUNI: Total population universe - Variables ending in _M are margins of error for the corresponding estimates Available for years 2019, 2021, 2022, 2023 at state and county levels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | Yes | Geographic filter specifying the geography level and FIPS code. Format: 'geography_type:code'. Supported types: state, county. Use '*' for all geographies of that type. Examples: 'state:06' (California), 'state:*' (all states), 'county:*' (all counties). | | `get` | string | Yes | Comma-separated list of CRE variables to retrieve. Common variables include: NAME (geography name), POPUNI (population universe), PRED0_E/PRED0_M (estimate/margin of error for persons with 0 risk factors), PRED12_E/PRED12_M (persons with 1-2 risk factors), PRED3_E/PRED3_M (persons with 3+ risk factors). Example: 'NAME,PRED12_E,PRED3_E,POPUNI' | | `key` | string | No | Census API key. If omitted, the default key from connection metadata will be used. | | `year` | integer ("2019" | "2021" | "2022" | "2023") | Yes | Year of the Community Resilience Estimates (CRE) dataset. Available years: 2019, 2021, 2022, 2023. Note: 2020 data is not available. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get County Business Patterns **Slug:** `CENSUS_BUREAU_GET_COUNTY_BUSINESS_PATTERNS` Tool to retrieve County Business Patterns (CBP) data for a specified year. Use when you need county-level business establishment and employment statistics filtered by industry and geography. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography constraint, required when 'for' is county-level. Format: 'state:XX' where XX is the 2-digit FIPS code. Examples: 'state:06' (California), 'state:36' (New York), 'state:48' (Texas). | | `for` | string | Yes | Geographic level to retrieve. Use 'us:*' for national total, 'state:XX' for a specific state (e.g., 'state:06' for California), 'county:XXX' for a specific county (requires 'in' parameter for state), 'county:*' for all counties in a state. | | `get` | string | Yes | Comma-separated list of fields to retrieve. Common fields: EMP (employment), ESTAB (establishments), PAYANN (annual payroll in $1000s), PAYQTR1 (first quarter payroll), NAME (geography name), NAICS2017_LABEL (industry name), EMPSZES (employment size class), EMPSZES_LABEL (size class description). | | `key` | string | No | API key for higher rate limits | | `year` | integer | Yes | CBP data year. Available years: 1986-2023. Recent years have more complete data. | | `NAICS2017` | string | No | Filter by 2017 NAICS industry code. Examples: '31-33' (Manufacturing), '44-45' (Retail Trade), '72' (Accommodation and Food Services), '54' (Professional Services). Use 2-6 digit codes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Examples HTML **Slug:** `CENSUS_BUREAU_GET_DATASET_EXAMPLES_HTML` Tool to retrieve example queries for a Census dataset in HTML format. Use when you need to see example API queries for different geographic levels and hierarchies within a specific dataset. The response contains an HTML table with example queries showing how to request data at various geographic levels (nation, state, county, tract, place, metropolitan areas, etc.). Each example includes the geography hierarchy, level, and a working example URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `dataset` | string | Yes | The dataset identifier path (e.g., 'acs/acs5', 'acs/acs1', 'dec/pl'). Identifies which Census dataset to retrieve examples for. | | `vintage` | string | Yes | The year of the dataset (e.g., '2019', '2020', '2021'). Specifies the data vintage year. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Examples JSON **Slug:** `CENSUS_BUREAU_GET_DATASET_EXAMPLES_JSON` Tool to retrieve example API query patterns for a specific Census dataset and vintage. Use when you need to understand available geography levels, example variable names, and how to structure queries for a dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `dataset` | string | Yes | The dataset path segment (e.g., 'acs/acs5', 'acs/acs1', 'pep/population'). Use forward slashes to separate dataset hierarchy levels. | | `vintage` | string | Yes | The reference year of the data (e.g., '2019', '2020'). This is the year or time period the dataset covers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Examples (XML) **Slug:** `CENSUS_BUREAU_GET_DATASET_EXAMPLES_XML` Tool to retrieve example queries for a Census Bureau dataset in XML format. Use when you need to understand how to query a specific dataset or see sample API calls. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The dataset identifier, can be multi-part like 'acs/acs1' for ACS 1-Year estimates, 'acs/acs5' for ACS 5-Year estimates, or 'dec/sf1' for Decennial Census Summary File 1. The format is typically 'survey/product'. | | `vintage` | string | Yes | The year of the dataset (e.g., '2019', '2020', '2021'). Must be a four-digit year string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Geography HTML **Slug:** `CENSUS_BUREAU_GET_DATASET_GEOGRAPHY_HTML` Tool to retrieve available geographies for a Census dataset in HTML format. Use when you need to see which geographic levels (state, county, tract, etc.) and hierarchies are available for a specific Census dataset and year. The response is an HTML page containing a table with geography level codes, hierarchies, and reference dates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The dataset identifier, which may include multiple path segments separated by forward slashes (e.g., 'acs/acs5' for ACS 5-year estimates, 'acs/acs1' for ACS 1-year estimates, 'dec/pl' for Decennial Census PL 94-171). | | `vintage` | string | Yes | The year of the dataset (e.g., '2023', '2020', '2019'). Must be a four-digit year string. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Geography JSON **Slug:** `CENSUS_BUREAU_GET_DATASET_GEOGRAPHY_JSON` Tool to get the list of supported geography levels for a specific Census dataset with their hierarchy and required predicates. Use when you need to discover which geographic areas are available for querying a dataset and what predicates are required. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | | `dataset` | string | Yes | Dataset path identifying the specific Census dataset. Format varies by dataset type. Examples: 'pep/charagegroups' (Population Estimates), 'acs/acs5' (American Community Survey 5-year), 'dec/pl' (Decennial Census). Use forward slashes to separate dataset components. | | `vintage` | string | Yes | Data year as a string. This represents the year of the Census dataset you want to query. Examples: '2019', '2020', '2021'. Different vintages support different datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Geography XML **Slug:** `CENSUS_BUREAU_GET_DATASET_GEOGRAPHY_XML` Tool to retrieve available geographies for a Census Bureau dataset in XML format. Use when you need to discover which geographic levels (state, county, tract, etc.) are supported for a specific dataset vintage. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | Dataset identifier path (e.g., 'acs/acs1' for ACS 1-year, 'acs/acs5' for ACS 5-year, 'dec/pl' for Decennial PL94-171). | | `vintage` | string | Yes | Year of the dataset (e.g., '2019', '2020', '2021'). This is the data vintage for the Census dataset. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Groups **Slug:** `CENSUS_BUREAU_GET_DATASET_GROUPS` Tool to retrieve the list of table groups for a Census dataset and vintage. Use when you need to discover available data tables or before querying all variables in a table using group() syntax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The dataset path, e.g., 'acs/acs1' for ACS 1-year estimates or 'acs/acs5' for ACS 5-year estimates. | | `vintage` | string | Yes | The reference year of the data, e.g., '2019' or '2020'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Sorts **Slug:** `CENSUS_BUREAU_GET_DATASET_SORTS` Tool to list available sort options for a specific Census dataset and vintage. Use when you need to determine which fields can be used to sort query results. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, default key from metadata will be used. | | `dataset` | string | Yes | Dataset path segment, e.g., 'acs/acs5' or 'acs/acs1'. | | `vintage` | string | Yes | The reference year of the data, e.g., '2019' or '2020'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Tags **Slug:** `CENSUS_BUREAU_GET_DATASET_TAGS` Tool to list available tags/keywords for a specific Census dataset and vintage. Use when you need to discover topic categories, demographic dimensions, or searchable keywords available in a dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The dataset path segment (e.g., 'acs/acs5', 'acs/acs1', 'dec/pl'). | | `vintage` | string | Yes | The reference year of the dataset (e.g., '2022', '2021'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dataset Variables JSON **Slug:** `CENSUS_BUREAU_GET_DATASET_VARIABLES_JSON` Tool to retrieve the complete list of available variables for a specific Census dataset. Use when you need to discover what variables are available in a dataset, their names, labels, data types, and valid values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | Dataset path segment identifying the specific dataset, e.g., 'acs/acs5' for ACS 5-year estimates, 'acs/acs1' for ACS 1-year estimates, or 'pep/population' for population estimates. | | `vintage` | string | Yes | Data year or vintage for the dataset, e.g., '2021' or '2019'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Decennial Census Data **Slug:** `CENSUS_BUREAU_GET_DECENNIAL_CENSUS_DATA` Retrieve Decennial Census data (population, demographics, housing) from the U.S. Census Bureau API. Use this tool to get census statistics for states, counties, tracts, and other geographic units. The Decennial Census is conducted every 10 years (2020, 2010, 2000). Different datasets contain different variables - use 'dhc' for 2020 demographic data, 'sf1' for 2010/2000 summary data, 'pl' for redistricting data across all vintages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `get` | string | Yes | Comma-separated list of variables to retrieve. Variable names differ by dataset and vintage. For 2020 DHC use 'P1_001N' for total population; for 2010 SF1 use 'P001001'. Include 'NAME' to get geographic names. | | `key` | string | No | Census API key for authentication. If not provided, uses the default configured key. | | `dataset` | string | Yes | Dataset identifier. For 2020: 'dhc' (Demographic and Housing Characteristics), 'pl' (Redistricting Data), 'dp' (Demographic Profile), 'sdhc' (Supplemental DHC). For 2010/2000: 'sf1' (Summary File 1), 'sf2' (Summary File 2), 'pl' (Redistricting Data). | | `vintage` | string | Yes | Decennial census vintage year. Supported values: '2020', '2010', '2000'. | | `geography` | string | Yes | Geography specifier in format 'geography_type:value'. Use '*' for all geographies of that type. Examples: 'state:*' (all states), 'state:06' (California), 'county:*' (all counties within 'in_geography'). | | `in_geography` | string | No | Parent geography filter (maps to Census API 'in' parameter). Required when requesting sub-state geographies like counties or tracts. Example: 'state:06' to get all counties in California. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Planning Database Data **Slug:** `CENSUS_BUREAU_GET_PLANNING_DATABASE_DATA` Get Planning Database (PDB) data containing Census tract and block group level data useful for planning. Use this tool to retrieve demographic and operational data from the Planning Database including population estimates, ACS statistics, and 2020 Census operational variables at tract, block group, or state-county levels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Optional parent geography filter for nested queries. Required when querying specific tracts or block groups. Format: '{parent_geography}:{code}' or '{parent1}:{code1}+{parent2}:{code2}' for multiple levels. Examples: 'state:01' (Alabama), 'state:01 county:001' (Autauga County, Alabama), 'state:01+county:001+tract:020100'. | | `for` | string | Yes | Geographic area predicate specifying the geography level and codes. Required by the Census API. Format: '{geography}:{codes}'. Use '*' for all areas at that level. Examples: 'tract:*' (all tracts), 'tract:020100' (specific tract), 'block group:*' (all block groups). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables include: 'NAME' (geography name), 'Tot_Population_ACS_17_21' (total population from ACS), 'County_name' (county name), 'State_name' (state name), 'Tot_Population_ACSMOE_17_21' (margin of error). Check api.census.gov/data/{vintage}/pdb/{geography}/variables.html for the complete variable list. | | `vintage` | integer | Yes | Reference year for the Planning Database data (2015-2024). Each vintage contains tract and block group level data useful for planning operations. | | `geography` | string ("tract" | "blockgroup" | "statecounty") | Yes | Geography level for the query. Options: 'tract' (Census tracts), 'blockgroup' (block groups), 'statecounty' (state-county level). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Population Estimates **Slug:** `CENSUS_BUREAU_GET_POPULATION_ESTIMATES` Retrieves Population Estimates Program (PEP) data from the US Census Bureau API. Use this tool when you need: - Total population estimates for states, counties, or the nation - Components of population change (births, deaths, migration) - Population by demographic characteristics (age, sex, race, Hispanic origin) Response is a 2D array where index 0 is the header row (e.g., [['POP','NAME','state'],['39512223','California','06'],...]); always use row 0 as column keys when parsing. Important notes: - Available datasets and variables vary significantly by vintage year - For broadest compatibility, use vintage=2019 with dataset='population' - Variable names may include year suffixes in newer vintages (e.g., POP_2021 instead of POP) - Check Census API documentation for valid variable names per vintage/dataset #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | Yes | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Examples: 'state:*' (all states), 'state:06' (California), 'state:01,02,04' (multiple states), 'county:*' (all counties), 'us:*' (national level). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Variable names differ by vintage and dataset. For vintage 2019 population: 'POP,NAME' (total population). For vintage 2019 components: 'BIRTHS,DEATHS,NATURALINC,DOMESTICMIG,INTERNATIONALMIG,NETMIG'. For vintage 2019 charagegroups: 'POP,AGEGROUP,SEX'. For vintage 2021 population: 'POP_2021,NAME,DENSITY_2021' (note year suffix). For vintage 2023 charv: 'POP,NAME,SEX,AGE'. Check api.census.gov/data/{vintage}/pep/{dataset}/variables.html for full variable lists. | | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | | `dataset` | string | Yes | PEP dataset name. Available datasets vary by vintage: For vintage 2019: 'population', 'components', 'charagegroups', 'charage', 'housing', 'natmonthly'. For vintage 2021: 'population', 'natmonthly'. For vintage 2023: 'charv'. Use 'population' with vintage 2019 for simple population data. | | `vintage` | integer | Yes | Year of the data vintage. Available vintages vary by dataset. Common vintages: 2019 (most datasets available), 2021 (population, natmonthly), 2023 (charv only). Use 2019 for broadest dataset compatibility. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get TIGERweb ACS Generalized Boundaries **Slug:** `CENSUS_BUREAU_GET_TIGERWEB_ACS_GENERALIZED` Tool to access generalized ACS (American Community Survey) boundary services from TIGERweb for specific survey years (2012-2024). Use when you need to retrieve geographic boundary information and metadata for various Census geographies like states, counties, tracts, places, or other administrative areas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `f` | string ("json" | "html" | "kmz") | No | Response format. Options: json (returns JSON metadata), html (returns HTML page), kmz (returns KMZ file). | | `year` | string ("2012" | "2015" | "2016" | "2017" | "2018" | "2019" | "2021" | "2022" | "2023" | "2024") | Yes | ACS year (2012-2024). Available years: 2012, 2015, 2016, 2017, 2018, 2019, 2021, 2022, 2023, 2024. | | `service` | string ("AIANNHA" | "Region_Division" | "Tracts_Blocks" | "Legislative" | "CBSA" | "Places_CouSub_ConCity_SubMCD" | "School" | "State_County" | "TribalTracts") | Yes | Service name within ACS vintage. Valid options: AIANNHA (American Indian/Alaska Native Areas), Region_Division (Census Regions and Divisions), Tracts_Blocks (Census Tracts and Block Groups), Legislative (Legislative Districts), CBSA (Core Based Statistical Areas), Places_CouSub_ConCity_SubMCD (Places, County Subdivisions, Consolidated Cities, Subminor Civil Divisions), School (School Districts), State_County (States and Counties), TribalTracts (Tribal Census Tracts). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get TIGERweb Map Service Metadata **Slug:** `CENSUS_BUREAU_GET_TIGERWEB_MAP_SERVICE` Tool to retrieve TIGERweb MapServer service metadata including available layers, capabilities, and spatial reference information. Use when you need to discover available geographic layers before querying specific data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `f` | string ("json" | "pjson") | No | Response format. 'json' returns standard JSON, 'pjson' returns prettified JSON (for debugging). | | `service` | string | No | TIGERweb service name to retrieve metadata for. Common services: 'tigerWMS_Current' (current vintage with 90+ layers), 'State_County', 'Tracts_Blocks', 'Urban_Areas', 'Legislative', 'PUMA_TAD_TAZ'. The tigerWMS_Current service contains comprehensive geographic layers including states, counties, tracts, blocks, tribal areas, and school districts. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Examples HTML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_EXAMPLES_HTML` Tool to retrieve HTML-formatted example queries for a Census Bureau timeseries dataset. Use when you need to discover valid API query patterns and parameters for a specific timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The timeseries dataset identifier (e.g., 'intltrade/exports/hs', 'qwi/sa', 'poverty/saipe', 'healthins/sahie', 'bds', 'hps', 'eits/resconst', 'idb/1year'). Use the /data/timeseries.html endpoint to discover available datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Examples JSON **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_EXAMPLES_JSON` Tool to get example queries for a timeseries dataset in JSON format. Use when you need to discover example query patterns and available parameters for a specific Census Bureau timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, default key from metadata will be used. | | `dataset` | string | Yes | The timeseries dataset identifier. Examples: eits/resconst, qwi/sa, healthins/sahie, intltrade/exports/enduse, intltrade/imports/enduse, poverty/saipe, bds, hps | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Examples XML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_EXAMPLES_XML` Tool to retrieve example queries for a Census Bureau timeseries dataset in XML format. Use when you need to understand available variables, predicates, and geography options for a specific timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `dataset` | string | Yes | The timeseries dataset identifier (e.g., 'eits/resconst' for residential construction, 'intltrade/exports/hs' for international trade exports, 'poverty/saipe' for Small Area Income and Poverty Estimates, 'qwi/sa' for Quarterly Workforce Indicators, 'bds' for Business Dynamics Statistics, 'hps' for Household Pulse Survey). List of available datasets at https://api.census.gov/data/timeseries.json | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Geography HTML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_GEOGRAPHY_HTML` Tool to retrieve available FIPS geographies for a timeseries dataset in HTML format. Use when you need to understand which geography levels, hierarchies, and FIPS codes are available for querying a specific timeseries dataset. Returns an HTML document with a table showing reference dates, geography levels, hierarchies, and record limits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | | `dataset` | string | Yes | The timeseries dataset identifier. Common datasets include: 'qwi/sa' (Quarterly Workforce Indicators), 'healthins/sahie' (Small Area Health Insurance Estimates), 'poverty/saipe' (Small Area Income and Poverty Estimates), 'bds/firms' (Business Dynamics Statistics), 'intltrade/exports/hs' (International Trade Exports). The dataset path may contain forward slashes to specify subcategories. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Geography JSON **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_GEOGRAPHY_JSON` Tool to get available geographies for a timeseries dataset in JSON format. Returns FIPS geography levels, display codes, and reference dates for the specified dataset. Use this when you need to determine which geography levels can be queried for a given timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The timeseries dataset identifier (e.g., 'hps', 'bds', 'qwi/sa', 'poverty/saipe', 'intltrade/exports/hs'). Can be found by querying /data/timeseries.json to see available timeseries datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Geography XML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_GEOGRAPHY_XML` Tool to retrieve available geographies for a Census Bureau timeseries dataset in XML format. Use when you need to discover which geographic levels are supported for a specific timeseries dataset and understand the hierarchical dependencies between geography types. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `dataset` | string | Yes | The timeseries dataset identifier using path notation. Common datasets: 'poverty/saipe' (Small Area Income & Poverty Estimates), 'qwi/sa' (Quarterly Workforce Indicators), 'healthins/sahie' (Small Area Health Insurance), 'intltrade/exports/hs' (International Trade Exports), 'eits/resconst' (Economic Indicators - Residential Construction). Check https://api.census.gov/data.html for full list of available timeseries datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Variables HTML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_VARIABLES_HTML` Tool to retrieve a list of available variables for a Census timeseries dataset in HTML format. Use when you need to discover what data fields are available for a specific timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, uses the configured key from metadata. | | `dataset` | string | Yes | The timeseries dataset identifier. Common examples: 'eits/resconst' (residential construction), 'eits/ressales' (residential sales), 'intltrade/exports/enduse' (international trade exports), 'poverty/saipe' (poverty estimates), 'qwi/sa' (quarterly workforce indicators), 'healthins/sahie' (health insurance), 'bds' (business dynamics statistics), 'hps' (household pulse survey), 'idb/1year' (international database). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Variables JSON **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_VARIABLES_JSON` Tool to get a list of variables available for a timeseries dataset in JSON format. Use when you need to discover which variables are available for querying in a specific Census Bureau timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, default key from metadata will be used. | | `dataset` | string | Yes | The timeseries dataset path (e.g., 'intltrade/exports/hs', 'eits/resconst', 'qwi/sa', 'poverty/saipe'). Available datasets can be found at https://api.census.gov/data/timeseries.html | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Timeseries Variables XML **Slug:** `CENSUS_BUREAU_GET_TIMESERIES_VARIABLES_XML` Tool to get a list of variables available for a timeseries dataset in XML format. Use when you need the variable definitions, data types, and valid values for a specific timeseries dataset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataset` | string | Yes | The timeseries dataset identifier (e.g., 'healthins/sahie', 'intltrade/exports/enduse', 'eits/qtax'). Use the /data/timeseries.json endpoint to get a list of available datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Variable Details **Slug:** `CENSUS_BUREAU_GET_VARIABLE_DETAILS` Tool to retrieve metadata for a specific variable in a Census dataset for a given year. Use when you need the label, concept, data type, attribute codes, and valid-value constraints. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, default key from metadata will be used. | | `year` | integer | Yes | Four-digit data vintage year, e.g., 2019. | | `dataset` | string | Yes | Dataset path segment, e.g., 'acs/acs1' or 'acs/acs5'. | | `variable` | string | Yes | Variable identifier, e.g., 'B01001_001E'. Case-sensitive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Available Datasets **Slug:** `CENSUS_BUREAU_LIST_AVAILABLE_DATASETS` Lists all available Census Bureau datasets with their metadata, vintages, and API endpoints. Use this as the discovery tool to find available datasets before querying specific data. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Datasets HTML **Slug:** `CENSUS_BUREAU_LIST_DATASETS_HTML` Tool to retrieve a complete HTML listing of all available (non-timeseries) Census Bureau datasets. Use when you need to discover available datasets with links to their Geographies, Variables, Examples, and API base URLs. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Datasets XML **Slug:** `CENSUS_BUREAU_LIST_DATASETS_XML` Tool to retrieve a list of all available Census Bureau datasets in XML format. Use when you need to discover available datasets, their paths, descriptions, and time periods. The XML contains comprehensive metadata about each dataset including identifiers, titles, and temporal coverage. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Geocoder Benchmarks **Slug:** `CENSUS_BUREAU_LIST_GEOCODER_BENCHMARKS` List all available benchmark versions for the Census Bureau geocoding service. Use this to discover valid benchmark options before geocoding addresses. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Geocoder Vintages **Slug:** `CENSUS_BUREAU_LIST_GEOCODER_VINTAGES` Tool to list available geography vintages for a given Census geocoder benchmark. Use when you need to see what geography versions are available for geocoding operations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `benchmark` | string | Yes | Benchmark ID or name that references what version of the locator should be searched. Use '4' for current benchmark. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List TIGERweb Services **Slug:** `CENSUS_BUREAU_LIST_TIGERWEB_SERVICES` Tool to discover all available TIGERweb map services for Census geographic boundaries. Use when you need to find which TIGERweb services are available (Current, ACS years, Census years) before accessing specific service metadata or querying geographic boundary data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `f` | string ("json") | No | Response format. Must be 'json' for structured API data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Timeseries Datasets (HTML) **Slug:** `CENSUS_BUREAU_LIST_TIMESERIES_DATASETS_HTML` Tool to retrieve a list of all available timeseries datasets from the US Census Bureau API in HTML format. Use when you need to discover available timeseries datasets and their endpoints. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Timeseries Datasets (JSON) **Slug:** `CENSUS_BUREAU_LIST_TIMESERIES_DATASETS_JSON` Tool to list all available timeseries datasets from the US Census Bureau API. Use when you need to discover what timeseries data is available. This endpoint returns a DCAT Catalog containing metadata for all timeseries datasets, including their titles, descriptions, available variables, geography links, and API endpoints. The response follows the Project Open Data v1.1 schema. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Timeseries Datasets (XML) **Slug:** `CENSUS_BUREAU_LIST_TIMESERIES_DATASETS_XML` Tool to retrieve a list of all available Census Bureau timeseries datasets in XML format. Use when you need to discover available timeseries datasets, their endpoints, or metadata. This is a discovery endpoint that returns the complete catalog of timeseries datasets. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Supplemental Estimates **Slug:** `CENSUS_BUREAU_QUERY_ACS_ACSSE` Query ACS Supplemental Estimates data by variables and geography. Use when you need supplemental ACS estimates for specific geographic areas and variables. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested geographies. Required when querying sub-geographies like counties within a state. Format: 'type:code'. Example: 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Target geography specification in 'type:code' format. Use '*' for all areas of the specified type. Common formats: 'us:*' (national level), 'state:*' (all states), 'state:06' (specific state like California), 'county:*' (all counties, requires 'in' parameter). | | `get` | string | Yes | Comma-separated list of variables to retrieve from the ACS Supplemental Estimates. Include 'NAME' to get geography names. Variable codes are K-prefixed (e.g., K200101_001E for supplemental estimate variables). Example: 'NAME,K200101_001E' to get geography name and a specific estimate. | | `vintage` | integer | Yes | Year (vintage) of the ACS Supplemental Estimates dataset to query. Available vintages range from 2014 to 2024. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Comparison Profiles **Slug:** `CENSUS_BUREAU_QUERY_ACS_CPROFILE` Query ACS Comparison Profiles data by variables and geography. Use when you need to compare demographic, social, economic, or housing characteristics across different time periods within the same dataset. Available for both 1-year and 5-year ACS estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries. Required when querying sub-geographies like counties within a state. Format: 'geography_type:code'. Example: 'state:06' when querying counties to get all counties in California. | | `for` | string | Yes | Geography specification in 'type:code' format. Use 'us:1' for United States, 'state:*' for all states, 'state:06' for California, 'county:*' for all counties (requires 'in' parameter). Use '*' wildcard to get all areas of a geography type. | | `get` | string | Yes | Variables or groups to retrieve from the Comparison Profiles. Use 'group(CPXX)' to retrieve all variables in a group (e.g., 'group(CP05)' for demographic characteristics). Use 'NAME' to include geography names. Can specify individual variables or comma-separated list. | | `product` | string ("acs1" | "acs5") | Yes | ACS product type: 'acs1' for 1-year estimates (available for areas with 65,000+ population) or 'acs5' for 5-year estimates (available for all geographic areas). | | `vintage` | integer | Yes | Year of the ACS Comparison Profiles data (2010-2024). Represents the end year of the data collection period. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Migration Flows **Slug:** `CENSUS_BUREAU_QUERY_ACS_FLOWS` Tool to query American Community Survey (ACS) Migration Flows data by variables and geography. Use when you need migration flow statistics between geographic areas (inbound/outbound migration patterns). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Optional geography hierarchy predicate. Format: 'geography_level:code' (e.g., 'state:01'). Used to filter results within a parent geography. Required when querying sub-state geographies like counties. | | `for` | string | Yes | Geography predicate clause specifying the reference geography level. Format: 'geography_level:code' (e.g., 'county:003'). Use '*' for all values of the specified geography level. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: FULL1_NAME (reference geography name), FULL2_NAME (second geography name), GEOID1 (reference geography ID), GEOID2 (second geography ID), MOVEDIN (total inbound migration), MOVEDOUT (total outbound migration), MOVEDNET (net migration), STATE1_NAME, STATE2_NAME, COUNTY1_NAME, COUNTY2_NAME. | | `vintage` | integer | Yes | Year of the ACS flows dataset (2009-2022). The vintage represents the year of the migration flow data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Data Profile **Slug:** `CENSUS_BUREAU_QUERY_ACS_PROFILE` Tool to query ACS Data Profiles by variables and geography. Use when you need demographic, social, economic, or housing profile data from the American Community Survey for specific geographic areas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries in 'type:code' format. Required when querying sub-state geographies like counties or census tracts. Example: Use 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Geography level to query in 'type:code' format. Examples: 'us:1' for United States nationwide data, 'state:*' for all states, 'state:06' for California specifically, 'county:*' for all counties (requires 'in' parameter). Common FIPS codes: CA=06, NY=36, TX=48, FL=12, IL=17, PA=42. | | `get` | string | Yes | Variables or groups to retrieve. Use 'group(GROUP_CODE)' syntax for entire profile groups (e.g., 'group(DP02)' for Social Characteristics, 'group(DP03)' for Economic Characteristics, 'group(DP04)' for Housing Characteristics, 'group(DP05)' for Demographic Characteristics). Or specify individual variable names separated by commas (e.g., 'NAME,DP02_0001E'). Include 'NAME' to get geographic area names in the results. | | `product` | string ("acs1" | "acs5") | Yes | ACS product type: 'acs1' for 1-Year estimates or 'acs5' for 5-Year estimates. 1-Year estimates are more current but available for areas with population 65,000+. 5-Year estimates provide more reliable data for smaller geographic areas. | | `vintage` | string | Yes | Year of the ACS data to retrieve (e.g., '2024', '2023'). Must be a valid year for which ACS profile data is available. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Selected Population Profiles **Slug:** `CENSUS_BUREAU_QUERY_ACS_SPP` Tool to query ACS Selected Population Profiles (SPP) data by variables and geography for specific population groups. Use when you need demographic data filtered by race, ethnicity, ancestry, or other population subgroups. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries. Required when querying sub-geographies. Example: Use 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Geography clause specifying the geographic level to query. Use 'us:1' for nationwide data, 'state:06' for California, 'state:*' for all states, 'county:037' for a specific county. Format is 'geography_type:code'. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the Selected Population Profile tables. Include 'NAME' to get geographic area names. Examples: 'NAME,S0201_001E' for specific variables, 'group(S0201)' to retrieve all variables in the S0201 table. | | `product` | string ("acs1" | "acs5") | Yes | ACS product type: 'acs1' for 1-year estimates or 'acs5' for 5-year estimates. 1-year estimates are more current but available for fewer geographies, while 5-year estimates are more reliable and available for all areas. | | `vintage` | integer | Yes | Year of the ACS survey (2008-2024). Specifies which vintage of the Selected Population Profiles data to retrieve. | | `POPGROUP` | string | Yes | Race/Ethnic Group code for filtering by population subgroup. Required parameter that specifies which demographic group to query. Use '001' for total population. Other codes represent specific race, ethnicity, ancestry, tribal affiliation, or place of birth groups. Refer to Census documentation for complete list of POPGROUP codes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ACS Subject Tables **Slug:** `CENSUS_BUREAU_QUERY_ACS_SUBJECT` Tool to query ACS Subject Tables data by variables and geography. Use when you need subject table data (S-tables like S0101 for Age and Sex, S1701 for Poverty Status) from the American Community Survey. Available for both 1-year (acs1) and 5-year (acs5) estimates. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries. Required when querying sub-state geographies like counties or census tracts. Example: Use 'state:06' in 'in' when 'for' is 'county:*' to get all counties within California. | | `for` | string | Yes | Geography specification in 'type:code' format. Use 'us:1' for United States, 'state:06' for California, 'state:*' for all states, 'county:*' for all counties (requires 'in' parameter). Common FIPS codes: CA=06, NY=36, TX=48, FL=12, IL=17. | | `get` | string | Yes | Comma-separated list of subject table variables or group specifiers to retrieve. Include 'NAME' to get geographic area names. Subject table variables start with 'S' (e.g., S0101_C01_001E for Age and Sex). Use 'group(S####)' syntax to retrieve all variables from a subject table. Examples: 'NAME,S0101_C01_001E' for total population estimate, 'group(S0101)' for all Age and Sex variables. | | `product` | string ("acs1" | "acs5") | Yes | ACS product type: 'acs1' for 1-year estimates (most current data, larger areas only) or 'acs5' for 5-year estimates (more reliable, all geographic areas). | | `vintage` | integer | Yes | Year of the ACS dataset to retrieve (e.g., 2024, 2023, 2022). Available years depend on the product: 1-year estimates are available from 2005, 5-year estimates from 2009. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Annual Business Survey **Slug:** `CENSUS_BUREAU_QUERY_ANNUAL_BUSINESS_SURVEY` Tool to query Annual Business Survey Company Summary (abscs) data with demographic filters. Use when you need business ownership demographics, employment, payroll, or industry statistics filtered by sex, race, ethnicity, veteran status, or firm size for specific geographic areas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries in 'type:code' format. Required when querying sub-state geographies like counties. Example: Use 'state:06' when querying 'county:*' to get all counties in California. | | `SEX` | string | No | Filter by sex/gender of business owner. Consult ABS documentation for valid codes. Common codes may include values like '001' for specific categories. | | `for` | string | Yes | Geography level to query in 'type:code' format. Examples: 'us:*' for United States nationwide data, 'state:*' for all states, 'state:06' for California specifically, 'county:*' for all counties (requires 'in' parameter). Common state FIPS codes: CA=06, NY=36, TX=48, FL=12, IL=17, PA=42. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the ABS Company Summary. Common variables: NAME (geographic area name), GEO_ID (geographic identifier), NAICS2022_LABEL (industry description), NAICS2022 (industry code), FIRMPDEMP (number of employer firms), EMP (employment), PAYANN (annual payroll), RCPPDEMP (receipts of employer firms), SEX (sex code), ETH_GROUP (ethnicity group code), RACE_GROUP (race group code), VET_GROUP (veteran status code). Include 'NAME' to get readable geographic names in results. | | `EMPSZFI` | string | No | Filter by employment size of firms. Consult ABS documentation for valid size class codes. Different codes represent different employee count ranges. | | `vintage` | string | Yes | Year of ABS data to retrieve (e.g., '2022', '2021', '2020'). Most recent data is typically available 1-2 years after the reference year. Available years: 2017 onwards. | | `ETH_GROUP` | string | No | Filter by ethnicity group of business owner. Consult ABS documentation for valid codes. Use codes like '020' for specific ethnicity categories. | | `NAICS2022` | string | No | Filter by 2022 NAICS (North American Industry Classification System) code. Use '00' for all sectors combined, or specify 2-6 digit codes for specific industries. Examples: '00' (all sectors), '31-33' (Manufacturing), '44-45' (Retail Trade), '72' (Accommodation and Food Services), '54' (Professional Services). | | `VET_GROUP` | string | No | Filter by veteran status of business owner. Consult ABS documentation for valid codes. Use codes like '001' for specific veteran status categories. | | `RACE_GROUP` | string | No | Filter by race group of business owner. Consult ABS documentation for valid codes. Use '00' for all race groups combined or specific codes for individual groups. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Commodity Flow Survey **Slug:** `CENSUS_BUREAU_QUERY_COMMODITY_FLOW_SURVEY` Query Commodity Flow Survey data on freight shipments by origin, destination, mode, and commodity. Use when you need freight transportation statistics including shipment values, tonnage, and ton-miles for analyzing goods movement patterns in the United States. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries. Required when querying sub-geographies. Format: 'geography_type:code'. Example: 'state:06' when querying CFS areas to get all CFS areas in California. | | `for` | string | Yes | Geography specification in 'type:code' format. Use 'us:1' for United States level data, 'region:{code}' for census regions, 'division:{code}' for census divisions, 'state:{code}' for state-level data (e.g., 'state:06' for California), 'cfs area (or part):{code} in state:{code}' for CFS areas. Use '*' wildcard to get all areas of a geography type. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: NAME (area name), GEO_ID (geographic identifier), COMM (commodity code), COMM_LABEL (commodity description), YEAR (survey year), VAL (value in thousands of dollars), TON (weight in thousands of tons), TONS_MI (ton-miles in millions), MODE (transportation mode code), MODE_LABEL (transportation mode description), ORIG_STATE (origin state FIPS code), DEST_STATE (destination state FIPS code). | | `vintage` | integer | Yes | Year of the CFS data release (2012, 2017, 2022). The CFS is conducted every 5 years and covers freight shipments by domestic establishments. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query CPS Survey Data **Slug:** `CENSUS_BUREAU_QUERY_CPS_SURVEY` Tool to query Current Population Survey (CPS) microdata including basic monthly employment data and supplemental surveys. Use when you need individual-level labor force, employment, earnings, or demographic data from the CPS. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | No | Optional geography predicate to filter results. Use format 'geography_type:code' such as 'state:06' for California or 'state:*' for all states. If omitted, data for all available geographies is returned. | | `get` | string | Yes | Comma-separated list of CPS variable names to retrieve. Common basic monthly variables: 'PEMLR' (employment status: employed/unemployed/not in labor force), 'PRTAGE' (age), 'PESEX' (sex: 1=male, 2=female), 'PEEDUCA' (education level), 'PRERNWA' (weekly earnings), 'PEHRUSL1' (usual hours worked per week). For ASEC supplement, variables like 'A_FTPT' (full-time/part-time status), 'MARSUPWT' (supplement weight), 'PTOTVAL' (total person income) are available. Example: 'PEMLR,PRTAGE,PESEX'. | | `month` | string ("jan" | "feb" | "mar" | "apr" | "may" | "jun" | "jul" | "aug" | "sep" | "oct" | "nov" | "dec") | Yes | Month of the survey data to retrieve (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec). Use lowercase three-letter abbreviations. | | `survey` | string ("basic" | "asec" | "voting" | "school" | "computer" | "fertility" | "food" | "volunteer") | Yes | Type of CPS survey to query. 'basic' provides monthly labor force data (employment status, hours worked, earnings). 'asec' is the Annual Social and Economic Supplement with detailed income and poverty data. Other supplements include 'voting' (voter registration), 'school' (school enrollment), 'computer' (internet usage), 'fertility', 'food', and 'volunteer'. | | `vintage` | integer | Yes | Survey year (e.g., 2024, 2023). CPS microdata is typically available from 2010 onwards. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Decennial DHC **Slug:** `CENSUS_BUREAU_QUERY_DEC_DHC` Tool to query Decennial Census Demographic and Housing Characteristics (DHC) data by variables and geography. Use when you need detailed 2020 Census demographic and housing data for states, counties, or other geographic areas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography constraint for hierarchical queries in 'type:code' format. Required when querying sub-state geographies such as counties, census tracts, or block groups. Can be chained for multiple levels (e.g., 'state:06 county:001'). Example: Use 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Target geography level and code in 'type:code' format. Use '*' to retrieve data for all geographies at the specified level. Examples: 'state:*' (all states), 'state:06' (California specifically), 'county:*' (all counties, requires 'in_geography' parameter), 'us:*' (national level). | | `get` | string | Yes | Comma-separated list of variables to retrieve from the DHC dataset. Include 'NAME' to get geographic area names in results. Variable examples: 'H9_001N' (total housing units), 'P1_001N' (total population), 'H1_001N' (occupancy status). Use 'group(CODE)' syntax to retrieve entire variable groups (e.g., 'group(P1)' for population data). Check Census DHC documentation for complete variable list. | | `vintage` | string | Yes | Census year for DHC data. DHC is available for the 2020 Decennial Census. Use '2020' to retrieve the most recent demographic and housing characteristics data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Decennial Census Demographic Profile **Slug:** `CENSUS_BUREAU_QUERY_DEC_DP` Tool to query Decennial Census Demographic Profile data by variables and geography. Use when you need comprehensive demographic and housing profile data from the 2020 Decennial Census for specific geographic areas. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries in 'type:code' format. Required when querying sub-state geographies like counties, tracts, or places. Example: Use 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Geography level to query in 'type:code' format. Examples: 'us:1' for United States, 'state:*' for all states, 'state:06' for California, 'county:*' for all counties (requires 'in' parameter). Use '*' to retrieve all geographies of the specified type. | | `get` | string | Yes | Comma-separated list of variable names to retrieve from the Demographic Profile. Common variables: DP1_0001C (total population), DP1_0002C (total housing units). Use 'group(TABLE)' syntax (e.g., 'group(DP1)') to retrieve all variables in a table. Include 'NAME' to get geographic area names in the results. | | `vintage` | string | Yes | Decennial Census vintage year. The Demographic Profile (DP) is available for 2020. Use '2020' to retrieve 2020 Decennial Census demographic profile data. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Decennial Census P.L. Redistricting Data **Slug:** `CENSUS_BUREAU_QUERY_DEC_PL` Tool to query Decennial Census P.L. 94-171 Redistricting Data. Use when you need official population counts used for congressional and state legislative redistricting for census years 2000, 2010, or 2020. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries (maps to Census API 'in' parameter). Required when querying sub-state geographies like counties, tracts, or block groups. Format: 'type:code' or 'type:code+type:code' for nested hierarchies. Examples: 'state:06' to filter counties in California, 'state:36+county:061' to filter tracts in New York County, NY. | | `for` | string | Yes | Geography specification in 'type:code' format defining the geographic level to query. Use '*' to retrieve all entities of that geography type. Common examples: 'state:*' (all states), 'state:06' (California by FIPS code), 'county:*' (all counties - requires 'in_geography' parameter), 'tract:*' (all census tracts - requires 'in_geography' parameter). For specific entities, use FIPS codes (e.g., 'state:06' for CA, 'state:36' for NY). | | `get` | string | Yes | Comma-separated list of variables to retrieve from the P.L. dataset. Common variables: 'NAME' (geographic area name), 'P1_001N' (total population), 'P1_003N' (total population 18 years and over), 'P2_001N' (total Hispanic or Latino population). Use 'group(P1)' to retrieve all P1 table variables, 'group(P2)' for all P2 table variables. Variable names vary by vintage - check Census API documentation for complete variable lists. | | `vintage` | string ("2000" | "2010" | "2020") | Yes | Census year for P.L. 94-171 Redistricting Data. Available options: '2000', '2010', or '2020'. This dataset provides population counts used for congressional redistricting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Economic Census Data **Slug:** `CENSUS_BUREAU_QUERY_ECONOMIC_CENSUS` Tool to query Economic Census data including establishments, employment, payroll, and receipts by geography and industry (NAICS). Use when you need comprehensive business statistics from the 5-year Economic Census surveys (2002, 2007, 2012, 2017, 2022). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography constraint for nested queries. Required when querying sub-state geographies like counties. Format: 'geography_type:code'. Example: 'state:06' when querying all counties in California. | | `for` | string | No | Geographic predicate specifying the target geography in 'geography_type:code' format. Use '*' for all areas of that type. Examples: 'us:*' for United States nationwide data, 'state:*' for all states, 'state:06' for California, 'county:*' for all counties (requires 'in' parameter). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables for 2022 data: NAICS2022_LABEL (industry name), EMP (employment), ESTAB (establishments), PAYANN (annual payroll), RCPTOT (total receipts), NAME (geography name), GEO_ID (geographic identifier). For earlier years, use corresponding NAICS year (e.g., NAICS2017_LABEL for 2017 data). | | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. | | `product` | string | No | Data product type for the Economic Census. Use 'basic' for the ecnbasic endpoint which contains core business statistics. | | `vintage` | string ("2002" | "2007" | "2012" | "2017" | "2022") | Yes | Economic Census year. The Economic Census is conducted every 5 years (2002, 2007, 2012, 2017, 2022) and provides comprehensive statistics on U.S. businesses including establishments, employment, payroll, and receipts. | | `NAICS2012` | string | No | NAICS 2012 code filter for 2012 vintage data. Use 2-6 digit codes. Ignored if querying other vintages. | | `NAICS2017` | string | No | NAICS 2017 code filter for 2017 vintage data. Use 2-6 digit codes. Ignored if querying other vintages. | | `NAICS2022` | string | No | NAICS 2022 code filter for industry-specific data when querying 2022 vintage. Use 2-6 digit codes: '11' (Agriculture), '23' (Construction), '31-33' (Manufacturing), '42' (Wholesale), '44-45' (Retail), '54' (Professional Services), '62' (Healthcare), '72' (Accommodation/Food Services). For other vintages, use NAICS2017, NAICS2012, etc. corresponding to the vintage year. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query International Trade Timeseries **Slug:** `CENSUS_BUREAU_QUERY_INTL_TRADE_TIMESERIES` Tool to query International Trade timeseries data from Census Bureau API. Provides monthly and annual import/export statistics by commodity, country, and port. Use when you need US trade statistics organized by various classification systems (end-use, Harmonized System, NAICS, state, or port). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `get` | string | Yes | Comma-separated list of variables to retrieve. Variables differ by subtype. Common variables across subtypes: ALL_VAL_MO (monthly total value), ALL_VAL_YR (year-to-date total value), CTY_CODE (country code), CTY_NAME (country name), DISTRICT (customs district code), DIST_NAME (district name), YEAR (year), MONTH (month). End-use specific: E_ENDUSE (export end-use code), E_ENDUSE_LDESC (long description), I_ENDUSE (import end-use code), I_ENDUSE_LDESC (long description). HS specific: E_COMMODITY (export HS code), I_COMMODITY (import HS code). Always include at least one value variable (e.g., ALL_VAL_MO) in your query. | | `YEAR` | string | No | Four-digit year filter to retrieve data for a specific year. Use this to narrow results to a particular year. Example: '2016' for year 2016, '2024' for year 2024 | | `time` | string | No | ISO-8601 formatted time filter in YYYY-MM format for querying specific monthly data. Alternative to using YEAR and MONTH parameters separately. Example: '2024-01' for January 2024, '2016-06' for June 2016 | | `MONTH` | string | No | Two-digit month filter (01-12) to retrieve data for a specific month. Typically used in combination with YEAR parameter. Example: '06' for June, '01' for January, '12' for December | | `subtype` | string | Yes | Data category/classification system. Valid values: 'enduse' (End-use classification), 'hs' (Harmonized System commodity classification), 'naics' (North American Industry Classification System), 'statehs' (State-level data by HS code), 'statenaics' (State-level data by NAICS code), 'porths' (Port-level data by HS code). Different subtypes provide trade statistics organized by different classification systems. | | `CTY_CODE` | string | No | Four-character country code filter to retrieve trade data with a specific country. Example: '1220' for Canada, '2010' for Canada (imports), '4020' for Germany | | `DISTRICT` | string | No | Two-character customs district code filter to retrieve trade data for a specific US customs district. Example: '41' for Los Angeles, '10' for New York, '30' for Chicago | | `E_ENDUSE` | string | No | Export end-use category code filter (for exports/enduse subtype). Example: '00000' for total exports, '10000' for foods/feeds/beverages | | `I_ENDUSE` | string | No | Import end-use category code filter (for imports/enduse subtype). Example: '00000' for total imports, '10000' for foods/feeds/beverages | | `trade_type` | string | Yes | Trade type to query. Valid values: 'exports' (for export statistics) or 'imports' (for import statistics). This determines whether you're querying outbound trade from the US or inbound trade to the US. | | `E_COMMODITY` | string | No | Export Harmonized System commodity code filter (for exports/hs subtype). Can be 2-, 4-, 6-, or 10-character code. Use shorter codes for broader commodity categories, longer codes for specific items. Example: '01' for live animals, '0101' for horses | | `I_COMMODITY` | string | No | Import Harmonized System commodity code filter (for imports/hs subtype). Can be 2-, 4-, 6-, or 10-character code. Example: '01' for live animals | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Nonemployer Statistics **Slug:** `CENSUS_BUREAU_QUERY_NONEMPLOYER_STATISTICS` Tool to query Nonemployer Statistics data covering businesses with no paid employees. Use when you need statistics on self-employed individuals, sole proprietorships, and businesses without payroll filtered by industry and geography. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography constraint, required when 'for' is county-level. Format: 'state:XX' where XX is the 2-digit FIPS code. Examples: 'state:06' (California), 'state:36' (New York), 'state:48' (Texas). | | `for` | string | Yes | Geographic level to retrieve in 'type:code' format. Use 'us:*' for national total, 'state:*' for all states, 'state:XX' for a specific state (e.g., 'state:06' for California), 'county:*' for all counties (requires 'in' parameter). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: NAME (geographic area name), NRCPTOT (total receipts in $1000s), NESTAB (number of establishments), NAICS2017 (industry code), NAICS2017_LABEL (industry name), RCPTPDEMP (receipts per establishment). | | `key` | string | No | Census API key for higher rate limits and reliability | | `vintage` | string | Yes | Reference year for the data (1997-2023). Nonemployer Statistics covers businesses with no paid employees. Recent years provide more comprehensive data. | | `NAICS2017` | string | No | Filter by 2017 NAICS industry code. Use 2-6 digit codes. Examples: '44-45' (Retail Trade), '62' (Health Care), '72' (Accommodation and Food Services), '54' (Professional Services). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query PEP CharAgeGroups **Slug:** `CENSUS_BUREAU_QUERY_PEP_CHAR_AGE_GROUPS` Query population estimates by age groups, sex, race, and Hispanic origin from the Census Bureau PEP CharAgeGroups dataset. Use this tool when you need population estimates broken down by demographic characteristics such as age groups, sex, race, and Hispanic origin for states, counties, or other geographic areas. Available for vintages 2015-2019. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries. Required when querying sub-state geographies. Format: 'geography_type:code'. Example: 'state:06' (for counties in California). | | `for` | string | Yes | Geographic area to query using 'geography_type:codes' format. Use '*' for all areas. Common examples: 'state:*' (all states), 'state:06' (California), 'state:01,02,04' (multiple states), 'county:*' (all counties), 'us:*' (national level). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables include: NAME (geographic area name), POP (population), AGEGROUP (age group code), SEX (sex code: 0=both, 1=male, 2=female), RACE (race code), HISP (Hispanic origin code). Example: 'NAME,POP,AGEGROUP,SEX' to get population by age group and sex. | | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | | `vintage` | integer | Yes | Year of the population estimate vintage. Valid vintages for CharAgeGroups: 2015-2019. This dataset provides population estimates by age groups, sex, race, and Hispanic origin. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query PEP Components **Slug:** `CENSUS_BUREAU_QUERY_PEP_COMPONENTS` Query components of population change from the Census Bureau Population Estimates Program (PEP). This tool retrieves data on births, deaths, natural increase, and migration components (domestic, international, and net migration) for states, counties, or other geographic areas. Data is available for vintages 2015-2019. Use this tool when you need to analyze: - Birth and death statistics by geographic area - Natural population increase (births minus deaths) - Migration patterns (domestic, international, or net migration) - Population change components over specific time periods #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | Yes | Geographic level predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Examples: 'state:*' (all states), 'state:06' (California), 'county:*' (all counties), 'us:*' (national level). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables include: BIRTHS (number of births), DEATHS (number of deaths), NATURALINC (natural increase), NETMIG (net migration), DOMESTICMIG (domestic migration), INTERNATIONALMIG (international migration), NAME (geographic area name). Example: 'BIRTHS,DEATHS,NAME' or 'NATURALINC,NETMIG,DOMESTICMIG,INTERNATIONALMIG,NAME'. | | `key` | string | No | Census API key for authentication. Optional if key is provided in metadata. Using a key provides higher rate limits. | | `vintage` | integer | Yes | Year vintage for the PEP components dataset. Valid vintages: 2015-2019. This represents the year of the dataset release. | | `PERIOD_CODE` | string | No | Period of change code to filter results. This specifies the time period for the component data. Example: '10' for July 1, 2018 to June 30, 2019. If not provided, returns data for all available periods. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query PEP Housing Estimates **Slug:** `CENSUS_BUREAU_QUERY_PEP_HOUSING` Query housing unit estimates from the US Census Bureau Population Estimates Program (PEP). Use this tool to retrieve housing unit estimates for different geographic levels (national, state, county) for years 2013-2019. Returns data including housing unit counts, date descriptions, and geographic identifiers. Available vintages: 2013-2019 #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography for hierarchical queries. Required when querying counties. Example: 'state:01' when querying counties in Alabama. | | `for` | string | Yes | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Examples: 'us:1' (national level), 'state:*' (all states), 'state:06' (California), 'county:*' (all counties - requires 'in' parameter) | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: HUEST (Housing Unit Estimate), DATE_DESC (Date description), DATE_CODE (Estimate date code), LASTUPDATE (Last update date), GEO_ID (Geographic identifier), GEOCOMP (Geographic component). Example: 'HUEST,DATE_DESC,LASTUPDATE' | | `key` | string | No | Census API key. If omitted, uses the configured key from client metadata. | | `vintage` | integer | Yes | Year of housing estimates (2013-2019). Each vintage represents housing unit estimates for that year. | | `DATE_CODE` | integer | No | Filter by specific estimate date code. Values 1-12 represent different dates from April 2010 to July 2019. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Population Projections **Slug:** `CENSUS_BUREAU_QUERY_POPULATION_PROJECTIONS` Query population projections from the Census Bureau API. Use this tool to retrieve projected population data for specific years (vintages 2012-2017) at various demographic breakdowns including age, sex, race, and Hispanic origin. The projections provide future population estimates based on different scenarios. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `AGE` | integer | No | Optional filter for age identifier. Used to filter projections by age group. | | `SEX` | integer | No | Optional filter for sex identifier. Used to filter projections by sex. | | `for` | string | Yes | Geographic area specification. Format: '{geography_level}:{codes}'. For national level, use 'us:1' or 'us:*'. Example: 'us:1' for United States national projections. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables include: 'POP' (projected population), 'YEAR' (year of projection), 'DATE_CODE' (projection date code), 'SEX' (sex identifier), 'RACE' (race identifier), 'AGE' (age identifier), 'HISP' (Hispanic origin identifier), 'SCENARIO' (projection scenario). Example: 'POP,YEAR' retrieves population and year fields. | | `HISP` | integer | No | Optional filter for Hispanic origin identifier. Used to filter projections by Hispanic origin. | | `RACE` | integer | No | Optional filter for race identifier. Used to filter projections by race category. | | `YEAR` | integer | No | Optional filter for projection year. Used to filter projections for specific years. | | `vintage` | string ("2012" | "2013" | "2014" | "2015" | "2016" | "2017") | Yes | Year of projection data. Valid vintages: 2012, 2013, 2014, 2015, 2016, or 2017. | | `SCENARIO` | string | No | Optional filter for projection scenario. Used to filter by different projection scenarios. | | `DATE_CODE` | integer | No | Optional filter for projection date code. Used to filter specific projection dates. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Surname Data **Slug:** `CENSUS_BUREAU_QUERY_SURNAME` Query surname frequency data from the U.S. Census Bureau Decennial Census (2000 or 2010). Use this tool to retrieve surname statistics including frequency counts, national rankings, and race/ethnicity distributions. Data is aggregated at the national level and includes surnames reported 100 or more times in the decennial census. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `get` | string | Yes | Comma-separated list of variables to retrieve. Available variables: 'NAME' (surname), 'COUNT' (frequency), 'RANK' (national rank), 'PROP100K' (proportion per 100k population), 'CUM_PROP100K' (cumulative proportion per 100k), 'PCTWHITE' (percent non-Hispanic white), 'PCTBLACK' (percent non-Hispanic Black), 'PCTAIAN' (percent non-Hispanic American Indian/Alaska Native), 'PCTAPI' (percent non-Hispanic Asian/Pacific Islander), 'PCTHISPANIC' (percent Hispanic/Latino), 'PCT2PRACE' (percent non-Hispanic two or more races). | | `key` | string | No | Census API key for authentication. If not provided, uses the default configured key. | | `NAME` | string | No | Filter by specific surname (case-sensitive). If not provided, returns data for all surnames or as filtered by RANK. | | `RANK` | string | No | Filter by rank or rank range. Use single value (e.g., '1') for a specific rank, or range format (e.g., '1:100') for ranks 1 through 100. Cannot be used together with NAME filter. | | `vintage` | string ("2000" | "2010") | Yes | Census year for surname data. Supported values: '2000' or '2010'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query TIGERweb Layer **Slug:** `CENSUS_BUREAU_QUERY_TIGERWEB_LAYER` Tool to query TIGERweb GeoServices for Census geographic boundaries and features. Use when you need to retrieve geographic shapes, FIPS codes, or spatial data for states, counties, tracts, blocks, or other Census geographies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `f` | string ("json" | "geojson" | "html") | No | Response format. 'json' returns standard ESRI JSON format with features array. 'geojson' returns GeoJSON format compatible with mapping libraries. 'html' returns human-readable HTML table. | | `where` | string | No | SQL-like WHERE clause for attribute filtering. Use field names from the layer (e.g., STATE='06' for California, COUNTY='001' for a specific county, NAME='New York'). Use FIPS codes for precise filtering. Multiple conditions can be combined with AND/OR (e.g., STATE='06' AND COUNTY='075'). | | `service` | string | Yes | TIGERweb service name (e.g., 'State_County', 'Tracts_Blocks', 'Urban_Areas'). Common services include 'State_County' (states and counties), 'Tracts_Blocks' (census tracts and blocks), 'Urban_Areas' (urban/rural areas), 'Legislative' (congressional districts), 'PUMA_TAD_TAZ' (public use microdata areas). | | `geometry` | string | No | Geometry in JSON format for spatial queries (e.g., point, polygon, envelope). Format depends on geometryType. Example point: '{"x":-122.4,"y":37.8}'. Example envelope: '{"xmin":-122.5,"ymin":37.7,"xmax":-122.3,"ymax":37.9}'. Use for spatial intersection queries. | | `layer_id` | integer | Yes | Layer ID within the service. Each service contains multiple layers: State_County has 0 (states) and 82 (counties), Tracts_Blocks has layers for tracts and block groups. Check the TIGERweb REST API directory for available layer IDs. | | `out_fields` | string | No | Comma-separated list of field names to return in the response. Use '*' to return all fields. Common fields include GEOID (geographic identifier), NAME (feature name), STATE, COUNTY, TRACT. Limiting fields improves performance for large result sets. | | `geometry_type` | string ("esriGeometryPoint" | "esriGeometryMultipoint" | "esriGeometryPolyline" | "esriGeometryPolygon" | "esriGeometryEnvelope") | No | Geometry type for spatial queries. | | `return_geometry` | boolean | No | Whether to include geometry shapes (coordinates) in the response. Set to false for attribute-only queries to reduce response size. When true, returns full polygon/line coordinates for mapping. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Business Dynamics Statistics **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_BDS` Query Business Dynamics Statistics (BDS) time series data from the Census Bureau. Use when you need data on business formation, job creation, establishment dynamics, and employment statistics by industry and geography over time. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries. Required when querying sub-geographies. Format: 'type:code'. Example: 'state:06' for sub-state geographies in California. | | `for` | string | Yes | Geographic area specification in 'type:code' format. Use 'us:1' for national-level data (entire United States). For state-level: 'state:*' (all states) or 'state:XX' (specific state by FIPS code). For metro areas: 'metropolitan statistical area/micropolitan statistical area:*' (all metros) or specific metro codes. | | `get` | string | Yes | Comma-separated list of variables to retrieve from BDS dataset. Common variables: NAME (geography name), YEAR (year), FIRM (number of firms), ESTAB (number of establishments), EMP (employment), ESTABS_ENTRY (entering establishments), ESTABS_EXIT (exiting establishments), FIRM_ENTRY (entering firms), FIRM_EXIT (exiting firms), JOB_CREATION (job creation), JOB_DESTRUCTION (job destruction), NET_JOB_CREATION (net job creation). Check Census BDS documentation for full list of available variables. | | `time` | string | Yes | Year value for filtering BDS data. Format: 'YYYY' (e.g., '2022', '2021'). BDS data is annual time series. For range queries, use format 'from+YYYY+to+YYYY'. | | `NAICS` | string | No | 2017 NAICS industry code filter. Use '00' for all industries (aggregate). Examples: '00' (all industries), '11' (Agriculture), '23' (Construction), '31-33' (Manufacturing), '44-45' (Retail Trade), '54' (Professional Services), '72' (Accommodation and Food Services). Supports 2-6 digit NAICS codes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Timeseries Data **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_DATA` Query Census timeseries datasets containing longitudinal data for multiple time periods. Use this tool to retrieve economic indicators (EITS), international trade data, Quarterly Workforce Indicators (QWI), poverty statistics (SAIPE), and other time-varying datasets from the U.S. Census Bureau. Timeseries datasets store data for multiple points in time within a single dataset, allowing you to track changes over time using the time predicate. Returns data as a structured response with headers and rows, where the first element contains column names and subsequent elements contain the data values for each geography and time period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter used to narrow results to sub-geographies. Required for certain geography combinations. Format: '{geography_level}:{code}' or multiple filters separated by spaces. Examples: 'state:06' (for counties in California), 'state:25 county:017' (for tracts in Middlesex County, MA). | | `for` | string | Yes | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Common examples: 'state:*' (all states), 'state:06' (California), 'county:*' (all counties), 'us:*' (national level). Available geographies vary by dataset. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the dataset. Use 'NAME' to include geography names. Variable names differ by dataset. For SAIPE: 'SAEPOVRTALL_PT' (poverty rate), 'SAEMHI_PT' (median household income). For International Trade: 'ALL_VAL_MO' (monthly value), 'CTY_CODE' (country code). For QWI: 'Emp' (employment), 'Payroll' (total payroll). Check dataset-specific documentation for available variables. | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. | | `time` | string | No | Time period predicate for filtering data. Format varies by dataset granularity: Annual: '2023', 'from+2020+to+2023' (range). Quarterly: '2023-Q1', '2023-Q2'. Monthly: '2023-01', '2023-12'. Omit to retrieve all available time periods for the specified geography. | | `dataset` | string | Yes | Timeseries dataset path. Common datasets: 'poverty/saipe' (Small Area Income and Poverty Estimates), 'intltrade/exports/hs' (International Trade Exports by HS code), 'intltrade/imports/hs' (International Trade Imports by HS code), 'qwi/sa' (Quarterly Workforce Indicators), 'eits/resconst' (Residential Construction Economic Indicators), 'eits/ressales' (Residential Sales Economic Indicators). Check Census API documentation for full list of available timeseries datasets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Economic Indicators Time Series **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_EITS` Tool to query Economic Indicators Time Series (EITS) data from the US Census Bureau. Use when you need retail sales, manufacturing, housing, trade, or other economic indicator time series data. The API returns tabular data with headers and rows matching your requested variables. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested geographic queries. Used in conjunction with 'for' parameter when querying sub-geographies. | | `for` | string | No | Geographic area filter in 'type:code' format. Use 'us:*' for nationwide data. Geography support varies by indicator; many EITS datasets do not require geographic filtering. Examples: 'us:*' (United States level). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: 'cell_value' (data value), 'data_type_code' (item type), 'time_slot_id' (time slot identifier), 'error_data' (error indicator), 'category_code' (industry/category classification), 'seasonally_adj' (seasonal adjustment flag), 'time' (ISO-8601 date/time), 'time_slot_name' (time period name), 'time_slot_date' (time slot date), 'program_code' (component name), 'geo_level_code' (geography level). Example: 'cell_value,data_type_code,time_slot_id,error_data,category_code,seasonally_adj' | | `time` | string | Yes | Time period filter. Formats: 'YYYY' (specific year, e.g., '2023'), 'YYYY-MM' (specific month, e.g., '2023-06'), 'from+YYYY' (from year onwards, e.g., 'from+2020'), 'from+YYYY-MM' (from month onwards, e.g., 'from+2023-01'). | | `indicator` | string ("advm3" | "bfs" | "ftd" | "ftdadv" | "hv" | "m3" | "marts" | "mhs" | "mhs2" | "mrts" | "mrtsadv" | "mtis" | "mwts" | "mwtsadv" | "qfr" | "qpr" | "qss" | "qtax" | "resconst" | "ressales" | "vip") | Yes | Economic indicator to query. Available indicators: 'advm3' (Advance Durable Goods), 'bfs' (Business Formation Statistics), 'ftd' (International Trade), 'ftdadv' (Advance International Trade), 'hv' (Housing Vacancies), 'm3' (Manufacturers Shipments/Inventories/Orders), 'marts' (Advance Monthly Retail Sales), 'mhs' (Manufactured Homes Survey), 'mhs2' (Manufactured Housing Survey 2014+), 'mrts' (Monthly Retail Trade), 'mrtsadv' (Advance Retail Inventories), 'mtis' (Manufacturing/Trade Inventories/Sales), 'mwts' (Monthly Wholesale Trade), 'mwtsadv' (Advance Wholesale Inventories), 'qfr' (Quarterly Financial Report), 'qpr' (Quarterly Public Pensions), 'qss' (Quarterly Services Survey), 'qtax' (Quarterly State/Local Taxes), 'resconst' (New Residential Construction), 'ressales' (New Home Sales), 'vip' (Construction Spending). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Residential Construction Stats **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_EITS_RESCONST` Tool to query Residential Construction statistics from Census Bureau Economic Indicators Time Series (EITS). Use when you need housing starts, permits, completions, or under-construction data. Returns time series data including housing units (single-family, multi-family, total), construction categories (permits, starts, completions, under construction), and seasonally adjusted/non-adjusted values. Data is provided in a structured format with headers and rows, where each row contains metrics for a specific time period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Census API FIPS 'in' clause for geography specification. Used to narrow results to sub-geographies within a parent geography. Format: '{geography_level}:{code}'. | | `for` | string | No | Census API FIPS 'for' clause for geography specification. Specifies the geographic area to query. Use 'us:*' for national data. Format: '{geography_level}:{code}' or '{geography_level}:*' for all areas. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Available variables: cell_value (data value), data_type_code (construction type: SINGLE, MULTI, TOTAL, E_SINGLE, E_MULTI, E_TOTAL), time_slot_id (time slot identifier, typically '0'), error_data (error values), category_code (construction category: UNDERCONST, ASTARTS, PERMITS, COMPLETIONS, AUTHNOTSTD, STARTS, ACOMPLETIONS, APERMITS), seasonally_adj (seasonally adjusted indicator: 'yes' or 'no'), program_code, geo_level_code, time_slot_date, time_slot_name. Common combination: 'cell_value,data_type_code,time_slot_id,category_code,seasonally_adj' | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. | | `time` | string | Yes | ISO-8601 date/time value for filtering residential construction data. Supports formats: 'YYYY-MM' (specific month, e.g., '2024-01'), 'from+YYYY-MM' (data since date, e.g., 'from+2023-01'), 'to+YYYY-MM' (data before date, e.g., 'to+2024-12'), 'from+YYYY-MM+to+YYYY-MM' (data between dates, e.g., 'from+2023-01+to+2024-01'). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Residential Sales Data **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_EITS_RESSALES` Query Residential Sales statistics from Census Bureau's Economic Indicator Time Series (EITS). Use this tool to retrieve residential real estate sales data including prices, volumes, and inventory metrics over time. The API provides time-series data with seasonal adjustment options and supports filtering by time periods and geography. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | No | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Common usage: 'us:*' (national level). For residential sales, 'us:*' is typical. Other supported geographies vary by dataset. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the Residential Sales dataset. Common variables include: 'data_type_code' (data type identifier), 'time_slot_id' (time period identifier), 'seasonally_adj' (seasonal adjustment indicator), 'category_code' (category identifier), 'cell_value' (statistical value), 'error_data' (error or standard deviation data). Use 'NAME' to include geography names. Check Census API documentation for the complete list. | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. API keys increase rate limits and are recommended for production use. | | `time` | string | Yes | Time period predicate for filtering residential sales data. Typically a year (e.g., '2012', '2021') but may also accept year-month formats or date ranges depending on the dataset granularity. Format: 'YYYY' for annual data, 'YYYY-MM' for monthly data, or 'from+YYYY+to+YYYY' for ranges. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Health Insurance Estimates **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_HEALTHINS_SAHIE` Query Small Area Health Insurance Estimates (SAHIE) from the Census Bureau timeseries API. Use this tool to retrieve annual health insurance coverage estimates for U.S. counties and states. SAHIE provides model-based estimates of health insurance coverage by age, sex, race/ethnicity, and income categories. Data is available for states and counties, with estimates going back to 2008. Returns data as a structured response with headers and rows, where the first element contains column names and subsequent elements contain the data values for each geography and time period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter used to narrow results to sub-geographies. Required for certain geography combinations. Format: '{geography_level}:{code}' or multiple filters separated by spaces. Examples: 'state:06' (for counties in California), 'state:25 county:017' (for tracts in Middlesex County, MA). | | `for` | string | No | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Common examples: 'state:*' (all states), 'state:06' (California), 'county:*' (all counties), 'us:*' (national level). Omit to retrieve data for all available geographies. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the SAHIE dataset. Use 'NAME' to include geography names. Common SAHIE variables: 'YEAR' (year), 'NIC_PT' (number insured in demographic group), 'NUI_PT' (number uninsured in demographic group), 'NIPR_PT' (number insured percentage), 'NUIPR_PT' (number uninsured percentage), 'PCTIC_PT' (percent insured), 'PCTUI_PT' (percent uninsured), 'AGECAT' (age category), 'IPRCAT' (income-to-poverty ratio category), 'RACECAT' (race/ethnicity category), 'SEXCAT' (sex category). Check Census Bureau SAHIE documentation for all available variables. | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. | | `time` | string | No | Time period predicate for filtering data by year. Format: '2023' for a specific year, 'from 2020 to 2023' for a range. SAHIE provides annual estimates. Omit to retrieve all available years for the specified geography. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Household Pulse Survey Timeseries **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_HPS` Tool to query Household Pulse Survey (HPS) timeseries data measuring household experiences during the COVID-19 pandemic. Use when you need household-level statistics on topics like employment, housing, education, health, food security, and economic impacts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | Yes | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Examples: 'state:*' (all states), 'state:06' (California), 'state:36,48' (New York and Texas), 'us:1' (national level). This parameter is required by the Census API. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the HPS dataset. Common variables include: UNITS_TOTAL (total household units), EXPENSE_TOTAL (total expenses), WEEK (survey week), STATE (state identifier), NAME (geographic name). Use 'NAME' to include geographic area names in results. | | `WEEK` | string | No | Filter by specific survey week number(s). Specify a single week like '1' or multiple weeks like '1,2,3'. If omitted, returns data for all survey weeks. | | `time` | string | Yes | Year or time period for the survey data. Specify a four-digit year like '2023' to retrieve data for that year. This parameter is required by the Census API. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query International Database **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_IDB` Query International Database (IDB) demographic data for 227 countries and areas worldwide. Use this tool to retrieve demographic indicators including population, fertility rates, mortality rates, life expectancy, and other demographic measures from the U.S. Census Bureau's International Database. The IDB provides historical data and projections for countries globally. Choose '1year' product for annual data with single-year age groups, or '5year' for quinquennial data with five-year age groups. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | No | Geographic filter using Census API 'for' clause. Use format 'genc standard countries and areas:CODE' to filter by country. Use '*' for all countries, or specify country codes separated by commas. Examples: 'genc standard countries and areas:US' (United States), 'genc standard countries and areas:*' (all countries), 'genc standard countries and areas:CN,IN,BR' (multiple countries). Omit to retrieve default geography. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the IDB. Available variables include: 'NAME' (geographic location name), 'YR' (year), 'POP' (total mid-year population), 'AGE' (single year of age from 0-100+), 'SEX' (sex: 0=Both, 1=Male, 2=Female), 'GENC' (GENC standard country code), 'GEO_ID' (geographic identifier). Check Census IDB documentation for full list of available variables. | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. | | `time` | string | Yes | Year for which to retrieve demographic data (ISO-8601 format). This is a required parameter specifying the year of data. Examples: '2020', '2023', '2024'. Available years depend on the product type and dataset. | | `product` | string ("1year" | "5year") | Yes | Product type for IDB timeseries data. '1year' provides single-year age groups and annual data. '5year' provides five-year age groups and quinquennial data. Use '1year' for more granular year-by-year demographic analysis. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Timeseries International Trade Exports by HS **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_INTLTRADE_EXPORTS_HS` Tool to query international trade exports by Harmonized System code from Census Bureau time series API. Use when you need export statistics filtered by time period, country, commodity, or customs district. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `get` | string | Yes | Comma-separated list of variables to retrieve from the exports dataset. Common variables include: E_COMMODITY_SDESC (export commodity short description), CTY_NAME (country name), ALL_VAL_YR (annual value), DIST_NAME (district name), CTY_CODE (country code), E_COMMODITY (harmonized system code). Example: 'E_COMMODITY_SDESC,CTY_NAME,ALL_VAL_YR,DIST_NAME' | | `time` | string | Yes | ISO-8601 Date/Time value in YYYY-MM format for filtering the time series. This parameter is required for querying specific monthly trade data. Example: '2024-01' for January 2024, '2013-01' for January 2013 | | `CTY_CODE` | string | No | Four-character country code identifier to filter results by specific country. Use this to narrow down exports to a particular country. Example: '1220' for Canada | | `DISTRICT` | string | No | Two-character district code to filter by customs district. Use this to narrow results to exports from a specific US customs district. Example: '41' for Los Angeles | | `E_COMMODITY` | string | No | Export Harmonized System code to filter by commodity type. Can be 2-, 4-, 6-, or 10-character code. Use shorter codes for broader commodity categories, longer codes for specific items. Example: '01' for live animals, '0101' for horses | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Timeseries International Trade Imports by End Use **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_INTLTRADE_IMPORTS_ENDUSE` Query international trade imports by end-use category from Census Bureau timeseries data. Use when you need monthly US import statistics categorized by product end-use (e.g., foods, industrial supplies, capital goods, automotive, consumer goods). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: I_ENDUSE (end-use category code), I_ENDUSE_LDESC (end-use long description), I_ENDUSE_SDESC (end-use short description), GEN_VAL_MO (general imports value in dollars), CON_VAL_MO (imports for consumption value in dollars), CTY_CODE (country code), CTY_NAME (country name). Use I_ENDUSE_LDESC for human-readable category names. | | `key` | string | No | Census API key for authentication. If omitted, uses the configured key from metadata. | | `time` | string | Yes | Time period in YYYY-MM format for filtering monthly data. Examples: '2024-01' for January 2024, '2023-12' for December 2023. This field is required to specify which month of trade data to retrieve. | | `CTY_CODE` | string | No | Optional country code filter to retrieve imports from a specific country. Example: '2010' for Canada, '4020' for Germany. Omit to retrieve data for all countries. | | `I_ENDUSE` | string | No | Optional end-use category code filter to retrieve imports for a specific category. Examples: '00000' for total imports, '10000' for foods/feeds/beverages, '20000' for industrial supplies, '30000' for capital goods. Omit to retrieve data for all end-use categories. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Timeseries Poverty **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_POVERTY` Query poverty statistics from the Census Bureau's timeseries poverty datasets. Use this tool to retrieve Small Area Income and Poverty Estimates (SAIPE) and historical poverty data for states, counties, and school districts. SAIPE provides annual estimates of income and poverty for all counties and school districts. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Optional parent geography filter for nested queries. Required when querying counties. Format: '{parent_geography}:{code}'. Example: 'state:06' to filter counties within California. | | `for` | string | Yes | Geographic area predicate specifying the geography level and FIPS codes. Format: '{geography_level}:{codes}'. Use '*' for all areas at that level. Common geographies: 'us:*' (national), 'state:*' (all states), 'state:06' (California), 'county:*' (all counties - requires 'in' parameter), 'school district (elementary):*' (for saipe/schdist). | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common SAIPE variables include: 'NAME' (geography name), 'SAEPOVALL_PT' (poverty estimate for all ages), 'SAEPOVRTALL_PT' (poverty rate for all ages), 'SAEPOV0_17_PT' (poverty estimate ages 0-17), 'SAEPOVRT0_17_PT' (poverty rate ages 0-17), 'SAEMHI_PT' (median household income). Check api.census.gov/data/timeseries/poverty/{product}/variables.json for the complete variable list. | | `time` | string | No | Time period filter for the data. Specify a year (e.g., '2022') or use 'from YYYY to YYYY' for ranges. SAIPE data is generally available from 1989 onwards for states and 1995 onwards for counties. | | `product` | string ("saipe" | "saipe/schdist" | "histpov2") | Yes | Poverty statistics product type: 'saipe' (Small Area Income and Poverty Estimates for states/counties), 'saipe/schdist' (school district estimates), or 'histpov2' (historical poverty tables). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query QWI Timeseries Data **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_QWI` Query Quarterly Workforce Indicators (QWI) timeseries data on employment, earnings, and job flows. Use when you need detailed labor market statistics segmented by worker demographics (age, sex, education, race/ethnicity) and firm characteristics (age, size, industry) for specific geographic areas and time periods. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for nested queries in 'geography_type:code' format. Required when querying sub-state geographies like counties. Example: 'state:06' when querying 'county:*' to get all counties in California. | | `for` | string | Yes | Geographic area predicate in 'geography_type:code' format. Use '*' for all areas at that level. Available geographies: 'us:*' (national), 'state:*' (all states), 'state:06' (California), 'county:*' (all counties - requires 'in' parameter), 'metropolitan statistical area/micropolitan statistical area:*' (metro areas). QWI data is available at national, state, metro/micro area, county, and workforce investment area levels. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common indicators: 'Emp' (employment - number of jobs), 'EmpTotal' (total quarterly employment), 'Payroll' (total quarterly payroll), 'HirA' (hires all quarters), 'Sep' (separations), 'EarnS' (average monthly earnings), 'HirAS' (hires all quarters stable jobs), 'SepS' (separations stable jobs). Include 'NAME' to get geography names. For complete variable list, see Census QWI API variables documentation. | | `sex` | string | No | Filter by gender code. Valid values: '0' (total/both sexes), '1' (male), '2' (female). Available in 'sa' and 'se' products. | | `race` | string | No | Filter by race code. Available in 'rh' product only. Common values: 'A0' (all races), 'A1' (White alone), 'A2' (Black alone), 'A3' (American Indian/Alaska Native), 'A4' (Asian alone), 'A5' (Native Hawaiian/Pacific Islander), 'A7' (Two or more races). | | `time` | string | No | Time period filter using ISO-8601 format or year-quarter notation. Format options: '2023-Q1' (single quarter), '2023' (all quarters in year), 'from+2020+to+2023' (range). The time parameter filters by the specified period. Omit to retrieve all available time periods for the geography. | | `year` | string | No | Filter by specific year(s). Format: '2023' for single year, or comma-separated for multiple years like '2022,2023'. Use either 'time' or 'year'/'quarter' parameters, not both. | | `agegrp` | string | No | Filter by age group code. Common values: 'A00' (all ages), 'A01' (14-18), 'A02' (19-21), 'A03' (22-24), 'A04' (25-34), 'A05' (35-44), 'A06' (45-54), 'A07' (55-64), 'A08' (65-99). Available in 'sa' and 'se' products. | | `firmage` | string | No | Filter by firm age group. Common values: '0' (all firm ages), '1' (0-1 years), '2' (2-3 years), '3' (4-5 years), '4' (6-10 years), '5' (11+ years). Segments data by how long the employer has been in business. | | `product` | string ("sa" | "se" | "rh") | Yes | QWI product type specifying the demographic breakdown: 'sa' for Sex/Age demographics, 'se' for Sex/Education demographics, 'rh' for Race/Ethnicity demographics. Each product provides employment and earnings data segmented by the specified demographic dimensions. | | `quarter` | string | No | Filter by specific quarter(s). Valid values: '1', '2', '3', '4', or comma-separated like '1,2'. Typically used with 'year' parameter. Use either 'time' or 'year'/'quarter' parameters, not both. | | `firmsize` | string | No | Filter by firm size group based on employment. Common values: '0' (all firm sizes), '1' (0-19 employees), '2' (20-49), '3' (50-249), '4' (250-499), '5' (500+ employees). Segments data by employer size. | | `industry` | string | No | Filter by NAICS industry code. Use 2-6 digit NAICS codes to filter by industry sector. Examples: '00' (all industries), '11' (Agriculture), '23' (Construction), '31-33' (Manufacturing), '44-45' (Retail Trade), '54' (Professional Services), '62' (Health Care). Use more digits for finer industry detail. | | `education` | string | No | Filter by education level code. Available in 'se' product only. Common values: 'E0' (all education levels), 'E1' (less than high school), 'E2' (high school), 'E3' (some college), 'E4' (bachelor's degree), 'E5' (advanced degree). | | `ethnicity` | string | No | Filter by ethnicity code. Available in 'rh' product only. Common values: 'A0' (all ethnicities), 'A1' (Not Hispanic or Latino), 'A2' (Hispanic or Latino). | | `ownercode` | string | No | Filter by ownership group. Valid values: 'A00' (all ownerships), 'A05' (private ownership). Filters data by employer ownership type. | | `seasonadj` | string ("U" | "S") | No | Seasonal adjustment indicator. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query Timeseries QWI State/Area **Slug:** `CENSUS_BUREAU_QUERY_TIMESERIES_QWI_SA` Query Quarterly Workforce Indicators (QWI) State/Area characteristics from the Census Bureau's time series API. Use when you need employment, payroll, job creation/destruction, or workforce turnover statistics by state or county for specific quarters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `in` | string | No | Parent geography filter for hierarchical queries. Required when querying sub-geographies like counties within a state. Format: 'geography_type:code'. Example: 'state:01' when querying counties to get all counties in Alabama. | | `for` | string | Yes | Geography specification in 'type:code' format. Use '*' wildcard to get all areas of a geography type. Supported geographies: 'state:01' (Alabama), 'state:*' (all states), 'county:*' (all counties, requires 'in' parameter). Geography codes follow FIPS standards. | | `get` | string | Yes | Comma-separated list of variables to retrieve from the QWI dataset. Common variables include: 'Emp' (employment), 'Payroll' (total quarterly payroll), 'EmpS' (employment stable jobs), 'EmpTotal' (total employment), 'year' (year), 'quarter' (quarter), 'NAME' (geography name). Check api.census.gov/data/timeseries/qwi/sa/variables.html for complete variable list. | | `time` | string | Yes | Time period specification in YYYY-Q# format where YYYY is the year and # is the quarter (1-4). Specifies which quarter of data to retrieve. Examples: '2023-Q1' (first quarter of 2023), '2022-Q4' (fourth quarter of 2022). Use 'from' parameter to query time ranges. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Query ZIP Business Patterns **Slug:** `CENSUS_BUREAU_QUERY_ZIP_BUSINESS_PATTERNS` Tool to query ZIP Code Business Patterns (ZBP) data including establishments and employment by ZIP code and industry. Use when you need business statistics at the ZIP code level, filtered by NAICS industry codes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `for` | string | No | Geographic level to retrieve. Use 'zipcode:XXXXX' for a specific ZIP code (e.g., 'zipcode:20002'), 'zipcode:*' for all ZIP codes. If not specified, returns data for all available geographies. | | `get` | string | Yes | Comma-separated list of variables to retrieve. Common variables: ESTAB (number of establishments), EMP (employment), PAYANN (annual payroll in $1000s), EMPSZES (employment size class of establishments), EMPSZES_LABEL (description of employment size class), NAICS2017_LABEL (industry description). Use 'NAME' to include ZIP code name. | | `key` | string | No | API key for higher rate limits and authentication | | `vintage` | integer | Yes | Reference year for ZBP data. Available years: 1994-2018. Use the most recent year for current business patterns. | | `NAICS2017` | string | No | Filter by 2017 NAICS industry code. Examples: '72' (Accommodation and Food Services), '44-45' (Retail Trade), '54' (Professional, Scientific, and Technical Services), '62' (Health Care and Social Assistance). Use 2-6 digit codes to specify industry detail level. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |