API Reference

This section contains the complete API reference for pytidycensus.

• pytidycensus package
  • CensusAPI
    • CensusAPI.BASE_URL
    • CensusAPI.__init__()
    • CensusAPI.get()
    • CensusAPI.get_geography_codes()
    • CensusAPI.get_variables()
  • set_census_api_key()
  • get_acs()
  • get_decennial()
  • get_estimates()
  • get_geography()
  • load_variables()
  • search_variables()
  • get_table_variables()
  • get_credentials()
  • Submodules
  • pytidycensus.api module
    • CensusAPI
      • CensusAPI.BASE_URL
      • CensusAPI.__init__()
      • CensusAPI.get()
      • CensusAPI.get_geography_codes()
      • CensusAPI.get_variables()
    • set_census_api_key()
  • pytidycensus.acs module
    • get_acs()
    • get_acs_variables()
  • pytidycensus.decennial module
    • get_decennial()
    • get_decennial_variables()
  • pytidycensus.estimates module
    • PopulationEstimatesError
    • InvalidGeographyError
    • InvalidVariableError
    • DataNotAvailableError
    • APIError
    • get_estimates()
    • discover_available_variables()
    • get_estimates_variables()
  • pytidycensus.geography module
    • TigerDownloader
      • TigerDownloader.BASE_URL
      • TigerDownloader.__init__()
      • TigerDownloader.download_with_wget_or_curl()
      • TigerDownloader.download_and_extract()
      • TigerDownloader.get_shapefile_path()
    • get_geography()
    • get_state_boundaries()
    • get_county_boundaries()
    • get_tract_boundaries()
    • get_block_group_boundaries()
  • pytidycensus.utils module
    • get_credentials()
    • load_county_lookup()
    • add_name_column()
    • validate_state()
    • validate_county()
    • lookup_county_fips()
    • validate_year()
    • validate_geography()
    • build_geography_params()
    • process_census_data()
    • add_margin_of_error()
  • pytidycensus.variables module
    • load_variables()
    • search_variables()
    • get_table_variables()
    • clear_cache()
    • list_available_datasets()

Main Functions

get_acs(geography[, variables, table, ...])	Obtain data from the American Community Survey (ACS).
get_decennial(geography[, variables, table, ...])	Obtain data from the US Decennial Census.
get_estimates(geography[, product, ...])	Obtain data from the US Census Bureau Population Estimates Program.
get_geography(geography[, year, state, ...])	Download and load geographic boundary data from TIGER/Line shapefiles.
load_variables(year, dataset[, survey, ...])	Load Census variables for a given dataset and year.

API Client

CensusAPI([api_key, cache_dir])

Core client for interacting with US Census Bureau APIs.

Submodules

pytidycensus.api	Core Census API client for making requests to the US Census Bureau APIs.
pytidycensus.acs	American Community Survey (ACS) data retrieval functions.
pytidycensus.decennial	Decennial Census data retrieval functions.
pytidycensus.estimates	Population estimates data retrieval functions.
pytidycensus.geography	Geographic boundary data retrieval and processing using TIGER shapefiles.
pytidycensus.variables	Census variable loading and caching functionality.
pytidycensus.utils	Utility functions for data processing and validation.

Come study with us at The George Washington University