Forward Geocoding

Convert Addresses and place names into Geo-Features

Forward Geocoding allows you to convert addresses and place names into Geo-Features with their Coordinates, Properties, and Shape. If you would like to learn more about the information you can retrieve, take a look at the Geo-Feature Model.

If you prefer OpenAPI/Swagger Documentations, click here.

The query string you provide can contain incomplete and incorrect addresses or full addresses in any order. It is also possible to pass natural text, such as parts of a conversation that contains geographical references, as we parse important address components out of the given string. Furthermore, you can search in any language available (up to 200+).

Forward Geocoding should not be used for prefix search, such as search-as-you-type or autocomplete. Please take a look at the Autocomplete API that covers this exact use-case.

Examples

Minimum

https://api.cartesius.io/beta/forward?apiKey=<YOUR_API_KEY>&q=Platz d. Deutschen Einheit 4, 20457 HH

import { CartesiusClient } from "@cartesius/sdk"

const client = new CartesiusClient({
  apiKey: '<YOUR-API-KEY>',
});

const result = await client.forward("Platz d. Deutschen Einheit 4, 20457 HH");

With Filters (Bounding Box, Languages, Categories)

https://api.cartesius.io/beta/forward?apiKey=<YOUR_API_KEY>&languages=de,en,es& categories=amenity:restaurant,highway&bbox=9.65,53.38,10.33,53.75&q=Platz d. Deutschen Einheit 4, 20457 HH

import { CartesiusClient } from "@cartesius/sdk"

const client = new CartesiusClient({
  apiKey: '<YOUR-API-KEY>',
});

const result = await client.forward("Platz d. Deutschen Einheit 4, 20457 HH",
{
  languages: ["deu", "en", "es"], // ISO 3166 ALPHA-2 or ALPHA-3
  fields: ["shape", "displayValue", "category"], // fields to return
  categories: [{
    type: 'amenity',
    specfication: 'restaurant'
  }, {
    type: "highway"
  }],
  bbox: {
    left: 9.65,
    bottom: 53.38,
    right:10.33,53.75
    top: 53.75
  },
  filter: {
    internetAccess: true
  }
});

Results

Results will be ranked based on popularity and population, meaning if you search for something that does not have any exact matches, results that have a higher population or popularity will have a higher sort score.

The result will be a list of valid GeoJSON Features (RFC 7946). A detailed overview of all properties with explanations can be found here.

Endpoint Documentation

PreviousAPI NextReverse Geocoding

Last updated 2 years ago

hashtagExamples

hashtagResults

hashtagEndpoint Documentation

Examples

Results

Endpoint Documentation