pycancensus.search_census_vectors

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

Search for census vectors by name or description.

Parameters:

  • search_term (str) – Term to search for in vector labels or details.

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

  • type_filter (str, optional) – Filter by vector type (‘Total’, ‘Male’, ‘Female’).

  • use_cache (bool, default True) – If True, uses cached vector 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 vectors matching the search term.

Return type:

pd.DataFrame

Examples

>>> import pycancensus as pc
>>> income_vectors = pc.search_census_vectors("income", "CA16")
>>> total_pop = pc.search_census_vectors("population", "CA16", type_filter="Total")