Autocomplete

Download schema

deprecated

Autocomplete search

GET

https://api.entur.io/geocoder

/v1/autocomplete

Search for places by text query

Autocomplete search › query Parameters

text

string · minLength: 1 · required · style: form · explode: true

Search query

size

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

Maximum results

Default: 10

lang

string · style: form · explode: true

Language code

Default: no

boundary.country

string · style: form · explode: true

Country code filter (comma-separated)

boundary.county_ids

string · style: form · explode: true

County IDs filter (comma-separated)

boundary.locality_ids

string · style: form · explode: true

Locality IDs filter (comma-separated)

tariff_zone_ids

string · style: form · explode: true

Tariff zone IDs filter (comma-separated)

tariff_zone_authorities

string · style: form · explode: true

Tariff zone authorities filter (comma-separated)

fare_zone_authorities

string · style: form · explode: true

Fare zone authorities filter (comma-separated)

sources

string · enum · style: form · explode: true

Data sources filter (comma-separated)

Enum values:

openstreetmap

openaddresses

whosonfirst

layers

string · enum · style: form · explode: true

Layer types filter (comma-separated)

Enum values:

venue

address

categories

string · style: form · explode: true

Categories filter (comma-separated)

focus.point.lat

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

Focus latitude

focus.point.lon

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

Focus longitude

focus.scale

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

Focus scale (km)

focus.weight

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

Focus weight

multiModal

string · enum · style: form · explode: true

Multi-modal mode

Enum values:

parent

child

all

Default: parent

Autocomplete search › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Autocomplete search › Responses

Matching places

Result

type

string · enum · required

Enum values:

FeatureCollection

Feature[] · required

object · required

bbox

number[] · minItems: 4 · maxItems: 4

GET/v1/autocomplete

curl 'https://api.entur.io/geocoder/v1/autocomplete?text=Oslo S'

Example Responses

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          10.7522,
          59.911
        ]
      },
      "properties": {
        "id": "NSR:StopPlace:59872",
        "gid": "openstreetmap:venue:NSR:StopPlace:59872",
        "name": "Oslo S",
        "label": "Oslo S, Oslo",
        "layer": "venue",
        "county": "Oslo",
        "source": "openstreetmap",
        "accuracy": "point",
        "category": [
          "onstreetBus",
          "railStation"
        ],
        "locality": "Oslo",
        "country_a": "NOR",
        "source_id": "NSR:StopPlace:59872",
        "county_gid": "whosonfirst:county:KVE:TopographicPlace:03",
        "locality_gid": "whosonfirst:locality:KVE:TopographicPlace:0301",
        "tariff_zones": [
          "RUT:TariffZone:1",
          "RUT:FareZone:4"
        ]
      }
    }
  ],
  "geocoding": {
    "engine": {
      "name": "Photon",
      "version": "1.2.0"
    },
    "version": "0.2",
    "timestamp": 1781174186971
  }
}

json

application/json

Reverse

Autocomplete search

GET

https://api.entur.io/geocoder

/v1/autocomplete

Search for places by text query

Autocomplete search › query Parameters

text

string · minLength: 1 · required · style: form · explode: true

Search query

size

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

Maximum results

Default: 10

lang

string · style: form · explode: true

Language code

Default: no

boundary.country

string · style: form · explode: true

Country code filter (comma-separated)

boundary.county_ids

string · style: form · explode: true

County IDs filter (comma-separated)

boundary.locality_ids

string · style: form · explode: true

Locality IDs filter (comma-separated)

tariff_zone_ids

string · style: form · explode: true

Tariff zone IDs filter (comma-separated)

tariff_zone_authorities

string · style: form · explode: true

Tariff zone authorities filter (comma-separated)

fare_zone_authorities

string · style: form · explode: true

Fare zone authorities filter (comma-separated)

sources

string · enum · style: form · explode: true

Data sources filter (comma-separated)

Enum values:

openstreetmap

openaddresses

whosonfirst

layers

string · enum · style: form · explode: true

Layer types filter (comma-separated)

Enum values:

venue

address

categories

string · style: form · explode: true

Categories filter (comma-separated)

focus.point.lat

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

Focus latitude

focus.point.lon

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

Focus longitude

focus.scale

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

Focus scale (km)

focus.weight

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

Focus weight

multiModal

string · enum · style: form · explode: true

Multi-modal mode

Enum values:

parent

child

all

Default: parent

Autocomplete search › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Autocomplete search › Responses

Matching places

Result

type

string · enum · required

Enum values:

FeatureCollection

Feature[] · required

object · required

bbox

number[] · minItems: 4 · maxItems: 4

Autocomplete

Autocomplete search

Autocomplete search › query Parameters

Autocomplete search › Headers

Autocomplete search › Responses

Build with Entur

Contribute

Terms & Policies

Autocomplete

Autocomplete search

Autocomplete search › query Parameters

Autocomplete search › Headers

Autocomplete search › Responses