Autocomplete

Download schema

Autocomplete search

GET

https://api.entur.io/geocoder

/v3/autocomplete

Search for places by text query

Autocomplete search › query Parameters

q

string · style: form · explode: true

Search query. Optional when at least one filter (e.g. layers, stopPlaceTypes, fareZones) is given; the response then lists every place matching the filters (e.g. every airport, or every stop place in a fare zone).

lat

number · double · min: -90 · max: 90 · style: form · explode: true

Focus point latitude. When provided with lon, results near this point are boosted.

lon

number · double · min: -180 · max: 180 · style: form · explode: true

Focus point longitude. Must be provided together with lat.

radius

number · double · min: 0 · style: form · explode: true

Focus radius in kilometres (decimals accepted). Results within this distance from the focus point receive the strongest boost.

Default: 25

weight

number · double · min: 0 · max: 1 · style: form · explode: true

Focus weight: how strongly to prefer results near the focus point. 0 = no preference, 1 = maximum preference.

Default: 0.5

bbox

string · pattern: ^\s*-?\d+(\.\d+)?(\s… · style: form · explode: true

Restrict results to a bounding box: minLon,minLat,maxLon,maxLat. Unlike the focus point (a soft bias), this is a hard filter.

limit

integer · min: 1 · max: 100 · style: form · explode: true

Maximum number of results

Default: 10

lang

string · style: form · explode: true

Language code for result names

Default: no

layers

string[] · style: form

Layer filter. See stopPlaceTypes for how the two compose.

Enum values:

address

street

stopPlace

groupOfStopPlaces

poi

place

stopPlaceTypes

string[] · style: form

Select stop places of these NeTEx types. Without layers, returns only these stop places and excludes other layers. With layers, constrains the stopPlace layer while other requested layers are returned additively (e.g. layers=stopPlace,groupOfStopPlaces&stopPlaceTypes=railStation returns rail stations plus groups). Ignored when layers is set but omits stopPlace.

Enum values:

onstreetBus

onstreetTram

airport

railStation

metroStation

busStation

coachStation

tramStation

sources

string[] · style: form

Data source filter. These are v3 names; v2 source values (whosonfirst, geonames, openaddresses) are not accepted and match nothing. Omit the parameter to search all sources. Use layers to filter by result type.

Enum values:

openstreetmap

kartverket-matrikkelenadresse

kartverket-stedsnavn

nsr

custom-poi

countries

string[] · style: form

ISO 3166-1 alpha-2 country code filter

counties

string[] · style: form

County IDs filter

localities

string[] · style: form

Locality IDs filter

fareZones

string[] · style: form

Fare zone IDs filter. Refs must be FareZone-shaped (e.g. RUT:FareZone:1); legacy TariffZone refs are not supported. A multimodal parent matches if any of its child stops is in the zone.

fareZoneAuthorities

string[] · style: form

Fare zone authorities filter

multimodal

string · enum · style: form · explode: true

Multimodal stop place filter. Standalone (monomodal) stop places always appear; this only decides whether multimodal parents, children, or both appear alongside them: parent (default) hides multimodal children, child hides multimodal parents, all shows both

Enum values:

parent

child

all

Default: parent

Autocomplete search › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Autocomplete search › Responses

Matching places

Result

type

string · enum · required

Enum values:

FeatureCollection

Feature[] · required

Metadata · required

bbox

number[] · minItems: 4 · maxItems: 4

[minLon, minLat, maxLon, maxLat]

Example: [10.7335,59.911,10.7522,59.9144]

GET/v3/autocomplete

curl https://api.entur.io/geocoder/v3/autocomplete

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          10.7522,
          59.911
        ]
      },
      "properties": {
        "id": "NSR:StopPlace:59872",
        "names": {
          "default": "Oslo S",
          "display": "Oslo S, Oslo"
        },
        "layer": "stopPlace",
        "source": "nsr",
        "fareZones": [
          "RUT:FareZone:1"
        ],
        "transportModes": [
          {
            "mode": "rail"
          }
        ],
        "stopPlaceTypes": [
          "railStation"
        ],
        "stopPlaceRole": "parent"
      }
    }
  ],
  "metadata": {
    "query": {
      "text": "oslo s",
      "limit": 10,
      "lang": "no"
    },
    "resultCount": 1,
    "timestamp": "2025-03-04T11:00:00Z"
  }
}

json

application/json

Reverse

Did you find what you were looking for?

Autocomplete

Autocomplete search

Autocomplete search › query Parameters

Autocomplete search › Headers

Autocomplete search › Responses

Build with Entur

Contribute

Terms & Policies