Search - Get Search Nearby
Use to search for points of interest near a specific location.
The Get Search Nearby
API is an HTTP GET
request most useful for retrieving POI results around a specific location. This endpoint will only return POI results, and does not take in a search query parameter.
GET https://atlas.microsoft.com/search/nearby/{format}?api-version=1.0&lat={lat}&lon={lon}
GET https://atlas.microsoft.com/search/nearby/{format}?api-version=1.0&lat={lat}&lon={lon}&limit={limit}&ofs={ofs}&categorySet={categorySet}&countrySet={countrySet}&radius={radius}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&brandSet={brandSet}&connectorSet={connectorSet}&view={view}
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. |
lat
|
query | True |
number double |
Latitude where results should be biased. E.g. 37.337. |
lon
|
query | True |
number double |
Longitude where results should be biased. E.g. -121.89. |
brand
|
query |
string[] |
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. Usage examples: brandSet=Foo brandSet=Foo,Bar brandSet="A,B,C Comma",Bar |
|
category
|
query |
integer[] |
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. Maximum number of
|
|
connector
|
query |
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. Available connector types are:
Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
||
country
|
query |
string[] |
Comma separated string of country/region codes, e.g. FR,ES. This will limit the search to the specified countries/regions |
|
extended
|
query |
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. |
||
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 |
|
ofs
|
query |
integer |
Starting offset of the returned results within the full result set. Default: 0 |
|
radius
|
query |
integer |
The radius in meters to for the results to be constrained to the defined area, Min value is 1, Max Value is 50000. |
|
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. |
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. |
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
An unexpected error occurred. |
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
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
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
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
Search for any points of interest (POI) within 5 miles of Manhattan NY and return the top 10 results
Sample request
GET https://atlas.microsoft.com/search/nearby/json?api-version=1.0&lat=40.70627&lon=-74.011454&limit=10&radius=8046
Sample response
{
"summary": {
"queryType": "NEARBY",
"queryTime": 137,
"numResults": 10,
"offset": 0,
"totalResults": 256620,
"fuzzyLevel": 1,
"geoBias": {
"lat": 40.70627,
"lon": -74.011454
}
},
"results": [
{
"type": "POI",
"id": "US/POI/p1/7652731",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002225435-US",
"poi": {
"name": "Ycd Multimedia",
"phone": "+(1)-(212)-5091049",
"categorySet": [
{
"id": 9152
}
],
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652732",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001882610-US",
"poi": {
"name": "Grubb & Ellis Management Services",
"phone": "+(1)-(212)-7851619",
"categorySet": [
{
"id": 9352039
}
],
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652735",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001322824-US",
"poi": {
"name": "Hispanic Federation",
"phone": "+(1)-(212)-7420480",
"categorySet": [
{
"id": 9910004
}
],
"url": "Hispanicfederation.org",
"classifications": [
{
"code": "AUTOMOTIVE_DEALER",
"names": [
{
"nameLocale": "en-US",
"name": "boat"
},
{
"nameLocale": "en-US",
"name": "automotive dealer"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652736",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369000631230-US",
"poi": {
"name": "Edwin Gould Foundation",
"phone": "+(1)-(212)-9825200",
"categorySet": [
{
"id": 9152
}
],
"url": "edwingouldfoundation.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652737",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369001196585-US",
"poi": {
"name": "Newmark Grubb Knight Frank",
"phone": "+(1)-(646)-6951990",
"categorySet": [
{
"id": 9361015
}
],
"url": "www.newmarkkf.com",
"classifications": [
{
"code": "SHOP",
"names": [
{
"nameLocale": "en-US",
"name": "shop"
},
{
"nameLocale": "en-US",
"name": "real estate agents"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p1/7652738",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002164164-US",
"poi": {
"name": "Sponsors For Educational Opportunity",
"phone": "+(1)-(212)-7851361",
"categorySet": [
{
"id": 9152
}
],
"url": "www.seo-usa.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373205",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840361001736646-US",
"poi": {
"name": "Visiting Nurse Service",
"phone": "+(1)-(212)-7428259",
"categorySet": [
{
"id": 9663
}
],
"url": "www.vnsny.org",
"classifications": [
{
"code": "HEALTH_CARE_SERVICE",
"names": [
{
"nameLocale": "en-US",
"name": "health care service"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373206",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840361001326915-US",
"poi": {
"name": "Hispanic In Philanthropy",
"phone": "+(1)-(646)-2777101",
"categorySet": [
{
"id": 9152
}
],
"url": "www.hiponline.org",
"classifications": [
{
"code": "NON_GOVERNMENTAL_ORGANIZATION",
"names": [
{
"nameLocale": "en-US",
"name": "non governmental organization"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373207",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002316633-US",
"poi": {
"name": "Advantage Technical Resourcing",
"phone": "+(1)-(212)-2691140",
"categorySet": [
{
"id": 9352039
}
],
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
},
{
"type": "POI",
"id": "US/POI/p0/7373208",
"score": 1,
"dist": 14.736843483489132,
"info": "search:ta:840369002031974-US",
"poi": {
"name": "Workshop In Bus Opportunities",
"phone": "+(1)-(212)-6840854",
"categorySet": [
{
"id": 9352039
}
],
"url": "www.wibo.org",
"classifications": [
{
"code": "COMPANY",
"names": [
{
"nameLocale": "en-US",
"name": "company"
},
{
"nameLocale": "en-US",
"name": "services"
}
]
}
]
},
"address": {
"streetNumber": "55",
"streetName": "Exchange Pl",
"municipalitySubdivision": "New York City, NYC, New York, Financial District",
"municipality": "Wall Street, New York City, NYC, NY City, NY, Manhattan, Bowling Green, New York",
"countrySecondarySubdivision": "New York",
"countryTertiarySubdivision": "Manhattan",
"countrySubdivisionCode": "NY",
"postalCode": "10004",
"extendedPostalCode": "100042320",
"countryCode": "US",
"country": "United States Of America",
"countryCodeISO3": "USA",
"freeformAddress": "55 Exchange Pl, New York, NY 10004",
"countrySubdivisionName": "New York"
},
"position": {
"lat": 40.7064,
"lon": -74.01142
},
"viewport": {
"topLeftPoint": {
"lat": 40.7073,
"lon": -74.01261
},
"btmRightPoint": {
"lat": 40.7055,
"lon": -74.01023
}
},
"entryPoints": [
{
"type": "main",
"position": {
"lat": 40.70636,
"lon": -74.01145
}
}
]
}
]
}
Name | Description |
---|---|
Address |
The address of the result |
Address |
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. |
Bounding |
The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. |
Bounding |
The bounding box of the location. |
Brand |
The brand associated with the POI |
Classification |
The classification for the POI being returned |
Classification |
Name for the classification |
Data |
Optional section. Reference ids for use with the Get Search Polygon API. |
Electric |
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. Available connector types are:
Usage examples: connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached |
Entity |
Entity type source of the bounding box. For reverse-geocoding this is always equal to position. |
Entry |
The entry point for the POI being returned. |
Entry |
The type of entry point. Value can be either main or minor. |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Geographic |
Geography entity type. Present only when entityType was requested and is available. |
Geometry |
Information about the geometric shape of the result. Only present if type == Geography. |
Lat |
A location represented as a latitude and longitude using short names 'lat' & 'lon'. |
Localized |
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. |
Match |
Types of match for a reverse address search operation. |
Operating |
Opening hours for a POI (Points of Interest). |
Operating |
Represents a date and time |
Operating |
Open time range for a day |
Point |
Details of the returned POI including information such as the name, phone, url address, and classifications. |
Point |
POI category |
Query |
The type of query being returned: NEARBY or NON_NEAR. |
Response |
Desired format of the response. Value can be either json or xml. |
Search |
This object is returned from a successful Search calls. |
Search |
Result object for a Search API response. |
Search |
One of:
|
Search |
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. |
Search |
Summary object for a Search API response. |
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/region name |
countryCode |
string |
Country (Note: This is a two-letter code, not a country/region name.) |
countryCodeISO3 |
string |
ISO alpha-3 country code |
countrySecondarySubdivision |
string |
County |
countrySubdivision |
string |
State or Province |
countrySubdivisionCode |
string |
|
countrySubdivisionName |
string |
The full name of a first level of country/region 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/region of origin, or in the case of a country/region, its full country/region name. |
localName |
string |
An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the |
municipality |
string |
City / Town |
municipalitySubdivision |
string |
Sub / Super City |
neighbourhood |
string |
A Neighbourhood is a geographically localized area within a city or town with distinctive characteristics and social interactions between inhabitants. |
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. |
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'. |
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'. |
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 |
The brand associated with the POI
Name | Type | Description |
---|---|---|
name |
string |
Name of the brand |
The classification for the POI being returned
Name | Type | Description |
---|---|---|
code |
string |
Code property |
names |
Names array |
Name for the classification
Name | Type | Description |
---|---|---|
name |
string |
Name property |
nameLocale |
string |
Name Locale property |
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. |
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.
Available connector types are:
StandardHouseholdCountrySpecific
- These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards.IEC62196Type1
- Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure.IEC62196Type1CCS
- Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.IEC62196Type2CableAttached
- Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point.IEC62196Type2Outlet
- Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point.IEC62196Type2CCS
- Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging.IEC62196Type3
- Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure.Chademo
- CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging.IEC60309AC1PhaseBlue
- Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration.IEC60309DCWhite
- Industrial White connector is a DC connector defined in the IEC 60309 standard.Tesla
- The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.
Usage examples:
connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
Name | Type | Description |
---|---|---|
Chademo |
string |
CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. |
IEC60309AC1PhaseBlue |
string |
Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. |
IEC60309DCWhite |
string |
Industrial White connector is a DC connector defined in the IEC 60309 standard. |
IEC62196Type1 |
string |
Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. |
IEC62196Type1CCS |
string |
Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. |
IEC62196Type2CCS |
string |
Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. |
IEC62196Type2CableAttached |
string |
Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point |
IEC62196Type2Outlet |
string |
Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. |
IEC62196Type3 |
string |
Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. |
StandardHouseholdCountrySpecific |
string |
These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards |
Tesla |
string |
The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe. |
Entity type source of the bounding box. For reverse-geocoding this is always equal to position.
Name | Type | Description |
---|---|---|
position |
string |
Position entity |
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. |
The type of entry point. Value can be either main or minor.
Name | Type | Description |
---|---|---|
main |
string |
|
minor |
string |
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
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. |
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
Geography entity type. Present only when entityType was requested and is available.
Name | Type | Description |
---|---|---|
Country |
string |
country/region 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 |
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. |
A location represented as a latitude and longitude using short names 'lat' & 'lon'.
Name | Type | Description |
---|---|---|
lat |
number |
Latitude property |
lon |
number |
Longitude property |
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) |
Types of match for a reverse address search operation.
Name | Type | Description |
---|---|---|
AddressPoint |
string |
|
HouseNumberRange |
string |
|
Street |
string |
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 |
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. |
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. |
Details of the returned POI including information such as the name, phone, url address, and classifications.
Name | Type | Description |
---|---|---|
brands |
Brand[] |
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 |
POI category
Name | Type | Description |
---|---|---|
id |
integer |
Category ID |
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 |
Desired format of the response. Value can be either json or xml.
Name | Type | Description |
---|---|---|
json |
string |
|
xml |
string |
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 |
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:
|
|
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:
|
|
viewport |
The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. |
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 |
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.
Name | Type | Description |
---|---|---|
Addr |
string |
|
Geo |
string |
|
PAD |
string |
|
POI |
string |
|
Str |
string |
|
Xstr |
string |
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. |