SmartyStreets Go SDK

If you want to access our US Street Address API or US ZIP Code API from an application written in the Go programming language, the SmartyStreets Go SDK can make it a lot easier. Our Go SDK includes ready-made data structures and takes care of all the gritty, low-level HTTP intricacies for you.

Contents

1. Requirements
2. How to Get It
   1. The 'go' Command
   2. Download the Source Code
3. How to Use It
   1. Demo
   2. Documentation
   3. Examples
4. API Reference Material

Requirements

1. Decide to build a software project using the Go programming language.
2. Download and install Go version 1.7+.
3. Setup a Go workspace.
4. Build enough of the project to realize that you now need an address verification component.
5. Wisely conclude that you don't want to build your own address verification component.
6. Realize that SmartyStreets has already created an address verification component.
7. Congratulations! You are now ready to use the SmartyStreets Go SDK.

How to Get It

The 'go' Command

The easiest way to get your giddy hands on this goodness is by using the go command at the terminal.

go get -t -u github.com/smartystreets/smartystreets-go-sdk

You can then import the SDK packages in your Go project. (See the examples below.)

Download the Source Code

You can download the source code from the SmartyStreets Go SDK repository on Github.

Use the source, Luke!

How to Use It

Demo

Documentation

If you're new to the Go community, do yourself a favor and learn about godoc and godoc.org. The Go SDK makes use of godoc conventions for documenting source code, which you can read by downloading the source code or perusing the auto-generated documentation for each package in the SDK:

Examples

Here are a few examples showing how to use the Go SDK:

• Verifying US street addresses
• Verifying international street addresses
• Finding US ZIP Codes
• Extracting US street addresses from arbitrary text
• Completing US street addresses given an prefix