Spatial - Get Point In Polygon

Reference

Service:: Maps

API Version:: 2022-08-01

Use to determine if a given a point is inside a set of polygons.

Note

Azure Maps Spatial service retirement

The Azure Maps Spatial service is now deprecated and will be retired on 9/30/25. For more information, see End of Life Announcement of Azure Maps Spatial.

The Get Point In Polygon API is an HTTP GET request that returns a boolean value indicating whether a point is inside a set of polygons. The set of polygons is provided by a GeoJSON file which is uploaded using the Data registry service and referenced by a unique udid. The GeoJSON file may contain Polygon and MultiPolygon geometries, other geometries will be ignored if provided. If the point is inside or on the boundary of one of these polygons, the value returned is true. In all other cases, the value returned is false. When the point is inside multiple polygons, the result will give intersecting geometries section to show all valid geometries(referenced by geometryId) in user data. The maximum number of vertices accepted to form a Polygon is 10,000.

To test this API, you can upload the sample data from Post Point In Polygon API examples (Request Body) using the Data registry service and replace the {udid} from the sample request below with the udid used when creating the data registry. For more information, see How to create data registry.

GET https://{geography}.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid={udid}&lat={lat}&lon={lon}

URI Parameters

Name	In	Required	Type	Description
format	path	True	JsonFormat	Desired format of the response. Only `json` format is supported.
geography	path	True	string	Location of the Azure Maps Account. Valid values are us (East US, West Central US, West US 2) and eu (North Europe, West Europe). This parameter is required when a `udid` is supplied in the request. For example, if the Azure Maps Account is located in East US, only requests to us geography will be accepted.
api-version	query	True	string	Version number of Azure Maps API.
lat	query	True	number	The latitude of the location being passed. Example: 48.36.
lon	query	True	number	The longitude of the location being passed. Example: -124.63.
udid	query	True	string	The unique id used when creating a Data registry to upload a valid GeoJSON FeatureCollection object. Please refer to RFC 7946 for details. All the feature's properties should contain `geometryId`, which is used for identifying the geometry and is case-sensitive. For more information on the data registry service, see How to create data registry.

Request Header

Name	Required	Type	Description
x-ms-client-id		string	Specifies which account is intended for usage in conjunction with the Microsoft Entra ID 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 Microsoft Entra ID security in Azure Maps see the following articles for guidance.

Responses

Name	Type	Description
200 OK	PointInPolygonResult	OK
Other Status Codes	ErrorResponse	An unexpected error occurred.

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.

Notes

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

GetPointInPolygon

Sample request

HTTP

GET https://us.atlas.microsoft.com/spatial/pointInPolygon/json?api-version=2022-08-01&udid=f6495f62-94f8-0ec2-c252-45626f82fcb2&lat=47.622942&lon=-122.316456

Sample response

Status code:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 33.5362475,
      "lon": -111.9267386
    },
    "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2",
    "information": "4 polygons processed in user data"
  },
  "result": {
    "pointInPolygons": true,
    "intersectingGeometries": [
      "1001",
      "1003"
    ]
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
JsonFormat	Desired format of the response. Only `json` format is supported.
LatLongPairAbbreviated	A location represented as a latitude and longitude using short names 'lat' & 'lon'.
PointInPolygonResult	Returns true if point is within the polygon, false otherwise
PointInPolygonSummary	Point In Polygon Summary object
Result	Point In Polygon Result Object

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.

JsonFormat

Desired format of the response. Only json format is supported.

Name	Type	Description
json	string	The JavaScript Object Notation Data Interchange Format

LatLongPairAbbreviated

A location represented as a latitude and longitude using short names 'lat' & 'lon'.

Name	Type	Description
lat	number	Latitude property
lon	number	Longitude property

PointInPolygonResult

Returns true if point is within the polygon, false otherwise

Name	Type	Description
result	Result	Point In Polygon Result Object
summary	PointInPolygonSummary	Point In Polygon Summary object

PointInPolygonSummary

Point In Polygon Summary object

Name	Type	Description
information	string	Processing information
sourcePoint	LatLongPairAbbreviated	A location represented as a latitude and longitude using short names 'lat' & 'lon'.
udid	string	A unique data id (udid) for the uploaded content. Udid is not applicable for POST spatial operations(set to null)

Result

Point In Polygon Result Object

Name	Type	Description
intersectingGeometries	string[]	Geometries array
pointInPolygons	boolean	Point In Polygons Property

Share via