GET api/LocationLookup/Find?zips={zips}

USPS database search. Get basic zip code location details for provided zipcodes. US only.

Request Information

URI Parameters

Name	Description	Type	Additional information
zips		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of LocationLookupResponse

Name	Type	Additional information
Zip	string	None.
City	string	None.
StateAbbr	string	None.
StateName	string	None.
CountryName	string	None.
Lat	string	None.
Lon	string	None.
Found	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Zip": "sample string 1",
    "City": "sample string 2",
    "StateAbbr": "sample string 3",
    "StateName": "sample string 4",
    "CountryName": "sample string 5",
    "Lat": "sample string 6",
    "Lon": "sample string 7",
    "Found": true
  },
  {
    "Zip": "sample string 1",
    "City": "sample string 2",
    "StateAbbr": "sample string 3",
    "StateName": "sample string 4",
    "CountryName": "sample string 5",
    "Lat": "sample string 6",
    "Lon": "sample string 7",
    "Found": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocationLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Locator.Responses">
  <LocationLookupResponse>
    <City>sample string 2</City>
    <CountryName>sample string 5</CountryName>
    <Found>true</Found>
    <Lat>sample string 6</Lat>
    <Lon>sample string 7</Lon>
    <StateAbbr>sample string 3</StateAbbr>
    <StateName>sample string 4</StateName>
    <Zip>sample string 1</Zip>
  </LocationLookupResponse>
  <LocationLookupResponse>
    <City>sample string 2</City>
    <CountryName>sample string 5</CountryName>
    <Found>true</Found>
    <Lat>sample string 6</Lat>
    <Lon>sample string 7</Lon>
    <StateAbbr>sample string 3</StateAbbr>
    <StateName>sample string 4</StateName>
    <Zip>sample string 1</Zip>
  </LocationLookupResponse>
</ArrayOfLocationLookupResponse>