Parserator

usaddress can handle bulk parsing. It's limited to batches of 500 addresses at a time.

Request body

All fields are required in your request body.

Parameter Description
object_list A list of addresses
api_key Customer API key (GUID). Sign up here to get a key.

Response

Returns a JSON object with:

Parameter Description
meta
Parameter Description
input_object_list the list of submitted addresses
message More details if an error occurred
number_of_failed_parses The number of failed parses
number_of_successful_parses The number of successful parses
parser Parser used for processing (usaddress)
status ok or error
status_code
Status code Description
Successful request
Address is not parseable or input data is missing or format is invalid
An invalid api_key was used in the call
An expired api_key was used in the call
Unexpected service error. contact us if you encounter this [email protected]
result

A JSON array of parsed addresses. Here is the full list of available tags.

Parameter Description
input_address Submitted address
result JSON object of parsed address parts (value) with an assigned tag.
type

Identified address type.

  • Street Address
  • Intersection
  • PO Box
  • Ambiguous

Example

Let’s parse with python:

            import requests
            addresses = ['123 N West Avenue #1 Chicago, IL 60601', 
                        '123 N West Avenue #2 Chicago, IL 60601', 
                        '123 N West Avenue #3 Chicago, IL 60601']
            
            url = 'https://parserator.us/api/bulk/usaddress/'
            body = {
                  'api_key': '<YOUR API KEY>',
                  'object_list': addresses
            }
            response = requests.post(url, data=body)
          

Response:

            {
                "meta": {
                    "status": "ok",
                    "message": "",
                    "parser": "usaddress",
                    "input_object_list": [
                        "123 N West Avenue #1 Chicago, IL 60601",
                        "123 N West Avenue #2 Chicago, IL 60601",
                        "123 N West Avenue #3 Chicago, IL 60601"
                    ],
                    "number_of_successful_parses": 3,
                    "number_of_failed_parses": 0,
                    "status_code": 200
                },
                "result": [
                    {
                        "result": [
                            {
                                "value": "123",
                                "tag": "AddressNumber"
                            },
                            {
                                "value": "N",
                                "tag": "StreetNamePreDirectional"
                            },
                            {
                                "value": "West",
                                "tag": "StreetName"
                            },
                            {
                                "value": "Avenue",
                                "tag": "StreetNamePostType"
                            },
                            {
                                "value": "# 1",
                                "tag": "OccupancyIdentifier"
                            },
                            {
                                "value": "Chicago",
                                "tag": "PlaceName"
                            },
                            {
                                "value": "IL",
                                "tag": "StateName"
                            },
                            {
                                "value": "60601",
                                "tag": "ZipCode"
                            }
                        ],
                        "type": "Street Address",
                        "input_address": "123 N West Avenue #1 Chicago, IL 60601"
                    },
                    {
                        "result": [
                            {
                                "value": "123",
                                "tag": "AddressNumber"
                            },
                            {
                                "value": "N",
                                "tag": "StreetNamePreDirectional"
                            },
                            {
                                "value": "West",
                                "tag": "StreetName"
                            },
                            {
                                "value": "Avenue",
                                "tag": "StreetNamePostType"
                            },
                            {
                                "value": "# 2",
                                "tag": "OccupancyIdentifier"
                            },
                            {
                                "value": "Chicago",
                                "tag": "PlaceName"
                            },
                            {
                                "value": "IL",
                                "tag": "StateName"
                            },
                            {
                                "value": "60601",
                                "tag": "ZipCode"
                            }
                        ],
                        "type": "Street Address",
                        "input_address": "123 N West Avenue #2 Chicago, IL 60601"
                    },
                    {
                        "result": [
                            {
                                "value": "123",
                                "tag": "AddressNumber"
                            },
                            {
                                "value": "N",
                                "tag": "StreetNamePreDirectional"
                            },
                            {
                                "value": "West",
                                "tag": "StreetName"
                            },
                            {
                                "value": "Avenue",
                                "tag": "StreetNamePostType"
                            },
                            {
                                "value": "# 3",
                                "tag": "OccupancyIdentifier"
                            },
                            {
                                "value": "Chicago",
                                "tag": "PlaceName"
                            },
                            {
                                "value": "IL",
                                "tag": "StateName"
                            },
                            {
                                "value": "60601",
                                "tag": "ZipCode"
                            }
                        ],
                        "type": "Street Address",
                        "input_address": "123 N West Avenue #3 Chicago, IL 60601"
                    }
                ]
            }