Builder

Request additional metadata attributes besides the basic ones.

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

Create CategorySearchOptions instance from builder data.

Limit results to one or more countries.

When set to true and multiple categories are requested, e.g. SearchEngine.search(listOf("coffee_shop", "hotel"), ...), results will include at least one POI for each category, provided a POI is available in a nearby location.

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 Washington, even though the query was misspelled.

Specify whether to ignore com.mapbox.search.record.IndexableRecord results or not, default is false. When search by com.mapbox.search.record.IndexableRecord is enabled, the results can be matched only by query string, while other parameters like countries, languages, unsafeParameters (and some others) can be ignored.

Allows to look up for indexable records only within specified distance threshold, i.e. within a circle with this radius. Threshold specified in meters.

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. If language is not set explicitly, then language from default system locale will be used.

Specify the maximum number of results to return, including results from com.mapbox.search.record.IndexableDataProvider. The maximum number of search results is determined by server. For example, for the ApiType.SEARCH_BOX the maximum number of results to return is 25.

Type of movement. Used to alter search ranking logic: the faster you can walk/drive from the origin to the search result, the higher search result rank.

Point for alternative search ranking logic, that is turned on if navigationProfile is specified.

Bias the response to favor results that are closer to this location, provided as Point.

Request debounce value in milliseconds. Previous request will be cancelled if the new one made within specified by requestDebounce time interval.

Options to configure Route for search along the route functionality.

Non-verified query parameters, that will be added to the server API request.