pycancensus.get_census_geometry

pycancensus.get_census_geometry(dataset: str, regions: Dict[str, str | List[str]], level: str = 'Regions', resolution: str = 'simplified', use_cache: bool = True, quiet: bool = False, api_key: str | None = None) → GeoDataFrame[source]

Get census boundary geometries from the CensusMapper API.

Parameters:

  • dataset (str) – A CensusMapper dataset identifier (e.g., ‘CA16’, ‘CA21’).

  • regions (dict) – Dictionary of census regions to retrieve geometries for.

  • level (str, default 'Regions') – The census aggregation level to retrieve.

  • resolution (str, default 'simplified') – Resolution of geographic data. Either ‘simplified’ or ‘high’.

  • use_cache (bool, default True) – Whether to use cached data if available.

  • quiet (bool, default False) – Whether to suppress messages and warnings.

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

Returns:

GeoDataFrame containing census boundary geometries.

Return type:

gpd.GeoDataFrame

Examples

>>> import pycancensus as pc
>>> # Get geometries for Vancouver CMA
>>> geometries = pc.get_census_geometry(
...     dataset='CA16',
...     regions={'CMA': '59933'},
...     level='CSD'
... )