TomTom Maps for JavaScript
    Preparing search index...

    Type Alias GeocodingParams

    GeocodingParams: Omit<
        CommonPlacesParams<URL, GeocodingResponseAPI> & CommonGeocodeAndFuzzySearchParams,
        "extendedPostalCodesFor",
    > & { extendedPostalCodesFor?: GeocodingIndexTypesAbbreviation[] }

    Parameters for geocoding addresses into geographic coordinates.

    Geocoding converts human-readable addresses into latitude/longitude coordinates, enabling you to place markers on maps or perform spatial operations.

    Type Declaration

    • OptionalextendedPostalCodesFor?: GeocodingIndexTypesAbbreviation[]

      Indexes for which extended postal codes should be included in the results.

      Extended postal codes provide additional postal code detail for addresses. By default, they are included for all indexes except geographic areas (Geo).

      Available index types:

      • PAD: Point Address
      • Addr: Address Range
      • Str: Street
      • Xstr: Cross Street
      • Geo: Geography

      Geographic areas (Geo) can have very long postal code lists, so they must be explicitly requested when needed.

      All indexes except Geo

      // Include extended postal codes for addresses only
      extendedPostalCodesFor: ['PAD', 'Addr']

      // Include for all indexes including geographies
      extendedPostalCodesFor: ['PAD', 'Addr', 'Str', 'Xstr', 'Geo']

    This service is optimized for address lookups and does not return POIs. For POI search, use the search service instead.

    Features:

    • Tolerant of typos and incomplete addresses
    • Handles various address formats
    • Supports street addresses, intersections, cross streets
    • Works with geographies (cities, counties, states, countries)
    • Returns structured address components
    // Geocode a complete address
    const params: GeocodingParams = {
      key: 'your-api-key',
      query: '1600 Pennsylvania Avenue NW, Washington, DC'
    };

    // Geocode with bias toward a location
    const biasedParams: GeocodingParams = {
      key: 'your-api-key',
      query: 'Main Street',
      at: [4.9041, 52.3676],  // Bias toward Amsterdam
      limit: 5
    };

    Settings

    Member Visibility