Search - Post Search Inside Geometry

Applies to: see pricing tiers.

The Search Geometry endpoint allows you to perform a free form search inside a single geometry or many of them. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a POST request where the request body will contain the geometry object represented as a GeoJSON type and the Content-Type header will be set to application/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON types:

  • GeoJSON FeatureCollection
    The geometry can be represented as a GeoJSON FeatureCollection object. This is the recommended option if the geometry contains both Polygons and Circles. The FeatureCollection can contain a max of 50 GeoJSON Feature objects. Each Feature object should represent either a Polygon or a Circle with the following conditions:
    • A Feature object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.
    • A Feature object for the Circle geometry is composed of a center represented using a GeoJSON Point type and a radius value (in meters) which must be specified in the object's properties along with the subType property whose value should be 'Circle'.

    Please see the Examples section below for a sample FeatureCollection representation.

  • GeoJSON GeometryCollection
    The geometry can be represented as a GeoJSON GeometryCollection object. This is the recommended option if the geometry contains a list of Polygons only. The GeometryCollection can contain a max of 50 GeoJSON Polygon objects. Each Polygon object can have a max of 50 coordinates. Please see the Examples section below for a sample GeometryCollection representation.

  • GeoJSON Polygon
    The geometry can be represented as a GeoJSON Polygon object. This is the recommended option if the geometry contains a single Polygon. The Polygon object can have a max of 50 coordinates. Please see the Examples section below for a sample Polygon representation.

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays

URI Parameters

Name In Required Type Description
format
path True

Desired format of the response. Value can be either json or xml.

api-version
query True
  • string

Version number of Azure Maps API.

query
query True
  • string

The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza"). Must be properly URL encoded.

categorySet
query
  • array

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. Usage examples:

  • categorySet=7315 (Search Points of Interest from category Restaurant)

  • categorySet=7315025,7315017 (Search Points of Interest of category either Italian or French Restaurant)

extendedPostalCodesFor
query
  • array

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

Available indexes are:

Addr = Address ranges

Geo = Geographies

PAD = Point Addresses

POI = Points of Interest

Str = Streets

XStr = Cross Streets (intersections)

Value should be a comma separated list of index types (in any order) or None for no indexes.

By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

Usage examples:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Extended postal code is returned as an extendedPostalCode property of an address. Availability is region-dependent.

idxSet
query
  • array

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr = Address range interpolation, Geo = Geographies, PAD = Point Addresses, POI = Points of interest, Str = Streets, Xstr = Cross Streets (intersections)

language
query
  • string

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.

Please refer to Supported Languages for details.

limit
query
  • integer

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

openingHours
query

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

view
query

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/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region 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/region 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.

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.

Request Body

Name Type Description
geometry GeoJsonObject:

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

Responses

Name Type Description
200 OK

OK

Other Status Codes

An unexpected error occurred.

Security

AADToken

These are the Azure Active Directory OAuth2 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 Azure Active directory 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.

  • Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

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 you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.

For publicly exposed applications, our recommendation is to use the confidential client applications approach to access Azure Maps REST APIs so your key can be securely stored.

