Search - Post Search Along Route

  • Reference
Service:
Maps
API Version:
1.0

Applies to: see pricing tiers.

The Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the maxDetourTime limiting measure.

To send the route-points you will use a POST request where the request body will contain the route object represented as a GeoJSON LineString type and the Content-Type header will be set to application/json. Each route-point in route is represented as a GeoJSON Position type i.e. an array where the longitude value is followed by the latitude value and the altitude value is ignored. The route should contain at least 2 route-points.

It is possible that original route will be altered, some of it's points may be skipped. If the route that passes through the found point is faster than the original one, the detourTime value in the response is negative.

POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}
With optional parameters: 
POST https://atlas.microsoft.com/search/alongRoute/{format}?api-version=1.0&query={query}&maxDetourTime={maxDetourTime}&limit={limit}&brandSet={brandSet}&categorySet={categorySet}&connectorSet={connectorSet}&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.
maxDetourTime
 query True
  • integer

Maximum detour time of the point of interest in seconds. Max value is 3600 seconds
query
 query True
  • string

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

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
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)
connectorSet
 query
  • array

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
limit
 query
  • integer

Maximum number of responses that will be returned. Default value is 10. Max value is 20
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 have different views of such regions, and the View parameter allows your application to comply with the view required by the country 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 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
route

A valid GeoJSON LineString geometry type. 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 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

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 along a route

Sample Request

POST https://atlas.microsoft.com/search/alongRoute/json?api-version=1.0&query=burger&maxDetourTime=1000&limit=2&openingHours=nextSevenDays
Request Body
{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -122.143035,
        47.653536
      ],
      [
        -122.187164,
        47.617556
      ],
      [
        -122.114981,
        47.570599
      ],
      [
        -122.132756,
        47.654009
      ]
    ]
  }
}

Sample Response

Status code:
200 
{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 394,
    "numResults": 2,
    "offset": 0,
    "totalResults": 2,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "US/POI/p0/8596348",
      "score": 3.104,
      "dist": 1754.9604168059973,
      "info": "search:ta:840531000465150-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-7467508",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "14620",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Crossroads, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98007",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "14620 NE 24th St, Bellevue, WA 98007",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.63188,
        "lon": -122.14462
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63278,
          "lon": -122.14595
        },
        "btmRightPoint": {
          "lat": 47.63098,
          "lon": -122.14329
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.63155,
            "lon": -122.14462
          }
        }
      ],
      "detourTime": -55
    },
    {
      "type": "POI",
      "id": "US/POI/p0/8596112",
      "score": 3.111,
      "dist": 161.17565489389224,
      "info": "search:ta:840531000465149-US",
      "poi": {
        "name": "BURGER KING",
        "phone": "+(1)-(425)-4535775",
        "brands": [
          {
            "name": "BURGER KING"
          }
        ],
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "url": "www.burgerking.com",
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "11723",
        "streetName": "NE 8th St",
        "municipalitySubdivision": "Willburton, Bellevue",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivision": "WA",
        "postalCode": "98005",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "11723 NE 8th St, Bellevue, WA 98005",
        "localName": "Bellevue",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.61683,
        "lon": -122.18338
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.61773,
          "lon": -122.18471
        },
        "btmRightPoint": {
          "lat": 47.61593,
          "lon": -122.18205
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.61723,
            "lon": -122.1834
          }
        }
      ],
      "detourTime": 12
    }
  ]
}

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.
BrandName

The name of the brand for the POI being returned
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.
GeoJsonLineString

A valid GeoJSON LineString 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 have different views of such regions, and the View parameter allows your application to comply with the view required by the country 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 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
SearchAlongRouteRequest

This type represents the request body for the Search Along Route 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 Great Britain.
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

BrandName

The name of the brand for the POI being returned

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

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.

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

SearchAlongRouteRequest

This type represents the request body for the Search Along Route service.

Name Type Description
route

A valid GeoJSON LineString geometry type. 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.