Skip to main content

A wrapper for the US Census Bureau's API

Project description

https://travis-ci.org/datamade/census.svg?branch=master

A simple wrapper for the United States Census Bureau’s API.

Provides access to ACS, SF1, and SF3 data sets.

Install

pip install census

You may also want to install a complementary library, us, which help you figure out the FIPS codes for many geographies. We use it in the examples below.

pip install us

Usage

First, get yourself a Census API key.

from census import Census
from us import states

c = Census("MY_API_KEY")
c.acs5.get(('NAME', 'B25034_010E'),
          {'for': 'state:{}'.format(states.MD.fips)})

The call above will return the name of the geographic area and the number of homes that were built before 1939 for the state of Maryland. Helper methods have been created to simplify common geometry calls:

c.acs5.state(('NAME', 'B25034_010E'), states.MD.fips)

Full details on geometries and the states module can be found below.

The get method is the core data access method on both the ACS and SF1 data sets. The first parameter is either a single string column or a tuple of columns. The second parameter is a geoemtry dict with a for key and on option in key. The for argument accepts a “*” wildcard character or Census.ALL. The wildcard is not valid for the in parameter.

The default year is 2017 for ACS5 and ACS1 and their Data Profiles, 2013 for ACS3 and its Data Profile, 2010 for SF1, and 2000 for SF3. To access earlier data, pass a year parameter to the API call:

c.acs5.state(('NAME', 'B25034_010E'), states.MD.fips, year=2010)

The default year may also be set client-wide:

c = Census("MY_API_KEY", year=2010)

Datasets

For each dataset, the first year listed is the default.

Geographies

The API supports a wide range of geographic regions. The specification of these can be quite complicated so a number of convenience methods are provided. Refer to the Census API documentation for more geographies beyond the convenience methods.

Not all geographies are supported in all years. Calling a convenience method with a year that is not supported will raise census.UnsupportedYearException.

Geographic relationship files are provided on the Census developer site as a tool to help users compare the geographies from the 1990, 2000 and 2010 Censuses. From these files, data users may determine how geographies from one Census relate to those from the prior Census.

ACS5 Geographies

  • state(fields, state_fips)
  • state_county(fields, state_fips, county_fips)
  • state_county_blockgroup(fields, state_fips, county_fips, blockgroup)
  • state_county_subdivision(fields, state_fips, county_fips, subdiv_fips)
  • state_county_tract(fields, state_fips, county_fips, tract)
  • state_place(fields, state_fips, place)
  • state_congressional_district(fields, state_fips, congressional_district)
  • state_legislative_district_upper(fields, state_fips, legislative_district)
  • state_legislative_district_lower(fields, state_fips, legislative_district)
  • us(fields)
  • zipcode(fields, zip5)

ACS1 Geographies

  • state(fields, state_fips)
  • state_congressional_district(fields, state_fips, district)
  • us(fields)

SF1 Geographies

  • state(fields, state_fips)
  • state_county(fields, state_fips, county_fips)
  • state_county_subdivision(fields, state_fips, county_fips, subdiv_fips)
  • state_county_tract(fields, state_fips, county_fips, tract)
  • state_place(fields, state_fips, place)
  • state_congressional_district(fields, state_fips, district)
  • state_msa(fields, state_fips, msa)
  • state_csa(fields, state_fips, csa)
  • state_district_place(fields, state_fips, district, place)
  • state_zipcode(fields, state_fips, zip5)

SF3 Geometries

  • state(fields, state_fips)
  • state_county(fields, state_fips, county_fips)
  • state_county_tract(fields, state_fips, county_fips, tract)
  • state_place(fields, state_fips, place)

States

This package previously had a census.states module, but now uses the us package.

>>> from us import states
>>> print states.MD.fips
u'24'

Convert FIPS to state abbreviation using lookup():

>>> print states.lookup('24').abbr
u'MD'

BYOS - Bring Your Own Session

If you’d prefer to use a custom configured requests.Session, you can pass it to the Census constructor:

s = requests.session()
s.headers.update({'User-Agent': 'census-demo/0.0'})

c = Census("MY_API_KEY", session=s)

You can also replace the session used by a specific data set:

c.sf1.session = s

Examples

The geographic name for all census tracts for county 170 in Alaska:

c.sf1.get('NAME', geo={'for': 'tract:*',
                       'in': 'state:{} county:170'.format(states.AK.fips)})

The same call using the state_county_tract convenience method:

c.sf1.state_county_tract('NAME', states.AK.fips, '170', Census.ALL)

Total number of males age 5 - 9 for all states:

c.acs5.get('B01001_004E', {'for': 'state:*'})

The same call using the state convenience method:

c.acs5.state('B01001_004E', Census.ALL)

Don’t know the list of tables in a survey, try this:

c.acs5.tables()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for census, version 0.8.14
Filename, size File type Python version Upload date Hashes
Filename, size census-0.8.14-py2.py3-none-any.whl (10.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size census-0.8.14.tar.gz (12.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page