Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AutocompleteParams

Hierarchy

  • AutocompleteParams

Index

Properties

boundary?: Boundary

You can set a boundary to filter results by a geographical region.

focus?: Focus

To focus your search based upon a geographical area, such as the center of the user's map or at the device's GPS location, supply a focus point. This boosts locally relevant results higher.

lang?: string

You can get search results in another language, if available, by specifying a target language code with your request following the BCP47 standard (https://www.rfc-editor.org/rfc/bcp/bcp47.txt).

By default, search responses are in the default locale of the dataset. However, if you include a language code, the search attempts to return place names in the language you specified.

If the language you requested is unavailable, then the default language is returned. In some cases, this is the local dialect, or it may be English for other datasets.

defaultvalue

"no"

layers?: ("address" | "venue")[]

The type of record is referred to as its layer. Due to limitations in Pelias the definitions of layers has been re-defined and limited to the following two layers:

  • venue: Stops
  • address: POI, streets, addresses, stop groups
multiModal?: "parent" | "child" | "all"

Controls whether the search returns multimodal stops, child stops of the multimodal stops, or both. Does not affect monomodal stops.

defaultvalue

'parent'

size?: number

Governs the maximum number of results. Valid values are from 1 to 100 inclusive.

sources?: string[]
tariffZoneAuthorities?: string[]
tariffZoneIds?: string[]
text: string

The search query to find matching locations for.

example

"Oslo S"

Generated using TypeDoc