Package version:

Interface SearchAddressOptions

Options for searching addresses (geocoding)

Hierarchy

Properties

boundingBox?: any

Bounding box of the search range

coordinates?: any

The coordinates where results should be biased

countryCodeFilter?: Object

Counter filters that limit the search to the specified countries

entityType?: string

The entityType specifies the level of filtering performed on geographies

extendedPostalCodesFor?: Object

Indexes for which extended postal codes should be included in the results

isTypeAhead?: boolean

Whether the query should be interpreted as a partial input and the search will enter predictive mode

language?: string

Language in which search results should be returned.

localizedMapView?: string

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.

radiusInMeters?: number

The radius in meters to for the results to be constrained to the defined area

skip?: number

Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900

top?: number

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

Generated using TypeDoc