Split Address Into Components (Geocoding)

Summary

Splits street address information into address components and creates a table or feature class with the additional components added as unique fields.

Illustration

Split Address Into Components tool illustration

Usage

  • The input address data can be a table or feature class that contains street address attributes that can be parsed or split into individual street address components.

  • You can store the input street address to be split in a single field, such as StreetName or Address, which you select as the input address field in the tool.

  • The input street address can also be in multiple fields such as when the house number and unit information are in separate fields. In this case, the fields are concatenated on the fly in the order they are selected, and the street address is split into its components.

  • Do not include zone information—such as city, neighborhood, subregion, and postal code—in the input street address. These components will not be parsed during execution and will cause incorrect results if they are included.

  • The Exceptions File parameter value should contain a row for every record for which you want to specify a custom parsing pattern. Format the file so it contains the input address field (if you have more than one field, concatenate the values into a single string) followed by the expected split address components. The field names for the split address components must match the following:

    • AddNum
    • StPreDir
    • StPreType
    • StName
    • StType
    • StDir
    • UnitType
    • UnitName
    • BuildingType
    • BuildingUnit
    • LevelType
    • LevelName
    Note:

    Not all fields are required; only those necessary based on the custom address when split into components are required.

    Note:

    For more information, download an example of an exceptions file.

    The first address in the file, 123 South Beach Avenue, is typically split into the following fields:

    AddNumStPreDirStNameStType

    123

    South

    Beach

    Avenue

    The exceptions file, however, will create the following custom split:

    AddNumStNameStType

    123

    South Beach

    Avenue

Parameters

LabelExplanationData Type
Country or Region

Specifies which country addressing structure to use for splitting addresses into components.

The default is the regional setting of the operating system.

  • AustraliaThe country code will be Australia.
  • CanadaThe country code will be Canada.
  • GermanyThe country code will be Germany.
  • Great BritainThe country code will be Great Britain.
  • United StatesThe country code will be United States.
String
Input Address Data

The table or feature class containing street address information that will be split into individual address components.

Zone information, such as city, neighborhood, subregion, and postal code, is not supported.

Table View
Input Address Fields

The field or fields in the input table or feature class that, when concatenated, will form the street address to be split. Zone information, such as city, neighborhood, subregion, and postal code, is not supported.

The order in which the fields are selected is the order the fields will be concatenated.

String
Output Address Data

The output feature class or table that will contain the split street address data.

Dataset
Exceptions File
(Optional)

The table that contains street parsing exceptions.

The table can be in any supported table format.

Table View

arcpy.geocoding.SplitAddressIntoComponents(country_code, in_address_data, in_address_fields, out_address_data, {in_exceptions})
NameExplanationData Type
country_code

Specifies which country addressing structure to use for splitting addresses into components.

The default is the regional setting of the operating system.

  • AUSThe country code will be Australia.
  • CANThe country code will be Canada.
  • DEUThe country code will be Germany.
  • GBRThe country code will be Great Britain.
  • USAThe country code will be United States.
String
in_address_data

The table or feature class containing street address information that will be split into individual address components.

Zone information, such as city, neighborhood, subregion, and postal code, is not supported.

Table View
in_address_fields
[in_address_fields,...]

The field or fields in the input table or feature class that, when concatenated, will form the street address to be split. Zone information, such as city, neighborhood, subregion, and postal code, is not supported.

The order in which the fields are selected is the order the fields will be concatenated.

String
out_address_data

The output feature class or table that will contain the split street address data.

Dataset
in_exceptions
(Optional)

The table that contains street parsing exceptions.

The table can be in any supported table format.

Table View

Code sample

SplitAddressIntoComponents example 1 (Python window)

Split a table with single-field address strings into separate components.

import arcpy
atlanta_addresses = r"C:\AtlantaAddresses.csv"
arcpy.geocoding.SplitAddressIntoComponents("USA", atlanta_addresses, "Address", 
                                           r"C:\MySplitAddresses.csv", 
                                           "ExceptionsFile.csv")

Environments

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics