Sign in

v10

latestSwagger 2.02026-07-13648173.5 KB

Use to get polygon data of a geographical area shape such as a city or a country region.

The Get Polygon API is an HTTP GET request that supplies polygon data of a geographical area outline such as a city or a country region.

get/search/polygon

Query parameters

api-versionstring required

The API version to use for this operation.

coordinatesnumber[] required

A point on the earth specified as a longitude and latitude. Example: &coordinates=lon,lat

viewstring

A string that represents an ISO 3166-1 Alpha-2 region/country code. This will alter Geopolitical disputed borders and labels to align with the specified user region. By default, the View parameter is set to "Auto" even if you haven't defined it in the request.

Please refer to Supported Views for details and to see the available Views.

resultType'countryRegion' | 'adminDistrict' | 'adminDistrict2' | 'postalCode' | 'postalCode2' | 'postalCode3' | 'postalCode4' | 'neighborhood' | 'locality'

The geopolitical concept to return a boundary for. If not specified, the default is countryRegion result type.

resolution'small' | 'medium' | 'large' | 'huge'

Resolution determines the amount of points to send back. If not specified, the default is medium resolution.

Headers

x-ms-client-idstring

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management plane Account API. For more information on using Microsoft Entra ID security in Azure Maps, see Manage authentication in Azure Maps.

Accept-Languagestring

Language in which search results should be returned.

Please refer to Supported Languages for details.

Response

The request has succeeded.

type'Feature'

The GeoJSON object type for Feature objects. Tags each entry inside the features array of a FeatureCollection response (geocoding, reverse geocoding, autocomplete) and appears at the root of the Get Polygon response. The only value is Feature, as defined in RFC 7946.