Search - Get Polygon

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 https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}

URI Parameters

Name In Required Type Description
api-version
query True

string

Version number of Azure Maps API.

coordinates
query True

number[]

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

resolution
query

ResolutionEnum

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

resultType
query

BoundaryResultTypeEnum

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

view
query

string

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.

Request Header

Name Required Type Description
x-ms-client-id

string

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. To use Azure AD security in Azure Maps see the following articles for guidance.

Accept-Language

string

Language in which search results should be returned.

Please refer to Supported Languages for details.

Responses

Name Type Description
200 OK

Boundary

OK

Media Types: "application/geo+json"

Other Status Codes

ErrorResponse

An unexpected error occurred.

Media Types: "application/geo+json"

Security

AADToken

These are the Microsoft Entra OAuth 2.0 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
  • The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Microsoft Entra ID configurations.
  • The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.
  • Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
  • For more information on Microsoft identity platform, see Microsoft identity platform overview.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.

For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: header

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

Get polygon for a city at coordinates -122.204141,47.612560

Sample request

GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small

Sample response

Content-Type: application/geo+json
{
  "type": "Feature",
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.13035,
              47.53502
            ],
            [
              -122.12882,
              47.53567
            ],
            [
              -122.12638000000001,
              47.535140000000006
            ],
            [
              -122.12378000000001,
              47.53717
            ],
            [
              -122.12068000000001,
              47.537620000000004
            ],
            [
              -122.12028000000001,
              47.538000000000004
            ],
            [
              -122.11682,
              47.537940000000006
            ],
            [
              -122.11527000000001,
              47.53609
            ],
            [
              -122.11119000000001,
              47.536080000000005
            ],
            [
              -122.11103000000001,
              47.539280000000005
            ],
            [
              -122.10832,
              47.539530000000006
            ],
            [
              -122.10830000000001,
              47.54057
            ],
            [
              -122.11006,
              47.54055
            ],
            [
              -122.10999000000001,
              47.542640000000006
            ],
            [
              -122.11185,
              47.54298000000001
            ],
            [
              -122.11183000000001,
              47.54426
            ],
            [
              -122.1114,
              47.543800000000005
            ],
            [
              -122.10936000000001,
              47.54379
            ],
            [
              -122.10912,
              47.54462
            ],
            [
              -122.10745000000001,
              47.544830000000005
            ],
            [
              -122.10808000000002,
              47.545190000000005
            ],
            [
              -122.10808000000002,
              47.54656000000001
            ],
            [
              -122.10665000000002,
              47.546580000000006
            ],
            [
              -122.10711,
              47.544700000000006
            ],
            [
              -122.10530000000001,
              47.54473
            ],
            [
              -122.1054,
              47.546910000000004
            ],
            [
              -122.10434000000001,
              47.54693
            ],
            [
              -122.10433,
              47.544830000000005
            ],
            [
              -122.10056000000002,
              47.544940000000004
            ],
            [
              -122.1007,
              47.548500000000004
            ],
            [
              -122.10194000000001,
              47.54849
            ],
            [
              -122.10194000000001,
              47.54883
            ],
            [
              -122.10194000000001,
              47.549510000000005
            ],
            [
              -122.10071,
              47.54883
            ],
            [
              -122.10048,
              47.54849
            ],
            [
              -122.10047000000002,
              47.54883
            ],
            [
              -122.10038000000002,
              47.55904
            ],
            [
              -122.09796000000001,
              47.55923000000001
            ],
            [
              -122.09870000000001,
              47.560570000000006
            ],
            [
              -122.09818000000001,
              47.56248
            ],
            [
              -122.10011000000002,
              47.56839
            ],
            [
              -122.09876000000001,
              47.56884
            ],
            [
              -122.09942000000001,
              47.569900000000004
            ],
            [
              -122.09782000000001,
              47.56983
            ],
            [
              -122.09672,
              47.58019
            ],
            [
              -122.09885000000001,
              47.58666
            ],
            [
              -122.09796000000001,
              47.59503
            ],
            [
              -122.09664000000001,
              47.602230000000006
            ],
            [
              -122.09411000000001,
              47.607240000000004
            ],
            [
              -122.09104,
              47.610240000000005
            ],
            [
              -122.08366000000001,
              47.615660000000005
            ],
            [
              -122.08008000000001,
              47.61939
            ],
            [
              -122.07904,
              47.62201
            ],
            [
              -122.07959000000001,
              47.627520000000004
            ],
            [
              -122.08008000000001,
              47.627520000000004
            ],
            [
              -122.09181000000001,
              47.627520000000004
            ],
            [
              -122.09221000000001,
              47.62717000000001
            ],
            [
              -122.09256,
              47.627520000000004
            ],
            [
              -122.11094000000001,
              47.62765
            ],
            [
              -122.11091,
              47.636720000000004
            ],
            [
              -122.11091,
              47.64609
            ],
            [
              -122.11431,
              47.646060000000006
            ],
            [
              -122.11437000000001,
              47.64533
            ],
            [
              -122.11597,
              47.64374
            ],
            [
              -122.12254000000001,
              47.638510000000004
            ],
            [
              -122.12542,
              47.636720000000004
            ],
            [
              -122.12809000000001,
              47.635200000000005
            ],
            [
              -122.13241000000001,
              47.63515
            ],
            [
              -122.13234000000001,
              47.63268
            ],
            [
              -122.13407000000001,
              47.63156000000001
            ],
            [
              -122.13484000000001,
              47.62935
            ],
            [
              -122.13626000000001,
              47.62820000000001
            ],
            [
              -122.1372,
              47.627860000000005
            ],
            [
              -122.14184000000002,
              47.62787
            ],
            [
              -122.14321000000001,
              47.62713
            ],
            [
              -122.14312000000001,
              47.636720000000004
            ],
            [
              -122.14335000000001,
              47.660590000000006
            ],
            [
              -122.1641,
              47.66077000000001
            ],
            [
              -122.16453000000001,
              47.646370000000005
            ],
            [
              -122.16797000000001,
              47.64621
            ],
            [
              -122.19629,
              47.64643
            ],
            [
              -122.19629,
              47.64289
            ],
            [
              -122.19846000000001,
              47.642860000000006
            ],
            [
              -122.19846000000001,
              47.64242
            ],
            [
              -122.19982000000002,
              47.6424
            ],
            [
              -122.20169000000001,
              47.644600000000004
            ],
            [
              -122.20341,
              47.643190000000004
            ],
            [
              -122.20818000000001,
              47.6435
            ],
            [
              -122.21014000000001,
              47.643130000000006
            ],
            [
              -122.20962000000002,
              47.642920000000004
            ],
            [
              -122.20974000000001,
              47.636720000000004
            ],
            [
              -122.21005000000001,
              47.62107
            ],
            [
              -122.22268000000001,
              47.62106000000001
            ],
            [
              -122.22268000000001,
              47.62066
            ],
            [
              -122.22203,
              47.620470000000005
            ],
            [
              -122.22282000000001,
              47.619890000000005
            ],
            [
              -122.22142000000001,
              47.618570000000005
            ],
            [
              -122.22248,
              47.61838
            ],
            [
              -122.22271,
              47.617200000000004
            ],
            [
              -122.22136,
              47.617180000000005
            ],
            [
              -122.21985000000001,
              47.61643
            ],
            [
              -122.22044000000001,
              47.614470000000004
            ],
            [
              -122.22033,
              47.603840000000005
            ],
            [
              -122.22043000000001,
              47.59682
            ],
            [
              -122.21702,
              47.59038
            ],
            [
              -122.21653,
              47.59042
            ],
            [
              -122.21572,
              47.588240000000006
            ],
            [
              -122.21067000000001,
              47.58375
            ],
            [
              -122.20153,
              47.57887
            ],
            [
              -122.20227000000001,
              47.57864000000001
            ],
            [
              -122.20132000000001,
              47.578770000000006
            ],
            [
              -122.20034000000001,
              47.57822
            ],
            [
              -122.19901000000002,
              47.57592
            ],
            [
              -122.19923000000001,
              47.567460000000004
            ],
            [
              -122.20034000000001,
              47.55962
            ],
            [
              -122.20072,
              47.55966
            ],
            [
              -122.20114000000001,
              47.557520000000004
            ],
            [
              -122.20119000000001,
              47.54943
            ],
            [
              -122.20160000000001,
              47.549440000000004
            ],
            [
              -122.20167000000001,
              47.54883
            ],
            [
              -122.20200000000001,
              47.54609000000001
            ],
            [
              -122.19676000000001,
              47.54621
            ],
            [
              -122.19545000000001,
              47.54609000000001
            ],
            [
              -122.19545000000001,
              47.545750000000005
            ],
            [
              -122.19091000000002,
              47.54580000000001
            ],
            [
              -122.1907,
              47.54216
            ],
            [
              -122.18581,
              47.542100000000005
            ],
            [
              -122.18116,
              47.541140000000006
            ],
            [
              -122.17142000000001,
              47.54086
            ],
            [
              -122.16987,
              47.54008
            ],
            [
              -122.16797000000001,
              47.540060000000004
            ],
            [
              -122.16554000000001,
              47.54005
            ],
            [
              -122.16439000000001,
              47.54281
            ],
            [
              -122.16433,
              47.545480000000005
            ],
            [
              -122.15356000000001,
              47.54538
            ],
            [
              -122.15359000000001,
              47.541760000000004
            ],
            [
              -122.14280000000001,
              47.541520000000006
            ],
            [
              -122.14288,
              47.539370000000005
            ],
            [
              -122.13645000000001,
              47.53826
            ],
            [
              -122.13035,
              47.53502
            ]
          ],
          [
            [
              -122.19957000000001,
              47.58372000000001
            ],
            [
              -122.20448,
              47.583830000000006
            ],
            [
              -122.20585000000001,
              47.586780000000005
            ],
            [
              -122.19654000000001,
              47.586740000000006
            ],
            [
              -122.19655000000002,
              47.58379
            ],
            [
              -122.19957000000001,
              47.58372000000001
            ]
          ]
        ]
      }
    ]
  },
  "properties": {
    "name": "Bellevue",
    "copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
    "copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
    "geometriesCopyright": [
      {
        "sourceName": "TOM",
        "copyright": "TomTom"
      }
    ]
  }
}

