This is the documentation of version 0.63.0. Go to the latest version, 1.0.0-rc.5.

Function geocodeOne

geocodeOne(
queryOrParams: string | Omit<GeocodingParams, "limit">,
): Promise<Place<GeocodingProps>>
Geocode a query and return the single best-matching place.

Convenience wrapper around geocode that returns the top result directly.
Parameters
- queryOrParams: string | Omit<GeocodingParams, "limit">
  Address or place name to geocode, or the full GeocodingParams (bar limit)
Returns Promise<Place<GeocodingProps>>
Promise resolving to the best-matching place
Throws
If no results are found for the query

Remarks
Use geocode with a limit parameter when you need to handle the case where no results are found without throwing.
Example
```
const place = await geocodeOne('Amsterdam Centraal');
console.log(place.geometry.coordinates); // [lng, lat]

const biased = await geocodeOne({ query: 'Main Street', geoBias: { position: [4.9041, 52.3676] }, signal });
```