Type: apiKey
In: query

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

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type
Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type
Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 9,
    "numResults": 2,
    "offset": 0,
    "totalResults": 18,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596331",
      "score": 2.226,
      "info": "search:ta:840539000722333-US",
      "poi": {
        "name": "Mod Pizza",
        "phone": "+(1)-(425)-2149903",
        "brands": [
          {
            "name": "Mod Pizza"
          }
        ],
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "https://modpizza.com/locations/bellevue-overlake",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "pizza"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14309",
        "streetName": "NE 20th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.62779,
        "lon": -122.14971
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62869,
          "lon": -122.15104
        },
        "btmRightPoint": {
          "lat": 47.62689,
          "lon": -122.14838
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.62789,
            "lon": -122.14977
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596385",
      "score": 2.226,
      "info": "search:ta:840539000366535-US",
      "poi": {
        "name": "Pizza Hut",
        "phone": "+(1)-(425)-8619900",
        "brands": [
          {
            "name": "Pizza Hut"
          }
        ],
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pizzahut.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "pizza"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "2560",
        "streetName": "152nd Ave NE",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "9805207",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052",
        "localName": "Redmond",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63255,
        "lon": -122.137
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63345,
          "lon": -122.13833
        },
        "btmRightPoint": {
          "lat": 47.63165,
          "lon": -122.13567
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63255,
            "lon": -122.1377
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 45,
    "numResults": 2,
    "offset": 0,
    "totalResults": 18,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p1/199865",
      "score": 4,
      "info": "search:decarta:ta:840539000519519-US",
      "poi": {
        "name": "Tutta Bella",
        "phone": "+(1)-(425)-5027402",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "TuttaBella.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15600",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Bellevue, Crossroads",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98008",
        "extendedPostalCode": "980084084",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15600 NE 8th St, Bellevue, WA 98008",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61705,
        "lon": -122.13228
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61795,
          "lon": -122.13361
        },
        "btmRightPoint": {
          "lat": 47.61615,
          "lon": -122.13095
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61701,
            "lon": -122.13228
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p1/205464",
      "score": 4,
      "info": "search:decarta:ta:840539000714286-US",
      "poi": {
        "name": "Q & S Food Co LLC",
        "phone": "+(1)-(425)-7464764",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "511",
        "streetName": "141st Ave SE",
        "municipalitySubdivision": "Bellevue, West Lake Hills",
        "municipality": "Bellevue, Eastgate",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "511 141st Ave SE, Bellevue, WA 98007",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6051,
        "lon": -122.15226
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.606,
          "lon": -122.15359
        },
        "btmRightPoint": {
          "lat": 47.6042,
          "lon": -122.15093
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6051,
            "lon": -122.15219
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Sample Response

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 9,
    "numResults": 2,
    "offset": 0,
    "totalResults": 18,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596331",
      "score": 2.226,
      "info": "search:ta:840539000722333-US",
      "poi": {
        "name": "Mod Pizza",
        "phone": "+(1)-(425)-2149903",
        "brands": [
          {
            "name": "Mod Pizza"
          }
        ],
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "https://modpizza.com/locations/bellevue-overlake",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "pizza"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14309",
        "streetName": "NE 20th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14309 NE 20th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.62779,
        "lon": -122.14971
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62869,
          "lon": -122.15104
        },
        "btmRightPoint": {
          "lat": 47.62689,
          "lon": -122.14838
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.62789,
            "lon": -122.14977
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596385",
      "score": 2.226,
      "info": "search:ta:840539000366535-US",
      "poi": {
        "name": "Pizza Hut",
        "phone": "+(1)-(425)-8619900",
        "brands": [
          {
            "name": "Pizza Hut"
          }
        ],
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pizzahut.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "pizza"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "2560",
        "streetName": "152nd Ave NE",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "9805207",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2560 152nd Ave NE, Redmond, WA 98052",
        "localName": "Redmond",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63255,
        "lon": -122.137
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63345,
          "lon": -122.13833
        },
        "btmRightPoint": {
          "lat": 47.63165,
          "lon": -122.13567
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63255,
            "lon": -122.1377
          }
        }
      ]
    }
  ]
}

Definitions

Address

The address of the result

AddressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

BoundingBoxCompassNotation

The bounding box of the location.

Brand

The brand associated with the POI

Classification

The classification for the POI being returned

ClassificationName

Name for the classification

DataSources

Optional section. Reference ids for use with the Get Search Polygon API.

Entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

EntryPoint

The entry point for the POI being returned.

EntryPointType

The type of entry point. Value can be either main or minor.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GeographicEntityType

Geography entity type. Present only when entityType was requested and is available.

GeoJsonFeature

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

GeoJsonFeatureCollection

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

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.

Geometry

Information about the geometric shape of the result. Only present if type == Geography.

LatLongPairAbbreviated

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

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/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region 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/region 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.

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

MatchType

Types of match for a reverse address search operation.

OperatingHours

Opening hours for a POI (Points of Interest).

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

OperatingHoursTime

Represents a date and time

OperatingHoursTimeRange

Open time range for a day

PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

PointOfInterestCategorySet

POI category

QueryType

The type of query being returned: NEARBY or NON_NEAR.

ResponseFormat

Desired format of the response. Value can be either json or xml.

SearchAddressResult

This object is returned from a successful Search calls.

SearchAddressResultItem

Result object for a Search API response.

SearchAddressResultType

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
SearchInsideGeometryRequest

This type represents the request body for the Search Inside Geometry service.

SearchSummary