Definitions

Name Description
Boundary

GeoJSON GeocodingFeature object that describe the boundaries of a geographical area. Geometry of the feature is described with GeoJSON GeometryCollection.

Please note, the service typically returns a GeometryCollection with Polygon or MultiPolygon sub-types.

BoundaryResultTypeEnum

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GeoJsonGeometry

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

GeoJsonGeometryCollection

A valid GeoJSON GeometryCollection object type. Please refer to RFC 7946 for details.

GeoJsonLineString

A valid GeoJSON LineString geometry type. Please refer to RFC 7946 for details.

GeoJsonMultiLineString

A valid GeoJSON MultiLineString geometry type. Please refer to RFC 7946 for details.

GeoJsonMultiPoint

A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

GeoJsonMultiPolygon

A valid GeoJSON MultiPolygon object type. Please refer to RFC 7946 for details.

GeoJsonPoint

A valid GeoJSON Point geometry type. Please refer to RFC 7946 for details.

GeoJsonPolygon

A valid GeoJSON Polygon geometry type. Please refer to RFC 7946 for details.

GeometryCopyright

Copyright information of a geometry of a Boundary object.

ResolutionEnum

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

Boundary

GeoJSON GeocodingFeature object that describe the boundaries of a geographical area. Geometry of the feature is described with GeoJSON GeometryCollection.

