USPS
App · 3 actions
Check U.S. addresses with the Postal Service: standardize an address and get its ZIP+4, whether it is deliverable, a business or vacant, look up the city and state for a ZIP Code, and find the ZIP Code for an address.
Actions
| Action | What it does |
|---|---|
| Get city and state for a ZIP Code | Get the city and state USPS has for a 5-digit ZIP Code. |
| Get ZIP Code for an address | Get the ZIP Code and ZIP+4 of a street address in a city and state. |
| Standardize address | Check a U.S. address with USPS and get it back as USPS writes it, with its ZIP+4, whether USPS confirms it is deliverable, whether it is a business or vacant, and its county. |
Get city and state for a ZIP Code
Get the city and state USPS has for a 5-digit ZIP Code.
Inputs
- ZIP Code
zip_codetextRequired - The 5-digit ZIP Code, such as 50314.
Outputs
ZIPCodetext- The ZIP Code looked up
citytext- City
foundtrue/false- Whether USPS matched the address
messagetext- USPS's reason when it found no match, else empty
statetext- Two-letter state code
Example output
{
"ZIPCode": "50314",
"city": "DES MOINES",
"found": true,
"message": null,
"state": "IA"
}Get ZIP Code for an address
Get the ZIP Code and ZIP+4 of a street address in a city and state. An address USPS can't match comes back with found set to false and the reason.
Inputs
- Street address
street_addresstextRequired - The building number and street, such as 1600 Pennsylvania Ave NW.
- Apartment or suite
secondary_addresstext - The apartment, suite or unit, such as Apt 2B. It can also go at the end of the street address.
- City
citytextRequired - The city.
- State
statetextRequired - The state.One of:
AL(Alabama (AL)),AK(Alaska (AK)),AS(American Samoa (AS)),AZ(Arizona (AZ)),AR(Arkansas (AR)),AA(Armed Forces Americas (AA)),AE(Armed Forces Europe, Middle East, Africa and Canada (AE)),AP(Armed Forces Pacific (AP)),CA(California (CA)),CO(Colorado (CO)), and 52 more. - ZIP Code
zip_codetext - The 5-digit ZIP Code, if you have one to check.
- ZIP+4
zip_plus4text - The 4 digits after the ZIP Code, when known.
- Business name
firmtext - The business at the address, up to 50 characters.
Outputs
ZIPCodetext- 5-digit ZIP Code
ZIPPlus4text- The 4 digits after the ZIP Code
addressobject- The address as USPS writes it
firmtext- The business at the address
foundtrue/false- Whether USPS matched the address
messagetext- USPS's reason when it found no match, else empty
Example output
{
"ZIPCode": "20500",
"ZIPPlus4": "0005",
"address": {
"ZIPCode": "20500",
"ZIPPlus4": "0005",
"city": "WASHINGTON",
"cityAbbreviation": "WASHINGTON",
"secondaryAddress": "",
"state": "DC",
"streetAddress": "1600 PENNSYLVANIA AVE NW",
"streetAddressAbbreviation": "1600 PENNSYLVANIA AVE NW",
"urbanization": ""
},
"firm": "",
"found": true,
"message": null
}Standardize address
Check a U.S. address with USPS and get it back as USPS writes it, with its ZIP+4, whether USPS confirms it is deliverable, whether it is a business or vacant, and its county. Give a city and state, or a ZIP Code. An address USPS can't match comes back with found set to false and the reason.
Inputs
- Street address
street_addresstextRequired - The building number and street, such as 1600 Pennsylvania Ave NW.
- Apartment or suite
secondary_addresstext - The apartment, suite or unit, such as Apt 2B. It can also go at the end of the street address.
- City
citytext - The city. Give a city and state, or a ZIP Code.
- State
statetext - The state. Give a city and state, or a ZIP Code.One of:
AL(Alabama (AL)),AK(Alaska (AK)),AS(American Samoa (AS)),AZ(Arizona (AZ)),AR(Arkansas (AR)),AA(Armed Forces Americas (AA)),AE(Armed Forces Europe, Middle East, Africa and Canada (AE)),AP(Armed Forces Pacific (AP)),CA(California (CA)),CO(Colorado (CO)), and 52 more. - ZIP Code
zip_codetext - The 5-digit ZIP Code, if known.
- ZIP+4
zip_plus4text - The 4 digits after the ZIP Code, when known.
- Business name
firmtext - The business at the address, up to 50 characters.
- Urbanization
urbanizationtext - The urbanization name, for Puerto Rico addresses only.
Outputs
additionalInfoobject- Delivery details USPS knows about the address
addressobject- The address as USPS writes it
correctionslist- What to add for a better match, such as an apartment number
firmtext- The business at the address
foundtrue/false- Whether USPS matched the address
matcheslist- 31 for an exact match
messagetext- USPS's reason when it found no match, else empty
warningslist- USPS's warnings
Example output
{
"additionalInfo": {
"DPVBusiness": "Y",
"DPVCMRA": "N",
"DPVConfirmation": "Y",
"DPVVacant": "N",
"business": "Y",
"carrierRoute": "C000",
"centralDeliveryPoint": "N",
"congressDistrict": "AL",
"countyName": "DISTRICT OF COLUMBIA",
"deliveryPoint": "00",
"vacant": "N"
},
"address": {
"ZIPCode": "20500",
"ZIPPlus4": "0005",
"city": "WASHINGTON",
"cityAbbreviation": "WASHINGTON",
"secondaryAddress": "",
"state": "DC",
"streetAddress": "1600 PENNSYLVANIA AVE NW",
"streetAddressAbbreviation": "1600 PENNSYLVANIA AVE NW",
"urbanization": ""
},
"corrections": [
{
"code": "",
"text": ""
}
],
"firm": "",
"found": true,
"matches": [
{
"code": "31",
"text": "Single Response - exact match"
}
],
"message": null,
"warnings": []
}