Location Name

Using locationName allows your users to provide a human-readable place name (e.g., "London, UK", "Mayfair, London", or "Claridge's, London") instead of coordinates. We geocode these names to lat/lon behind the scenes so you can keep using the same search API.

When to use locationName

• Use when you do not know the coordinates you would like use
• Use when your customers search for a location themselves
• Mix and match with coordinates in the same request – both are supported

Provide specific names

Geocoding works best when the input is specific. Common names can refer to multiple places.

• Prefer: "Camden, London, UK" over "Camden"
• Prefer: "Times Square, New York, USA" over "Times Square"
• Prefer: Full addresses where possible (street, city, country)

Examples

const searchRequest: SearchRequest = {
  locations: [{ locationName: "London, UK" }],
  mode: { mode: "POINT", maxDistance: 500 },
};

Performance

• Multiple names are geocoded in parallel to keep requests fast.
• If coordinates are provided, we skip geocoding entirely.

Validation

Every locations entry must include either:

• lat and lon, or
• locationName

If neither is provided, the request will be rejected.

See also