Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt

Use this file to discover all available pages before exploring further.

A parser is a tool for analyzing a string with some predefined rules. Using the Addresses API parser, you can convert a string into a correctly formatted address object. The parser expects an address string in the following formats.
  • For best results, use a comma , as a delimiter.
  • Your address must follow this order: address_line_1, address_line_2, city_locality, state_province, postal_code, country_code.
  • phone and email can be in any part of the string.
11605 W Belleview Ave, Littleton, Colorado, 80127, US

​
Parse a string

Follow this example to parse a string to an address object. 
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>'

​
Try Address Parser

Use this demo to learn about the Shippo Address Parser. This demo takes an address as an input, and then displays the response from the Address Parser method as visualized content and as a JSON object.