pycancensus.search_census_regions

pycancensus.search_census_regions(search_term: str, dataset: str, level: str | None = None, use_cache: bool = True, quiet: bool = False, api_key: str | None = None) → DataFrame[source]

Search for census regions by name.

Parameters:

  • search_term (str) – Term to search for in region names.

  • dataset (str) – The dataset to search in (e.g., ‘CA16’).

  • level (str, optional) – Filter by census aggregation level.

  • use_cache (bool, default True) – If True, uses cached region list if available.

  • quiet (bool, default False) – When True, suppress messages and warnings.

  • api_key (str, optional) – API key for CensusMapper API.

Returns:

Filtered DataFrame of regions matching the search term.

Return type:

pd.DataFrame

Examples

>>> import pycancensus as pc
>>> vancouver_regions = pc.search_census_regions("Vancouver", "CA16")
>>> toronto_cmas = pc.search_census_regions("Toronto", "CA16", level="CMA")