Summary object for a Search API response.

Address

The address of the result

Name Type Description
boundingBox

The bounding box of the location.

buildingNumber
  • string

The building number on the street. DEPRECATED, use streetNumber instead.

country
  • string

Country name

countryCode
  • string

Country (Note: This is a two-letter code, not a country name.)

countryCodeISO3
  • string

ISO alpha-3 country code

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

State or Province

countrySubdivisionName
  • string

The full name of a first level of country administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom.

countryTertiarySubdivision
  • string

Named Area

crossStreet
  • string

The name of the street being crossed.

extendedPostalCode
  • string

Extended postal code (availability is dependent on the region).

freeformAddress
  • string

An address line formatted according to the formatting rules of a Result's country of origin, or in the case of a country, its full country name.

localName
  • string

An address component which represents the name of a geographic area or locality that groups a number of addressable objects for addressing purposes, without being an administrative unit. This field is used to build the freeformAddress property.

municipality
  • string

City / Town

municipalitySubdivision
  • string

Sub / Super City

postalCode
  • string

Postal Code / Zip Code

routeNumbers
  • string[]

The codes used to unambiguously identify the street

street
  • string

The street name. DEPRECATED, use streetName instead.

streetName
  • string

The street name.

streetNameAndNumber
  • string

The street name and number.

streetNumber
  • string

The building number on the street.

AddressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

Name Type Description
from

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

rangeLeft
  • string

Address range on the left side of the street.

rangeRight
  • string

Address range on the right side of the street.

to

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

BoundingBox

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

The bounding box of the location.

Name Type Description
entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

northEast
  • string

North-east latitude,longitude coordinate of the bounding box as comma-separated floats

southWest
  • string

South-west latitude,longitude coordinate of the bounding box as comma-separated floats

Brand

The brand associated with the POI

Name Type Description
name
  • string

Name of the brand

Classification

The classification for the POI being returned

Name Type Description
code
  • string

Code property

names

Names array

ClassificationName

Name for the classification

Name Type Description
name
  • string

Name property

nameLocale
  • string

Name Locale property

DataSources

Optional section. Reference ids for use with the Get Search Polygon API.

Name Type Description
geometry

Information about the geometric shape of the result. Only present if type == Geography.

Entity

Entity type source of the bounding box. For reverse-geocoding this is always equal to position.

Name Type Description
position
  • string

Position entity

EntryPoint

The entry point for the POI being returned.

Name Type Description
position

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

type

The type of entry point. Value can be either main or minor.

EntryPointType

The type of entry point. Value can be either main or minor.

Name Type Description
main
  • string
minor
  • string

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

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

GeographicEntityType

Geography entity type. Present only when entityType was requested and is available.

Name Type Description
Country
  • string

Country name

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

State or Province

CountryTertiarySubdivision
  • string

Named Area

Municipality
  • string

City / Town

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Neighbourhood

PostalCodeArea
  • string

Postal Code / Zip Code

GeoJsonFeature

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

Name Type Description
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.

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.

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.

GeoJsonFeatureCollection

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

Name Type Description
features

Contains a list of valid GeoJSON Feature objects.

type string:
  • FeatureCollection

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

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
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
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
coordinates
  • array[]

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
coordinates
  • array[]

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
coordinates
  • array[]

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
coordinates
  • array[]

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
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
coordinates
  • array[]

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.

Geometry

Information about the geometric shape of the result. Only present if type == Geography.

Name Type Description
id
  • string

Pass this as geometryId to the Get Search Polygon API to fetch geometry information for this result.

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

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/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region 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/region 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.

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

Name Type Description
AE
  • string

United Arab Emirates (Arabic View)

AR
  • string

Argentina (Argentinian View)

Auto
  • string

Return the map data based on the IP address of the request.

BH
  • string

Bahrain (Arabic View)

IN
  • string

India (Indian View)

IQ
  • string

Iraq (Arabic View)

JO
  • string

Jordan (Arabic View)

KW
  • string

Kuwait (Arabic View)

LB
  • string

Lebanon (Arabic View)

MA
  • string

Morocco (Moroccan View)

OM
  • string

Oman (Arabic View)

PK
  • string

Pakistan (Pakistani View)

PS
  • string

Palestinian Authority (Arabic View)

QA
  • string

Qatar (Arabic View)

SA
  • string

