North American Address Locator (ArcGIS 10 style)

Locators:

The North American Address Locator is a composite locator that references nine locators. Each attribute listed below is in one or more of these locators as defined for the attribute below. For example, if you use the ZIP attribute, it will only be returned for the US_Zip4 or US_Zipcode locators. A valid result will not be returned in the response unless the specific locator for an attribute was used in the request. The nine locators are:

1. US_RoofTop: Used for finding latitude and longitude of a U.S. building
2. US_Streets: Used for finding street addresses in the U.S. (e.g., 380 New York Street, Redlands, California)
3. US_ZIP4: Used for finding a U.S. ZIP+4 Code (e.g., 92373-8100)
4. US_Zipcode: Used for finding a U.S. ZIP Code (e.g., 92373)
   
5. US_CityState: Used for finding a U.S.city/state (e.g., Redlands, CA)
   
6. CAN_Streets: Used for finding street addresses in Canada (e.g., 12 Concorde Place, Toronto, Ontario)
   
7. CAN_StreetName: Used for finding a street name in Canada (Concorde Place, Toronto, Ontario)
8. CAN_Postcode: Used for finding a postal code in Canada (M3C 3R8)
9. CAN_CityProv: Used for finding a city/province in Canada (e.g., Calgary, Alberta)

Candidate sorting:

Candidate results are sorted using multiple fields in the following sequence:

• Locator Name (Loc_name): Sorted in order of individual locators in the composite locator with the most accurate locator first and the least accurate last. For U.S.: a) US_RoofTop, b) US_Streets, c) US_ZIP4, d) US_Zipcode, and e) US_CityState. For Canada: a) CAN_Streets, b) CAN_StreetName, c) CAN_Postcode, and d) CAN_CityProv.

• Shape: Geometry of the output
• Score: A percentage value assigned to all potential candidates of an address match. The match score is based on how well the location found in the reference data matches with the address being searched.
• Side: The side of the street to which the candidate has been matched: Left (L) or Right (R).
• X: Longitude of candidate point.
• Y: Latitude of candidate point.
• PreDir: Prefix of N(orth), E(ast), S(outh) or W(est) that precedes the street name (e.g., for 123 N Main Street, 'N' is the PreDir).
• PreType: Includes tag words like Freeway, Fwy, Highway, Interstate,I, etc., which may precede a number in the StreetName field (e.g., for Interstate 10, the PreType field would contain 'Interstate'  and the StreetName field would contain '10'). PreType may also include words like 'New' or 'Old' as in New Main Street or Old County Road.
• StreetName: The name of the candidate street.
• SufType: The type of street, such as Avenue, Street, Boulevard, etc. 
• SufDir: Suffix of NE, NW, SE, or SW, which follows the street name (e.g., for 123 Main Street NE, 'NE' is the SufDir).
• Match_addr: The corresponding address in the reference data for the candidate point
• City: Name of the candidate city. This field is used only for US_CityState or CAN_CityProv. City is also returned as an output field for US_Zip4 locator.
• State: Name of the candidate state. This field is used only for US_CityState. State is also returned as an output field for US_Zip4 locator.
• ZIP: ZIP Code for the candidate. This field is used only for US_Zip4 or US_Zipcode.
• ZIP4: ZIP4 of the candidate point. This field is used only for US_Zip4.
• Zip4_Type: The type of centroid identified by the US_Zip4 locator. Type 1 indicates a Zip+4 centroid (more accurate); Type 2 indicates a Zip+2 centroid (less accurate).
• Province: The province of the candidate point. This field is used only for CAN_CityProv.
• House: Returns the house number for the Address Point Locator.
• Comp_Score: This field lists all the components of an Address Point, Street Address or Street Name address that were used for matching to a record in the reference data. Each component also receives a score from 0 to 100 that indicates how well that component matched the reference data record. The possible components are house (house number), prefix (direction prefix), pretype (prefix street type), StName (street name), sufftype (suffix street type), suffix (direction suffix), city and postal.
• Postal: Returns the postal code for Canadian addresses.
• Street_ID: This field is returned by the Street Address and Address Points locators and contains the unique ID number for the street on which any given address is located.
• From Addr: This is the lower limit of an address range for any given segment of a street in the reference data.
• To Addr: This is the upper limit of an address range for any given segment of a street in the reference data.
• User_fld: When building a locator, the user has the option to return one extra field from the reference data. This field will not be used for locating an address, but simply to return extra information from the reference data. When geocoding, this information will be returned in user_fld.
• Disp_Lon: This field is returned by the Address Points locator. The geocoded point is located where the driveway meets the street. Disp_Lon represents the longitude of the centroid of either the building or parcel to which a given address is associated and will not be directly located on a street segment.
• Disp_Lat: This field is returned by the Address Points locator. The geocoded point is located where the driveway meets the street. Disp_Lat represents the latitude of the centroid of either the building or parcel to which a given address is associated and will not be directly located on a street segment.