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.

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 2014. 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

  • acs5: ACS 5 Year Estimates (2014, 2013, 2012, 2011, 2010)

  • acs1dp: ACS 1 Year Estimates, Data Profiles (2012)

  • sf1: Census Summary File 1 (2010, 2000, 1990)

  • sf3: Census Summary File 3 (2000, 1990)

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_district(fields, state_fips, district)

  • us(fields)

  • zipcode(fields, zip5)

ACS1 Geographies

  • state(fields, state_fips)

  • state_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_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)

Project details


Download files

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

Source Distribution

census-0.8.3.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

census-0.8.3-py2.py3-none-any.whl (10.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file census-0.8.3.tar.gz.

File metadata

  • Download URL: census-0.8.3.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for census-0.8.3.tar.gz
Algorithm Hash digest
SHA256 ea92b9ee443e23cc4657f4d465ba6fd1b7223960fb8229c833ed7cb69f0c69c7
MD5 2063773e51771c2daa120859cd9498f8
BLAKE2b-256 bd1980c0fc7803e00ab7b22f4e499584d1a8e1df87a517f9b1bd2dfe8bed2e25

See more details on using hashes here.

File details

Details for the file census-0.8.3-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for census-0.8.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fdeb9c5f577be0813a11a420ff25b104d7d282bdf6fea52902d2bf9779dec105
MD5 e4e907c0c88a38c7e790ada0745e2259
BLAKE2b-256 e83459f9b88caaf2d5c52682e879e4660da90dd47f32802d35d9e381555bd822

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page