provider geocode GET /geocode/search
@utdk/openrouteservice /geocode/search
Forward geocode an address or place name
Pelias forward geocoder. Converts a free-text address into one or more candidate coordinates with provenance, confidence, and structured address components. Restrict to a country with `boundary.country` (ISO 3166-1 alpha-2 or alpha-3) for higher-quality matches.
text query required
Free-form address or place name.
string
focus.point.lon query
Longitude to bias results toward.
number
focus.point.lat query
Latitude to bias results toward.
number
boundary.country query
ISO 3166-1 country code to restrict results to (e.g. `AU`).
string
size query
Maximum candidates to return.
integer

Try it

Authentication
Configure credentials for OpenRouteService API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

geocodesearch
GET/geocode/search
Pelias forward geocoder. Converts a free-text address into one or more candidate coordinates with provenance, confidence, and structured address components. Restrict to a country with `boundary.country` (ISO 3166-1 alpha-2 or alpha-3) for higher-quality matches.

required

Free-form address or place name.

Longitude to bias results toward.

Latitude to bias results toward.

ISO 3166-1 country code to restrict results to (e.g. `AU`).

Maximum candidates to return.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import openrouteservice from '@utdk/openrouteservice';

await openrouteservice.geocodesearch({
  "size": 10
})