Saudi Arabia (Arabic View)

SY
  • string

Syria (Arabic View)

Unified
  • string

Unified View (Others)

YE
  • string

Yemen (Arabic View)

MatchType

Types of match for a reverse address search operation.

Name Type Description
AddressPoint
  • string
HouseNumberRange
  • string
Street
  • string

OperatingHours

Opening hours for a POI (Points of Interest).

Name Type Description
mode
  • string

Value used in the request: none or "nextSevenDays"

timeRanges

List of time ranges for the next 7 days

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

Name Type Description
nextSevenDays
  • string

Shows the hours of operation for the next week, starting with the current day in the local time of the POI.

OperatingHoursTime

Represents a date and time

Name Type Description
date
  • string

Represents current calendar date in POI time zone, e.g. "2019-02-07".

hour
  • integer

Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23.

minute
  • integer

Minutes are in the local time of a POI; possible values are 0 - 59.

OperatingHoursTimeRange

Open time range for a day

Name Type Description
endTime

The point in the next 7 days range when a given POI is being closed, or the beginning of the range if it was closed before the range.

startTime

The point in the next 7 days range when a given POI is being opened, or the beginning of the range if it was opened before the range.

PointOfInterest

Details of the returned POI including information such as the name, phone, url address, and classifications.

Name Type Description
brands

Brands array. The name of the brand for the POI being returned.

categories
  • string[]

Categories array

categorySet

The list of the most specific POI categories

classifications

Classification array

name
  • string

Name of the POI property

openingHours

Opening hours for a POI (Points of Interest).

phone
  • string

Telephone number property

url
  • string

Website URL property

PointOfInterestCategorySet

POI category

Name Type Description
id
  • integer

Category ID

QueryType

The type of query being returned: NEARBY or NON_NEAR.

Name Type Description
NEARBY
  • string

Search was performed around a certain latitude and longitude with a defined radius

NON_NEAR
  • string

Search was performed globally, without biasing to a certain latitude and longitude, and no defined radius

ResponseFormat

Desired format of the response. Value can be either json or xml.

Name Type Description
json
  • string

The JavaScript Object Notation Data Interchange Format

xml
  • string

The Extensible Markup Language

SearchAddressResult

This object is returned from a successful Search calls.

Name Type Description
results

A list of Search API results.

summary

Summary object for a Search API response

SearchAddressResultItem

Result object for a Search API response.

Name Type Description
address

The address of the result

addressRanges

Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.

dataSources

Optional section. Reference geometry id for use with the Get Search Polygon API.

detourTime
  • integer

Detour time in seconds. Only returned for calls to the Search Along Route API.

dist
  • number

Straight line distance between the result and geobias location in meters.

entityType

Geography entity type. Present only when entityType was requested and is available.

entryPoints

Array of EntryPoints. Those describe the types of entrances available at the location. The type can be "main" for main entrances such as a front door, or a lobby, and "minor", for side and back doors.

id
  • string

Id property

info
  • string

Information about the original data source of the Result. Used for support requests.

matchType

Information on the type of match.

One of:

  • AddressPoint
  • HouseNumberRange
  • Street
poi

Details of the returned POI including information such as the name, phone, url address, and classifications.

position

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

score
  • number

The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set.

type

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
viewport

The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.

SearchAddressResultType

One of:

  • POI
  • Street
  • Geography
  • Point Address
  • Address Range
  • Cross Street
Name Type Description
Address Range
  • string
Cross Street
  • string
Geography
  • string
POI
  • string
Point Address
  • string
Street
  • string

SearchInsideGeometryRequest

This type represents the request body for the Search Inside Geometry service.

Name Type Description
geometry GeoJsonObject:

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

SearchSummary

Summary object for a Search API response.

Name Type Description
fuzzyLevel
  • integer

The maximum fuzzy level required to provide Results.

geoBias

Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting the lat and lon parameters where available. In other cases it is purely internal.

limit
  • integer

Maximum number of responses that will be returned

numResults
  • integer

Number of results in the response.

offset
  • integer

The starting offset of the returned Results within the full Result set.

query
  • string

The query parameter that was used to produce these search results.

queryTime
  • integer

Time spent resolving the query, in milliseconds.

queryType

The type of query being returned: NEARBY or NON_NEAR.

totalResults
  • integer

The total number of Results found.