TomTom Maps for JavaScript
    Preparing search index...

    Type Alias AddressProperties

    Structured address components for a place.

    Provides hierarchical address information from building number up to country level. Not all components are present for every place; availability depends on the location and data coverage.

    const address: AddressProperties = {
      freeformAddress: '1600 Pennsylvania Avenue NW, Washington, DC 20500, USA',
      streetNumber: '1600',
      streetName: 'Pennsylvania Avenue NW',
      municipality: 'Washington',
      countrySubdivision: 'DC',
      postalCode: '20500',
      countryCode: 'US',
      country: 'United States',
      countryCodeISO3: 'USA'
    };
    type AddressProperties = {
        country?: string;
        countryCode?: string;
        countryCodeISO3?: string;
        countrySecondarySubdivision?: string;
        countrySubdivision?: string;
        countrySubdivisionCodeIso?: string;
        countrySubdivisionName?: string;
        countryTertiarySubdivision?: string;
        extendedPostalCode?: string;
        freeformAddress: string;
        localName?: string;
        municipality?: string;
        municipalitySecondarySubdivision?: string;
        municipalitySubdivision?: string;
        neighborhood?: string;
        postalCode?: string;
        postalName?: string;
        routeNumbers?: string[];
        streetName?: string;
        streetNumber?: string;
    }
    Index
    country? countryCode? countryCodeISO3? countrySecondarySubdivision? countrySubdivision? countrySubdivisionCodeIso? countrySubdivisionName? countryTertiarySubdivision? extendedPostalCode? freeformAddress localName? municipality? municipalitySecondarySubdivision? municipalitySubdivision? neighborhood? postalCode? postalName? routeNumbers? streetName? streetNumber?
    country?: string

    Full country name.

    countryCode?: string

    Two-letter ISO 3166-1 alpha-2 country code.

    Examples: 'US', 'GB', 'NL', 'DE'

    countryCodeISO3?: string

    Three-letter ISO 3166-1 alpha-3 country code.

    Examples: 'USA', 'GBR', 'NLD', 'DEU'

    ISO 3166-1 alpha-3 codes

    countrySecondarySubdivision?: string

    County or second-level administrative subdivision.

    countrySubdivision?: string

    State or province (first-level administrative subdivision).

    countrySubdivisionCodeIso?: string

    ISO code of the first-level administrative subdivision (e.g. "US-CA").

    countrySubdivisionName?: string

    Full name of the first-level administrative subdivision.

    Present when countrySubdivision is abbreviated. Supported for USA, Canada, and Great Britain. Example: "California" when countrySubdivision is "CA"

    countryTertiarySubdivision?: string

    Named area or third-level administrative subdivision.

    extendedPostalCode?: string

    Extended postal code.

    Availability depends on region. More precise than standard postal code.

    freeformAddress: string

    Complete formatted address string.

    Follows the formatting conventions of the result's country of origin. For countries, this is the full country name.

    localName?: string

    Local area or locality name.

    Represents a named geographic area that groups addressable objects without being an official administrative unit.

    municipality?: string

    City or town name.

    municipalitySecondarySubdivision?: string

    District within a municipality subdivision (third-level city administrative division).

    municipalitySubdivision?: string

    Formal administrative subdivision of a municipality (sub-city or super-city area). Has official boundaries, unlike a neighborhood.

    neighborhood?: string

    Informally-named area within a city, with no official boundaries. Distinct from municipalitySubdivision, which is a formal administrative division.

    postalCode?: string

    Postal code or ZIP code.

    postalName?: string

    Name of the postal code area, when the result is a postal code area itself.

    routeNumbers?: string[]

    Route/road numbers associated with the address (e.g. highway numbers).

    streetName?: string

    Street name without the building number.

    streetNumber?: string

    Building or house number on the street.

    Settings
    Member Visibility

    On This Page
    Properties