Please note, the service typically returns a GeometryCollection with Polygon or MultiPolygon sub-types.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

copyright

string

The copyright string.

copyrightURL

string

A URL that lists many of the data providers for Azure Maps and their related copyright information.

featureType

string

The type of the feature. The value depends on the data model the current feature is part of. Some data models may have an empty value.

geometriesCopyright

GeometryCopyright[]

A collection of copyright information for each geometry of the Boundary object in the same order they appear.

geometry GeoJsonGeometry:

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

id

string

Identifier for the feature.

name

string

The name associated with the geographical area.

type string:

Feature

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

BoundaryResultTypeEnum

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

Name Type Description
adminDistrict

string

First administrative level within the country/region level, such as a state or a province.

adminDistrict2

string

Second administrative level within the country/region level, such as a county.

countryRegion

string

Country or region.

locality

string

A concentrated area of human settlement, such as a city, town or village.

neighborhood

string

A section of a populated place that is typically well-known, but often with indistinct boundaries.

postalCode

string

The smallest post code category, such as a zip code.

postalCode2

string

The next largest post code category after postalCode that is created by aggregating postalCode areas.

postalCode3

string

The next largest post code category after postalCode2 that is created by aggregating postalCode2 areas.

postalCode4

string

The next largest post code category after postalCode3 that is created by aggregating postalCode3 areas.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

GeoJsonGeometry

A valid GeoJSON geometry object. The type must be one of the seven valid GeoJSON geometry types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon and GeometryCollection. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

type

GeoJsonObjectType

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonGeometryCollection

A valid GeoJSON GeometryCollection object type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

geometries GeoJsonGeometry[]:

Contains a list of valid GeoJSON geometry objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).

type string:

GeometryCollection

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonLineString

A valid GeoJSON LineString geometry type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

Coordinates for the GeoJson LineString geometry.

type string:

LineString

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiLineString

A valid GeoJSON MultiLineString geometry type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

Coordinates for the GeoJson MultiLineString geometry.

type string:

MultiLineString

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPoint

A valid GeoJSON MultiPoint geometry type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

Coordinates for the GeoJson MultiPoint geometry.

type string:

MultiPoint

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonMultiPolygon

A valid GeoJSON MultiPolygon object type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

Contains a list of valid GeoJSON Polygon objects. Note that coordinates in GeoJSON are in x, y order (longitude, latitude).

type string:

MultiPolygon

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPoint

A valid GeoJSON Point geometry type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

A Position is an array of numbers with two or more elements. The first two elements are longitude and latitude, precisely in that order. Altitude/Elevation is an optional third element. Please refer to RFC 7946 for details.

type string:

Point

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeoJsonPolygon

A valid GeoJSON Polygon geometry type. Please refer to RFC 7946 for details.

Name Type Description
bbox

number[]

Bounding box. Projection used - EPSG:3857. Please refer to RFC 7946 for details.

coordinates

number[]

Coordinates for the GeoJson Polygon geometry type.

type string:

Polygon

Specifies the GeoJSON type. Must be one of the nine valid GeoJSON object types - Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature and FeatureCollection.

GeometryCopyright

Copyright information of a geometry of a Boundary object.

Name Type Description
copyright

string

The copyright string for the data provider

sourceName

string

The name of the data provider

ResolutionEnum

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

Name Type Description
huge

string

Return the boundary geometry with more or the same amount of points as large.

large

string

Return the boundary geometry with more or the same amount of points as medium.

medium

string

Return the boundary geometry with more or the same amount of points as small.

small

string

Return the boundary geometry with the least amount of points.