SearchOptions

Search request options

  • Limit results to one or more countries. Permitted values are ISO 3166 alpha 2 country codes (e.g. US, DE, GB)

  • List of language codes which used to provide localized results, order matters.

    Locale.preferredLanguages used as default or ["en"] if none. Specify the user’s language. This parameter controls the language of the text supplied in responses, and also affects result scoring, with results matching the user’s query in the requested language being preferred over results that match in another language. For example, an autocomplete query for things that start with Frank might return Frankfurt as the first result with an English (en) language parameter, but Frankreich (“France”) with a German (de) language parameter.

    Note

    Geocoding API supports a few languages, SBS – only one

  • Specify the maximum number of results to return.

    Geocoding API supports 10 results as a maximum. The Single-Box Search (aka SBS) have very high limits.

  • Use non-strict (true) or strict (false) matching

    Specify whether the Geocoding API should attempt approximate, as well as exact, matching when performing searches (true, default), or whether it should opt out of this behavior and only attempt exact matching (false). For example, the default setting might return Washington, DC for a query of wahsington, even though the query was misspelled

    Note

    Geocoding API only

  • Coordinate to search around

  • Limit results to only those contained within the supplied bounding box. The bounding box cannot cross the 180th meridian.

  • Search origin point. This point is used for calculation of SearchResult ETA and distance fields. Set appropriate navigationProfile for better calculation of ETA. If no origin location specified, distance will be calculated based on proximity point.

    Note

    Single-Box Search API only

  • Navigation options used for proper calculation of ETA and results ranking

    Note

    Single-Box Search API only

  • Options to filter search results along the route

    Note

    Single-Box Search API only

  • Filter results to include only a subset (one or more) of the available types.

  • Do not search external records in IndexableDataProviders. Defaults to false

    Attention

    History and Favorites functionality is implemented as IndexableDataProviders

  • Radius of circle around proximity to filter indexable records

    Ignored for missing proximity value.

  • Non-verified query parameters to the server API

    Attention

    May break engine entity functionality. Do not use without SDK developers agreement

  • The locale in which results should be returned.

    This property affects the language of returned results; generally speaking, it does not determine which results are found. Components other than the language code, such as the country and script codes, are ignored.

    If locale option is set, languages option will be ignored.

    By default, this property is set to nil, causing results to be in the default language.

  • Search request options constructor

  • Search request options with custom proximity.

  • Search request options with custom bounding box.

  • Search request options with navigation options and origin.

  • Search request options with route options for Search Along the Route

  • Delay before actual search request would be sent to the server That helps to reduce pressure on the server