Search - Post Search Inside Geometry

Applies to: S0 and S1 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}?subscription-key={subscription-key}&api-version=1.0&query={query}&limit={limit}&language={language}&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.

subscription-key
query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Refer to the subscription-key security definition.

api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

query
query True
  • string

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

limit
query
  • integer

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

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.

extendedPostalCodesFor
query
  • 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.

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)

view
query
  • string

The View parameter specifies which set of geopolitically disputed content is returned via Azure Maps services, including borders and labels displayed on the map. The View parameter (also referred to as “user region parameter”) will show the correct maps for that country/region. 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 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.

openingHours
query

Opening hours for a POI (Points of Interest). The availability of opening hours will vary based on the data available.

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 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
  • object

This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a GeoJSON compliant type. Please refer to RFC 7946 for details.

Responses

Name Type Description
200 OK

OK

Media Types: "application/json", "application/xml"

400 Bad Request

Bad request: one or more parameters were incorrectly specified or are mutually exclusive.

Media Types: "application/json", "application/xml"

401 Unauthorized

Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided AAD bearer token.

Media Types: "application/json", "application/xml"

Headers

  • WWW-Authenticate: string
403 Forbidden

Permission, capacity, or authentication issues.

Media Types: "application/json", "application/xml"

404 Not Found

Not Found: the requested resource could not be found, but it may be available again in the future.

Media Types: "application/json", "application/xml"

500 Internal Server Error

An error occurred while processing the request. Please try again later.

Media Types: "application/json", "application/xml"

Security

azure_auth

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.

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 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 tokens are supported.

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

subscription-key

This is a shared key which is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: query

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?subscription-key=[subscription-key]&api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays
{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601563,
              37.706604725423119
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601563,
              37.706604725423119
            ],
            [
              -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"
          }
        ],
        "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"
          }
        ],
        "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
          }
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

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

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?subscription-key=[subscription-key]&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",
        "url": "TuttaBella.com",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "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",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "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
          }
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

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

Sample Request

POST https://atlas.microsoft.com/search/geometry/json?subscription-key=[subscription-key]&api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays
{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601563,
          37.706604725423119
        ],
        [
          -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"
          }
        ],
        "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"
          }
        ],
        "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
          }
        }
      ]
    }
  ]
}
{
  "error": {
    "code": "400 BadRequest",
    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
  }
}
{
  "error": {
    "code": "401 Unauthorized",
    "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
  }
}
{
  "error": {
    "code": "403 Forbidden",
    "message": "Permission, capacity, or authentication issues."
  }
}
{
  "error": {
    "code": "404 NotFound",
    "message": "Not Found: the requested resource could not be found, but it may be available again in the future."
  }
}
{
  "error": {
    "code": "500 InternalServerError",
    "message": "An error occurred while processing the request. Please try again later."
  }
}

Definitions

CoordinateAbbreviated

A location represented as a latitude and longitude.

EntityType

Defines geography entity types.

Error

This object is returned when an error occurs in the Maps API

ErrorResponse

This response object is returned when an error occurs in the Maps API

OpeningHours

Opening hours for a POI (Points of Interest). The availability of opening hours will vary based on the data available.

SearchGeometryResponse

This object is returned from a successful Search By Geometry call

SearchGeometryResult

This type represents the Search Inside Geometry result object.

SearchGeometrySummary

Summary object for a Search Geometry response

SearchInsideGeometryRequestBody

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

SearchResultAddress

The address of the result

SearchResultEntryPoint

The entry point for the POI being returned.

SearchResultPoi

Details of the poi including the name, phone, url, and categories.

SearchResultPoiBrand

The name of the brand for the POI being returned

SearchResultPoiClassification

The classification for the POI being returned

SearchResultPoiClassificationName

Name for the classification

SearchResultViewport

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

TextFormat

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

CoordinateAbbreviated

A location represented as a latitude and longitude.

Name Type Description
lat
  • number

Latitude property

lon
  • number

Longitude property

EntityType

Defines geography entity types.

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

Error

This object is returned when an error occurs in the Maps API

Name Type Description
code
  • string

The HTTP status code.

message
  • string

If available, a human readable description of the error.

ErrorResponse

This response object is returned when an error occurs in the Maps API

Name Type Description
error

This object is returned when an error occurs in the Maps API

OpeningHours

Opening hours for a POI (Points of Interest). The availability of opening hours will vary based on the data available.

Name Type Description
nextSevenDays
  • string

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

SearchGeometryResponse

This object is returned from a successful Search By Geometry call

Name Type Description
results

A list of Search Inside Geometry results.

summary

Summary object for a Search Geometry response

SearchGeometryResult

This type represents the Search Inside Geometry result object.

Name Type Description
address

The address of the result

entityType

Defines geography entity types.

entryPoints

Entry Points array

id
  • string

Id property

info
  • string

Info property

poi

Details of the poi including the name, phone, url, and categories.

position

A location represented as a latitude and longitude.

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
  • string

Type property

viewport

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

SearchGeometrySummary

Summary object for a Search Geometry response

Name Type Description
fuzzyLevel
  • integer

FuzzyLevel property

numResults
  • integer

NumResults property

offset
  • integer

Offset property

query
  • string

Query property

queryTime
  • integer

QueryTime property

queryType
  • string

QueryType property

totalResults
  • integer

TotalResults property

SearchInsideGeometryRequestBody

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

Name Type Description
geometry
  • object

This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a GeoJSON compliant type. Please refer to RFC 7946 for details.

SearchResultAddress

The address of the result

Name Type Description
buildingNumber
  • string

Building Number property

country
  • string

Country property

countryCode
  • string

Country Code property

countryCodeISO3
  • string

Country Code ISO3 property

countrySecondarySubdivision
  • string

Country Secondary Subdivision property

countrySubdivision
  • string

Country Subdivision property

countrySubdivisionName
  • string

Country Subdividion Name property

countryTertiarySubdivision
  • string

Country Tertiary Subdivision property

crossStreet
  • string

Cross Street property

extendedPostalCode
  • string

Extended Postal Code property

freeformAddress
  • string

Free form Address property

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

Municipality property

municipalitySubdivision
  • string

Municipality Subdivision property

postalCode
  • string

Postal Code property

routeNumbers
  • integer[]

number of routes

street
  • string

Street property

streetName
  • string

Street Name property

streetNameAndNumber
  • string

Street Name and Number property

streetNumber
  • string

Street Number property

SearchResultEntryPoint

The entry point for the POI being returned.

Name Type Description
position

A location represented as a latitude and longitude.

type enum:
  • main
  • minor

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

SearchResultPoi

Details of the poi including the name, phone, url, and categories.

Name Type Description
brands

Brands array

categories
  • string[]

[Deprecated] Use classifications instead. Categories array

classifications

Classification array

name
  • string

Name property

phone
  • string

Phone property

url
  • string

URL property

SearchResultPoiBrand

The name of the brand for the POI being returned

Name Type Description
name
  • string

Name of the brand

SearchResultPoiClassification

The classification for the POI being returned

Name Type Description
code
  • string

Code property

names

Names array

SearchResultPoiClassificationName

Name for the classification

Name Type Description
name
  • string

Name property

nameLocale
  • string

Name Locale property

SearchResultViewport

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.

topLeftPoint

A location represented as a latitude and longitude.

TextFormat

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