TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias AddressProperties

    The structured address components of a place, from building number up to country level.

    Not every place has all components. That 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

    The two-letter ISO 3166-1 alpha-2 country code, such as 'US', 'GB', 'NL' or 'DE'.

    countryCodeISO3?: string

    The three-letter ISO 3166-1 alpha-3 country code, such as 'USA', 'GBR', 'NLD' or '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

    The full name of the first-level administrative subdivision.

    It is set for USA, Canada and Great Britain when countrySubdivision is abbreviated, for example "California" for "CA".

    countryTertiarySubdivision?: string

    Named area or third-level administrative subdivision.

    extendedPostalCode?: string

    The extended postal code, more precise than the standard postal code.

    Its availability depends on the region.

    freeformAddress: string

    The complete formatted address.

    It follows the formatting conventions of the result's country of origin. For countries, it is the full country name.

    localName?: string

    The local area or locality name.

    It names a 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

    A formal administrative subdivision of a municipality (sub-city or super-city area). Unlike a neighborhood, it has official boundaries.

    neighborhood?: string

    An informally named area within a city, with no official boundaries. It differs 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[]

    The route or road numbers of the address, such as 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