Documentation

 

Local US Street Address API

This page describes how to download, install, and run a local instance of the US Street API.

Contents

  1. Glossary
  2. API Documentation
  3. Prerequisites
  4. Minimum System Requirements
  5. Downloading the Packages
  6. Installation Procedures
  7. Managing the Local API Process
  8. Connecting to the Local API Process
  9. Updates
  10. Automation

Glossary

Throughout this document we use the following consistently formatted terms:

  • US Street API

    The product with the capabilities you wish to host on your local network.

  • us-street-data

    The first of two packages you will download and extract. Contains the necessary data files used by the running program.

  • us-street-api

    The second of two packages you will download and extract. Contains the main program and other binary resources.

  • us-street-api

    The program that you will execute. Found in the us-street-api package.

API Documentation

A local installation of the US Street API performs identically to the cloud version hosted by SmartyStreets. Please refer to the documentation for details about input and output fields.

The main difference between the local and cloud installations lies in the parts of the URL used by clients to establish a connection. (scheme://hostname:port) This will be explained in more detail later.

Prerequisites

Access to local US Street API packages and resources is currently restricted to customers with an Enterprise account. Downloading the packages also requires a valid secret key pair for authentication.

The process of downloading, installing, and managing a local instance of this API requires a system administrator or software engineer who has experience with the Linux operating system and its accompanying shell environment. We assume you have familiarity with (or at least a willingness to grapple with) the following Linux utilities and concepts:

  • mkdir (to create directories)
  • cp (to copy files)
  • tar (to extract compressed archives)
  • curl (to download packages)
  • sudo (to perform certain tasks with root-level privileges)
  • ldconfig (to refresh the linker's shared library cache)
  • $LD_LIBRARY_PATH environment variable (set to extend the linker's shared library cache)

Minimum System Requirements

The US Street API is designed to run on a Linux server that can be reached by any clients you intend to call the service. Responsibility for network and server maintainence (as well as the performance of all other operations detailed in this document) rests with your organization.

The server provisioned to run the local US Street API binaries should match the following criteria:

  • 1+ gigabytes of RAM
  • Multiple CPU cores
  • A relatively recent version of the Linux kernel (basically something that can run compiled Go programs). Anything later than v2.6.32 should function without issues.

Downloading the Packages

Running a local instance of the US Street API requires two packages that are available for download via the SmartyStreets Download API:

  • us-street-data
  • Includes all address data accessed by the us-street-api program in order to serve client requests. Here's an example command you might use to download the package:

    curl -L "https://download.api.smartystreets.com/us-street-api/data/latest.tar.gz?auth-id=YOUR_AUTH_ID&auth-token=YOUR_AUTH_TOKEN" -o us-street-data.tar.gz
  • us-street-api
  • Includes the compiled program (redundantly named us-street-api) and several shared libraries. Here's an example command you might use to download this package:

    curl -L "https://download.api.smartystreets.com/us-street-api/linux-amd64/latest.tar.gz?auth-id=YOUR_AUTH_ID&auth-token=YOUR_AUTH_TOKEN" -o us-street-api.tar.gz

See the sample script below for more details.

Installation Procedures

Both downloaded packages are gzipped archives and must be extracted (using the tar command) before they can be used.

						mkdir ./data
tar xvf us-street-data.tar.gz -C ./data
tar xvf us-street-api.tar.gz
					

Having extracted the contents of both packages you are now ready to register the included shared libraries with the linker. There are three different ways to do this. You only need choose one of the following options!

  1. Recommended Approach: Set the LD_LIBRARY_PATH environment variable to the extracted lib folder.

    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`/lib

    The above command appends the extracted lib folder to any pre-existing value in the LD_LIBRARY_PATH environment variable. Care should be taken when downloading updated versions of the package on the same machine that you don't unnecessarily append this value again. Managing the environment variables on your machine is your responsibility. Notwithstanding this slight "complexity" we encourage this approach because it doesn't require any changes to existing directories on the machine. But, if this approach isn't working, try one of the following methods.

  2. With root privileges (ie. sudo), copy the contents of the extracted lib folder to a folder included in the shared library cache. Commonly configured locations include /usr/lib and /usr/local/lib.

    sudo cp ./lib/* /usr/lib

    Some distributions (like CentOS) do not automatically acknowledge new arrivals in the shared library cache locations and so the cache must be rebuilt by running the ldconfig utility with root privileges:

    sudo ldconfig -v
  3. Add the extracted lib folder path to /etc/ld.so.conf (on it's own line) and invoke ldconfig as above. This has the effect of including the lib folder in the shared library cache.

Managing the Local API Process

  • To display the version of the program:
  • ./us-street-api -version

  • To display explanations of command-line flags and their default values:
  • ./us-street-api -help

  • To run the program:
  • ./us-street-api -data ./data -listen "localhost:8080"

NOTE: Running the us-street-api program starts a process that is desiged to run continuously until killed.

Connecting to the Local API Process

Connecting to the local us-street-api process using TLS is currently not supported. This means that the URL scheme will be http instead of https. We recommend using a private network or a proxy to establish encrypted connections if desired. Also, please note that the hostname for the local installation will not be us-street.api.smartystreets.com (the examples below use localhost). Finally, the default port for the local installation is 8080 rather than 80.

Once the us-street-api program is running, run the following command from another terminal window to send an actual HTTP request to the process:

curl "http://localhost:8080/street-address" --data-binary '[{"street": "3214 N University ave Provo UT"}]' | python -m json.tool

If everything is functioning correctly then the output should closely resemble the following JSON object:

[
    {
        "analysis": {
            "active": "Y",
            "dpv_cmra": "Y",
            "dpv_footnotes": "AABBR1",
            "dpv_match_code": "Y",
            "dpv_vacant": "N"
        },
        "candidate_index": 0,
        "components": {
            "city_name": "Provo",
            "delivery_point": "14",
            "delivery_point_check_digit": "0",
            "plus4_code": "4405",
            "primary_number": "3214",
            "state_abbreviation": "UT",
            "street_name": "University",
            "street_predirection": "N",
            "street_suffix": "Ave",
            "zipcode": "84604"
        },
        "delivery_line_1": "3214 N University Ave",
        "delivery_point_barcode": "846044405140",
        "input_index": 0,
        "last_line": "Provo UT 84604-4405",
        "metadata": {
            "carrier_route": "C016",
            "congressional_district": "03",
            "county_fips": "49049",
            "county_name": "Utah",
            "dst": true,
            "elot_sequence": "0016",
            "elot_sort": "A",
            "latitude": 40.27658,
            "longitude": -111.65759,
            "precision": "Zip9",
            "rdi": "Commercial",
            "record_type": "S",
            "time_zone": "Mountain",
            "utc_offset": -7,
            "zip_type": "Standard"
        }
    }
]

Updates

SmartyStreets publishes regular updates to both the us-street-api and us-street-data packages. We recommend that you download and install these updates on at least a monthly basis.

Automation

What follows is a script that you may use to download, install, and run a local instance of the US Street API. It's Bash. Use it as a starting point for putting in place your own update processes. Your mileage may vary. You're welcome.

#!/bin/bash

# Pro Tip:
#   Replace the placeholder auth values in the `curl` commands
#   below with your own auth-id and auth-token, or with environment
#   variables that contain your own auth-id and auth-token values.

# Download the us-street-api data package from the download API:
curl -L "https://download.api.smartystreets.com/us-street-api/linux-amd64/latest.tar.gz?auth-id=YOUR_AUTH_ID&auth-token=YOUR_AUTH_TOKEN" -o us-street-api.tar.gz

# Download the us-street-api package from the download API:
curl -L "https://download.api.smartystreets.com/us-street-api/data/latest.tar.gz?auth-id=YOUR_AUTH_ID&auth-token=YOUR_AUTH_TOKEN" -o us-street-data.tar.gz

# Extract the data package:
mkdir ./data
tar xvf us-street-data.tar.gz -C ./data

# Extract the api package:
tar xvf us-street-api.tar.gz -C .

# Register the shared libraries with the linker's cache:
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:`pwd`/lib

# Run the us-street-api:
./us-street-api -data ./data -listen "localhost:8080"
This site uses cookies for analytics, personalized content, and ads. By continuing to browse this site, you agree to this use.