Skip to content
/Parser

Shippo Address API (0.1)

The Shippo Address API

Address book, Address validation, and Address parsing
https://goshippo.com

Download OpenAPI description
address_v2.json
address_v2.yaml
Overview
URL
https://support.goshippo.com/hc
Shippo Support
support@shippo.zendesk.com
Languages
Servers
https://api.goshippo.com

Address Book

Store, retrieve, modify, and delete your address book contacts

Operations

Validation

Check your address is valid before creating shipping labels

Operations

Parser

Convert address strings into a correctly formatted address object

Operations

Parse Address

Request

Parses a single string into an Address model

Security
Shippo_Token
Query
addressstring(Address)required
Example: address=Shippo 731 Market St #200, San Francisco, CA 94103 US shippo@shippo.com +1-555-999-8888
curl -i -X GET \
'https://api.goshippo.com/v2/addresses/parse?address=Shippo%20731%20Market%20St%20%23200%2C%20San%20Francisco%2C%20CA%2094103%20US%20shippo%40shippo.com%20%2B1-555-999-8888' \
-H 'Authorization: ShippoToken <API_TOKEN>'

Responses

Successful Response

Bodyapplication/json
emailEmail (string) or Email (null)(Email)
Example: "user@shippo.com"
Any of:
string(email)(Email)
phonePhone (string) or Phone (null)(Phone)
Example: "+1-4155550132"
Any of:
string(Phone)
address_line_1Address Line 1 (string) or Address Line 1 (null)(Address Line 1)
Example: "731 Market Street"
Any of:
string(Address Line 1)
address_line_2Address Line 2 (string) or Address Line 2 (null)(Address Line 2)
Example: "#200"
Any of:
string(Address Line 2)
city_localityCity Locality (string) or City Locality (null)(City Locality)
Example: "San Francisco"
Any of:
string(City Locality)
state_provinceState Province (string) or State Province (null)(State Province)
Example: "CA"
Any of:
string(State Province)
postal_codePostal Code (string) or Postal Code (null)(Postal Code)
Example: "94103"
Any of:
string(Postal Code)
country_codeCountry Code (string) or Country Code (null)(Country Code)
Example: "US"
Any of:
string(Country Code)
Response
application/json
{
  "email": "user@shippo.com",
  "phone": "+1-4155550132",
  "address_line_1": "731 Market Street",
  "address_line_2": "#200",
  "city_locality": "San Francisco",
  "state_province": "CA",
  "postal_code": "94103",
  "country_code": "US"
}