Autocomplete

Typo-tolerant search-as-you-type Geo search

The Autocomplete API allows you to convert addresses and place names into Geo-Features with their Coordinates, Properties, and Shape. This can be used to let users quickly find their billing or shipping address, as well as a map component to search features on a map. Cartesius also offers search components for Leaflet, Mapbox, Maplibre, React, Angular and as Web Components. 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 be any part of any address or place in the World. You can search for places and addresses in any order. Cartesius can find addresses and places that have typos or spelled as they are spoken (phonetic search). Furthermore, you can search in any language available (up to 200+). For a detailed overview of fields that are included in the search, take a look at the Geo-Feature Model.

If you have a complete address or place name, the Forward API might be a better fit.

Examples

Minimum

https://api.cartesius.io/beta/autocomplete?apiKey=<YOUR_API_KEY>&q=Elbphil

With Filters (Bounding Box, Languages, Categories)

https://api.cartesius.io/beta/autocomplete?apiKey=<YOUR_API_KEY>&languages=de,en,es& categories=amenity:restaurant,highway&bbox=9.65,53.38,10.33,53.75&q=Elbphil

import { CartesiusClient } from "@cartesius/sdk"

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

const result = await client.autocomplete("Elbphil",
{
  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

PreviousReverse Geocoding NextForm Autocomplete

Last updated 2 years ago

hashtagExamples

hashtagResults

hashtagEndpoint Documentation

Examples

Results

Endpoint Documentation