Page tree
Skip to end of metadata
Go to start of metadata



This operation provides valuable information about a specific zip code. Included are many demographics codes that many users find valuable for tracking customers and statistical analysis.

URL Endpoints


JSON: 

https://trial.serviceobjects.com/GCR/api.svc/json/GetZipInfo?PostalCode={POSTALCODE}&LicenseKey={LICENSEKEY}

XML: 

https://trial.serviceobjects.com/GCR/api.svc/xml/GetZipInfo?PostalCode={POSTALCODE}&LicenseKey={LICENSEKEY}


GetZipInfo Inputs


Name

Type

Description

Zip

String

The zip for which to find demographic data.

LicenseKey

String

Your license key to use the service.
Sign up for a free trial key at
https://www.serviceobjects.com/products/address/address-geocode-us


 

GetZipInfo Outputs 


Name

Type

Values

Description

City

String

Varies

The city of the given zip code. Alternate city names are given below.

State

String

Varies

The state of the given zip code.

County

String

Varies

The county of the given zip code.

AreaCode

String

Varies

The area code of the given zip code.

CityAbbreviation

String

Varies

A common abbreviation of the city name of the given zip code.

CityType

String

N, P, U, B,
A, C, S, K

The city type of the given zip code. The city type of the given zip code. The code refers to the type of postal station in a given zip code. See table below for descriptions for each of the codes.

CountyFIPS

String

Number

County FIPS(Federal Information Processing Standard) code; used to uniquely identify counties across the US.

StateFIPS

String

Number

State FIPS(Federal Information Processing Standard) code; used to uniquely identity states.

TimeZone

String

Number

The number of hours offset from GMT. 5 = Eastern time zone.

DayLightSavings

String

Y or N

Whether the given zip code observes Day Light Savings time.

MSA

String

Varies

The Metropolitan Statistical Area Code. Used to uniquely identify a geographic area with a relatively high population density at its core.

MD

String

Varies

The Metropolitan District Code.

CBSA

String

Varies

The Core Based Statistical Area Code. A code used to identify an urban center of at least 10,000 people and adjacent areas that are socioeconomically tied to the urban center. 

PMSA

String

Varies

The Primary Metropolitan Statistical Area code. Used to uniquely identify areas that are part of a larger urban center. 

DMA

String

Varies

The Designated Market Area code. Used to uniquely identify a geographic region that receive the same(or similar) TV and radio show programs. 

Latitude

String

Number

The latitude centroid of the given zip code.

Longitude

String

Number

The longitude centroid of the given zip code.

Zip

String

Varies

The zip code input.

CityAlternativeName

ArrayOfString

Varies

A list of strings that contain alternate names for the city of the given zip code.

Error

Error

Varies

Error object indicating why the service could not return a result. See “Errors” below for more information.



CityType Code Definitions

CodeDescription
NNon Postal Community Name: Former Postal Facility 
PPost Office: An official post office branch.
UUrbanization: A postal designation specific to Puerto Rico.
BBranch: A postal facility that is not the main post office and is outside the corporate limits of a city.
AAirport Mail Facility: Facilities through which US mail is flown in and out of a city.
CCommunity Post Office: a contract postal unit providing mail services to small communities.
SStation: A post office that is not the main office for a city but is in corporate city limits.
KBulk Mail Center: Centers that handle bulk mail. Typically commercial, business and advertising mail.



References




  • No labels