azure.maps.search package¶

class azure.maps.search.MapsSearchClient(credential: Union[azure.core.credentials.AzureKeyCredential, azure.core.credentials.TokenCredential], **kwargs: Any)[source]¶

Azure Maps Search REST APIs.

Parameters

credential (TokenCredential or AzureKeyCredential) – Credential needed for the client to connect to Azure.

Keyword Arguments

base_url (str) – Supported Maps Services or Language resource base_url (protocol and hostname, for example: ‘https://<resource-name>.mapsservices.azure.com’).
client_id (str) – Specifies which account is intended for usage with the Azure AD security model. It represents a unique ID for the Azure Maps account.
api_version (str) – The API version of the service to use for requests. It defaults to the latest service version. Setting to an older version may result in reduced feature compatibility.

begin_fuzzy_search_batch(search_queries: List[str], **kwargs) → azure.core.polling._poller.LROPoller[azure.maps.search.models._models.SearchAddressBatchResult][source]¶

Begin Search Fuzzy Batch API Request

Sends batches of fuzzy search requests. The method returns a poller for retrieving the result later.

The Search Address Batch API sends batches of queries to Search Fuzzy API using just a single API call. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Parameters: search_queries – The list of search fuzzy queries/requests to process.

The list can contain a max of 10,000 queries and must contain at least 1 query. :type search_queries: List[str] :return: The results of search batch request. :rtype: ~azure.core.polling.LROPoller[~azure.maps.search.models.SearchAddressBatchResult] :raises ~azure.core.exceptions.HttpResponseError

begin_reverse_search_address_batch(search_queries: List[str], **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.maps.search.models._models.ReverseSearchAddressBatchProcessResult][source]¶

Begin Search Address Reverse Batch API Request*

Sends batches of reverse geocoding requests. The method returns a poller for retrieving the result later.

The Search Address Batch API sends batches of queries to Search Address Reverse API. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Parameters: search_queries – The list of search fuzzy queries/requests to process.

The list can contain a max of 10,000 queries and must contain at least 1 query. :type search_queries: List[str] :return: The results of reverse search batch request. :paramtype:

~azure.core.polling.LROPoller[~azure.maps.search.models.ReverseSearchAddressBatchProcessResult]

Raises: ~azure.core.exceptions.HttpResponseError

begin_search_address_batch(search_queries: List[str], **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.maps.search.models._models.SearchAddressBatchResult][source]¶

Begin Search Address Batch API

Sends batches of geocoding requests. The method returns a poller for retrieving the result later.

The Search Address Batch API sends batches of queries to Search Address API using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Parameters: search_queries – The list of search fuzzy queries/requests to process.

The list can contain a max of 10,000 queries and must contain at least 1 query. :type search_queries: List[str] :keyword batch_id: Batch id for querying the operation. :paramtype batch_id: str :return: The results of search batch request. :rtype: ~azure.core.polling.LROPoller[~azure.maps.search.models.SearchAddressBatchResult] :raises ~azure.core.exceptions.HttpResponseError

fuzzy_search(query: str, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

Free Form Search

The basic default API is Free Form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens. This search API is the canonical ‘single line search’. The Free Form Search API is a seamless combination of POI search and geocoding. The API can also be weighted with a contextual position (lat./lon. pair), or fully constrained by a coordinate and radius, or it can be executed more generally without any geo biasing anchor point. We strongly advise you to use the ‘country_filter’ parameter to specify only the countries for which your application needs coverage, as the default behavior will be to search the entire world, potentially returning unnecessary results.

Parameters

query (str) – The applicable query string (e.g., “seattle”, “pizza”). Can also be specified as a comma separated string composed by latitude followed by longitude (e.g., “47.641268, -122.125679”). Must be properly URL encoded.

Keyword Arguments

is_type_ahead (bool) – Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
top (str) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  POI Categories API.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
coordinates (LatLon) – coordinates as (lat, lon)
country_filter (list[str]) – Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.
bounding_box (BoundingBox) – north(top), west(left), south(bottom), east(right) position of the bounding box as float. E.g. BoundingBox(west=37.553, south=-122.453, east=33.2, north=57)
language (str) – Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
min_fuzzy_level (int) – Minimum fuzziness level to be used.
max_fuzzy_level (int) – Maximum fuzziness level to be used.
index_filter (list[str or SearchIndexes]) – A comma separated list of indexes which should be utilized for the search. Item order does not matter.
brand_filter (list[str]) – A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a “,” in their name should be put into quotes.
electric_vehicle_connector_filter (list[str or ElectricVehicleConnector]) – A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.
entity_type (str or GeographicEntityType) – Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the ‘smallest entity available’.
localized_map_view (str or LocalizedMapView) – 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. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request.
operating_hours (str or OperatingHoursRange) – Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays.

Returns

The results of the search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

fuzzy_search_batch(search_queries: List[str], **kwargs: Any) → azure.maps.search.models._models.SearchAddressBatchResult[source]¶

Search Fuzzy Batch API

The Search Address Batch API sends batches of queries to Search Fuzzy API. You can call Search Address Fuzzy Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Parameters: search_queries (List[str]) – The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.
Returns: The results of search batch request.
Return type: SearchAddressBatchResult
Raises: ~azure.core.exceptions.HttpResponseError

get_geometries(geometry_ids: List[str], **kwargs: Any) → List[azure.maps.search._generated.models._models_py3.Polygon][source]¶

Get Geometries The Get Geometries service allows you to request the geometry data such as a city or country outline for a set of entities, previously retrieved from an Online Search request in GeoJSON format. The geometry ID is returned in the sourceGeometry object under “geometry” and “id” in either a Search Address or Search Fuzzy call.

Parameters: geometry_ids (list[str]) – list of geometry UUIDs string, previously retrieved from an Online Search request.
Returns: The result list of Polygon/Geometries.
Return type: List[Polygon]

get_point_of_interest_categories(**kwargs: Any) → List[azure.maps.search._generated.models._models_py3.PointOfInterestCategory][source]¶

Get POI Category Tree

POI Category API provides a full list of supported Points of Interest (POI) categories and subcategories together with their translations and synonyms. The returned content can be used to provide more meaningful results through other Search Service APIs,

Keyword Arguments: language (str) – Language in which search results should be returned. Should be one of supported IETF language tags, except NGT and NGT-Latn. Language tag is case insensitive. When data in specified language is not available for a specific field, default language is used (English).
Returns: The result as list of point of interest categories.
Return type: List[PointOfInterestCategory]
Raises: ~azure.core.exceptions.HttpResponseError

reverse_search_address(coordinates: azure.maps.search.models._models.LatLon, **kwargs: Any) → azure.maps.search.models._models.ReverseSearchAddressResult[source]¶

Search Address Reverse Batch API

There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable street address. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return address information for a given coordinate.

Parameters

coordinates (LatLon) – The applicable coordinates as (lat, lon)
language (str) – Language in which search results should be returned.

Keyword Arguments

include_speed_limit (bool) – Boolean. To enable return of the posted speed limit.
heading (int) – The directional heading of the vehicle in degrees, for travel along a segment of roadway.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
number (str) – If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number.
include_road_use (bool) – Boolean. To enable return of the road use array for reverse geocodes at street level.
road_use (list[str or RoadUseType]) – To restrict reverse geocodes to a certain type of road use.
allow_freeform_newline (bool) – Format of newlines in the formatted address.
include_match_type (bool) – Include information on the type of match the geocoder achieved in the response.
entity_type (str or GeographicEntityType) – Specifies the level of filtering performed on geographies.
localized_map_view (str or LocalizedMapView) – 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.

Returns

The results of the search

Return type

ReverseSearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

reverse_search_address_batch(search_queries: List[str], **kwargs: Any) → azure.maps.search.models._models.ReverseSearchAddressBatchProcessResult[source]¶

Search Address Reverse Batch API

The Search Address Batch API sends batches of queries to Search Address Reverse API. You can call Search Address Reverse Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Parameters: search_queries – The list of search fuzzy queries/requests to process.

The list can contain a max of 10,000 queries and must contain at least 1 query. :type search_queries: List[str] :return: The results of search batch request. :rtype: ~azure.maps.search.models.ReverseSearchAddressBatchProcessResult :raises: ~azure.core.exceptions.HttpResponseError

reverse_search_cross_street_address(coordinates: azure.maps.search.models._models.LatLon, **kwargs: Any) → azure.maps.search._generated.models._models_py3.ReverseSearchCrossStreetAddressResult[source]¶

Reverse Geocode to a Cross Street

There may be times when you need to translate a coordinate (example: 37.786505, -122.3862) into a human understandable cross street. Most often this is needed in tracking applications where you receive a GPS feed from the device or asset and wish to know what address where the coordinate is located. This endpoint will return cross street information for a given coordinate.

Parameters

coordinates (LatLon) – The applicable coordinates as (lat, lon)

Keyword Arguments

top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
heading (int) – The directional heading of the vehicle in degrees, for travel along a segment of roadway. 0 is North, 90 is East and so on, values range from -360 to 360. The precision can include up to one decimal place.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
language (str) – Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.
localized_map_view (str or LocalizedMapView) – 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. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request.

Returns

The results of the reverse search.

Return type

ReverseSearchCrossStreetAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_address(query: str, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

Address Geocoding

In many cases, the complete search service might be too much, for instance if you are only interested in traditional geocoding. Search can also be accessed for address look up exclusively. The geocoding is performed by hitting the geocode endpoint with just the address or partial address in question. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.

Parameters

query (str) – The address to search for (e.g., “1 Microsoft way, Redmond, WA”), must be properly URL encoded.

Keyword Arguments

is_type_ahead (bool) – Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
coordinates (LatLon) – coordinates as (lat, lon)
country_filter (list[str]) – Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.
bounding_box (BoundingBox) – north(top), west(left), south(bottom), east(right) position of the bounding box as float. E.g. BoundingBox(west=37.553, south=-122.453, east=33.2, north=57)
language (str) – Language in which search results should be returned.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
entity_type (str or GeographicEntityType) – Specifies the level of filtering performed on geographies.
localized_map_view (str or LocalizedMapView) – 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.

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_address_batch(search_queries: List[str], **kwargs: Any) → azure.maps.search.models._models.SearchAddressBatchResult[source]¶

Search Address Batch API

Parameters: search_queries (List[str]) – The list of search fuzzy queries/requests to process. The list can contain a max of 10,000 queries and must contain at least 1 query.
Returns: The results of search batch request.
Return type: SearchAddressBatchResult
Raises: ~azure.core.exceptions.HttpResponseError

search_along_route(query: str, max_detour_time: int, route: azure.maps.search.models._models.SearchAlongRouteOptions, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

The Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route.

Parameters

query (str) – The POI name to search for (e.g., “statue of liberty”, “starbucks”, “pizza”). Must be properly URL encoded.
max_detour_time (int) – Maximum detour time of the point of interest in seconds. Max value is 3600 seconds.
route (SearchAlongRouteOptions) – This represents the route to search along and should be a valid GeoJSON LineString type.

Keyword Arguments

top (int) – Maximum number of responses that will be returned. Default value is 10. Max value is 20.
brand_filter (list[str]) – A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a “,” in their name should be put into quotes.
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter.
electric_vehicle_connector_filter (list[str or ElectricVehicleConnector]) – A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned.
localized_map_view (str or LocalizedMapView) – 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. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.
operating_hours (str or OperatingHoursRange) – Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays.

Returns

The results of the search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_inside_geometry(query: str, geometry: Union[object, str], **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

The Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them.

Parameters

query (str) – The POI name to search for (e.g., “statue of liberty”, “starbucks”, “pizza”). Must be properly URL encoded.
geometry (obejct or str) – This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. We are accepting GeoJson object or geo_interface

Keyword Arguments

top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
language (str) – Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used.
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
index_filter (list[str or SearchIndexes]) – A comma separated list of indexes which should be utilized for the search. Item order does not matter.
localized_map_view (str or LocalizedMapView) – 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. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.
operating_hours (str or OperatingHoursRange) – Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays.

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_nearby_point_of_interest(coordinates: azure.maps.search.models._models.LatLon, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

**Search Nearby Point of Interest **

If you have a use case for only retrieving POI results around a specific location, the nearby

search method may be the right choice. This endpoint will only return POI results, and does not take in a search query parameter.

Keyword Arguments

top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter.
country_filter (list[str]) – Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000.
language (str) – Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
brand_filter (list[str]) – A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter.
electric_vehicle_connector_filter (list[str or ElectricVehicleConnector]) – A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types.
localized_map_view (str or LocalizedMapView) – 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.

Parameters

coordinates (LatLon) – The applicable coordinates as (lat, lon)

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_point_of_interest(query: str, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

Get POI by Name

Points of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, coordinate location and category.

Parameters

query (str) – The POI name to search for (e.g., “statue of liberty”, “starbucks”), must be properly URL encoded.

Keyword Arguments

is_type_ahead (bool) – Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories.
country_filter (list[int]) – Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.
coordinates (LatLon) – coordinates as (lat, lon)
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
bounding_box (BoundingBox) – north(top), west(left), south(bottom), east(right) position of the bounding box as float. E.g. BoundingBox(west=37.553, south=-122.453, east=33.2, north=57)
extended_postal_codes_for (list[str or PointOfInterestExtendedPostalCodes]) – Indexes for which extended postal codes should be included in the results.
brand_filter (list[str]) – A comma-separated list of brand names which could be used to restrict the result to specific brands.
electric_vehicle_connector_filter (list[str or ElectricVehicleConnector]) – A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types.
localized_map_view (str or LocalizedMapView) – 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.
operating_hours (str or OperatingHoursRange) – Hours of operation for a POI (Points of Interest).

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_point_of_interest_category(query: str, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

Get POI by Category

Points of Interest (POI) Category Search allows you to request POI results from given category. Search allows to query POIs from one category at a time. Endpoint will only return POI results which are categorized as specified. Response includes POI details such as address, coordinate location and classification.

Parameters

query (str) – The POI category to search for (e.g., “AIRPORT”, “RESTAURANT”), must be properly URL encoded.

Keyword Arguments

is_type_ahead (bool) – Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
top (int) – Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.
skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
coordinates (LatLon) – coordinates as (lat, lon)
category_filter (list[int]) – A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories.
country_filter (list[str]) – Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.
radius_in_meters (int) – The radius in meters to for the results to be constrained to the defined area.
bounding_box (BoundingBox) – north(top), west(left), south(bottom), east(right) position of the bounding box as float. E.g. BoundingBox(west=37.553, south=-122.453, east=33.2, north=57)
language (str) – Language in which search results should be returned.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
brand_filter (list[str]) – A comma-separated list of brand names which could be used to restrict the result to specific brands. Item order does not matter.
electric_vehicle_connector_filter (list[str or ElectricVehicleConnector]) – A comma-separated list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types.
localized_map_view (str or LocalizedMapView) – 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.
operating_hours (str or OperatingHoursRange) – Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays.

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

search_structured_address(structured_address: azure.maps.search.models._models.StructuredAddress, **kwargs: Any) → azure.maps.search.models._models.SearchAddressResult[source]¶

Structured Address Geocoding

Azure Address Geocoding can also be accessed for structured address look up exclusively. The geocoding search index will be queried for everything above the street level data. No POIs will be returned. Note that the geocoder is very tolerant of typos and incomplete addresses. It will also handle everything from exact street addresses or street or intersections as well as higher level geographies such as city centers, counties, states etc.

Parameters

structured_address (StructuredAddress) – structured address type

Keyword Arguments

skip (int) – Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.
extended_postal_codes_for (list[str or SearchIndexes]) – Indexes for which extended postal codes should be included in the results.
entity_type (str or GeographicEntityType) – Specifies the level of filtering performed on geographies.
localized_map_view (str or LocalizedMapView) – 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.

Returns

The results of search.

Return type

SearchAddressResult

Raises

~azure.core.exceptions.HttpResponseError

azure.maps.search package¶

Subpackages¶