uszipcode 0.1.2

USA zipcode programmable database, includes up-to-date census and geometry information.

Welcome to uszipcode Documentation

uszipcode is the most powerful and easy to use programmable zipcode database, and also a searchengine in Python. Besides geometry data (also boundary info), several useful census data points are also served: population, population density, total wage, average annual wage, house of units, land area, water area. The geometry and geocoding data I am using is from google map API on Mar 2016. To know more about the data, click here. Another popular zipcode Python extension has lat, lng accuracy issue, which doesn’t give me reliable results of searching by coordinate and radius.

Quick Links

• GitHub Homepage

• Online Documentation

• PyPI download

• Install

• Issue submit and feature request

• API reference and source code

Highlight:

• Rich information of zipcode is available.

>>> from uszipcode import ZipcodeSearchEngine
>>> search = ZipcodeSearchEngine()
>>> zipcode = search.by_zipcode("10001")
>>> print(zipcode)
{
    "City": "New York",
    "Density": 34035.48387096774,
    "HouseOfUnits": 12476,
    "LandArea": 0.62,
    "Latitude": 40.75368539999999,
    "Longitude": -73.9991637,
    "NEBoundLatitude": 40.8282129,
    "NEBoundLongitude": -73.9321059,
    "Population": 21102,
    "SWBoundLatitude": 40.743451,
    "SWBoungLongitude": -74.00794499999998,
    "State": "NY",
    "TotalWages": 1031960117.0,
    "WaterArea": 0.0,
    "Wealthy": 48903.42702113544,
    "Zipcode": "10001",
    "ZipcodeType": "Standard"
}

• Rich search methods are provided for getting zipcode in the way you want.

# Search zipcode within 30 miles, ordered from closest to farthest
>>> res = search.by_coordinate(39.122229, -77.133578, radius=30, returns=5)
>>> len(res) # by default 5 results returned
5
>>> for zipcode in res:
...     # do whatever you want...

# Find top 10 population zipcode
>>> res = search.by_population(lower=0, upper=999999999,
... sort_by="Population", ascending=False, returns=10)

# Find top 10 largest land area zipcode
>>> res = search.by_landarea(lower=0, upper=999999999,
... sort_by="LandArea", ascending=False, returns=10)

# Find top 10 most wealthy zipcode in new york
>>> res = search.find(city="newyork", wealthy_lower=100000,
... sort_by="Wealthy", returns=10) # at least $100,000 annual income

• Fuzzy city name and state name search enables case, space insensitive, typo tolerant input. You don’t have to know the correct spelling of the city or state. This is very helpful if you need to build a web app with it.

# Looking for Chicago and IL, but entered wrong spelling.
>>> res = search.by_city_and_state("cicago", "il")
>>> len(res) # 56 zipcodes in Chicago
56
>>> zipcode = res[0]
>>> zipcode.City
'Chicago'
>>> zipcode.State
'IL'

• You can easily sort your results by population, area, wealthy and etc…

# Find top 10 population zipcode
>>> res = search.by_population(lower=0, upper=999999999,
... sort_by="Population", ascending=False, returns=10)
>>> for zipcode in res:
...     # do whatever you want...

• Easy export to csv. Result set can be easily export to csv.

# Find all zipcode in new york
>>> res = search.by_city(city="New York", returns=0)
>>> search.export_to_csv(res, "result.csv")

Install

uszipcode is released on PyPI, so all you need is:

$ pip install uszipcode

To upgrade to latest version:

$ pip install --upgrade uszipcode