ZIP Code Utility

• Download source files - 13.3 Kb
• Download demo project - 12 Kb

• Download the MS Access ZIP Code database (offsite, new window).

Introduction

Intrigued by Ben Fry's zipdecode [^] applet, I decided to write a little ZIP Code utility that allows lookups of U.S. locations by ZIP Code, City/State, or all three. Since the data were already in the database in the form of latitude/longitude pairs, I added the capability to find the distance between two points, and to find all other ZIP Codes within a radius of X miles from the original location.

Background

Database

The MS Access database contains the following fields:

ZIP Code � City/State lookups

The lookups are straightforward database queries using the OleDb* classes.

Distance calculation

To calculate the distance between two points, I used the Haversine Formula, which I found on the Ask Dr. Math web site.

ZIP Codes within a radius of X miles

Most ZIP Codes in the database contain latitude/longitude coordinates. To make the SQL query as simple as possible, I used a square of size 2Rx2R (where R is the radius of the circle) to encompass the search area as shown in the figure below.

This has the unfortunate side effect of searching an area ~22% larger than needed, but these "outliers" are filtered out of the result set on the client side before being returned to the calling application. I could have added a stored procedure to perform the distance calculation, but I didn't want to modify the database in any way. That way, if the author decides to update the data, (hopefully) all the users of this library will have to replace the old database file with the new one.

Now, using this approximation, the SQL query becomes as simple as this:

SELECT * 
FROM ZIP_CODES 
WHERE
    LATITUDE >= <Southern Latitude Line> AND 
    LATITUDE <= <Northern Latitude Line> AND 
    LONGITUDE >= <Western Longitude Line> AND
    LONGITUDE <= <Eastern Longitude Line>

To calculate the Northern/Southern Latitude and Western/Eastern Longitude lines, I again turned to Ask Dr. Math.

Important classes

Using the code

Using the code is very straightforward.

1. Download the ZIP Codes database (see link at top of article).
2. Compile the ZipCodeUtil library in VS.NET.
3. Add a reference to the new DLL (SagaraSoftware.ZipCodeUtil.dll) to your application.
4. Add the following appSettings to your application's config file (you'll need to add a config file if one doesn't already exist):

   <add key="ZipCodeProviderType" value="Access" />

   <add key="ZipCodeConnString" value=
   "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=
             D:\Example\Path\To\Database\zipbase.mdb" />

5. Add code to use the ZIP Code Utility library.

Here is the sample code from the example application:

(Note that in order to run the sample application, you'll first need to download the database and modify the config file to point to the database on your hard disk.)

//    Location by ZIP Code.

Location location = ZipCodeUtil.LookupByZipCode ("93275");
if (null != location)
    Console.WriteLine (location.ToString ());

//    Location(s) by City/State.

Location[] locs = ZipCodeUtil.LookupByCityState ("Tulare", "CA");
if (null != locs && locs.Length > 0)
{
    foreach (Location loc in locs)
    {
        Console.WriteLine (loc.ToString ());
    }
}

//    Location by City/State/Zip

location = ZipCodeUtil.LookupByCityStateZip ("Tulare", "CA", "93275");
if (null != location)
    Console.WriteLine (location.ToString ());

//    Distance between two locations.

Location sf = ZipCodeUtil.LookupByZipCode ("94175");
Location la = ZipCodeUtil.LookupByZipCode ("90185");
Double dDistance = sf.DistanceFrom (la);
Console.WriteLine ("{0} is {1} miles from {2}", sf.City, dDistance, la.City);

//    Other Locations within an X-mile radius of a specific location.

locs = sf.LocationsWithinRadius (5.0);
if (null != locs && locs.Length > 0)
{
    foreach (Location loc in locs)
    {
        Console.WriteLine (loc.ToString ());
    }
}

Limitations

This library relies on data from a free database that doesn't look like it has been updated since September 2001. I cannot vouch for the accuracy of this data. If you plan on using this in a production environment, you may want to invest in a commercial ZIP Codes database that is guaranteed by its maker and that is updated regularly.

To do List

• Pending approval from the creator of the database, provide MS SQL and MySQL versions.

History

• 2^nd Jan 2005 - Version 1.0.0
  • Initial release.