Search - Post Search Address Batch

Search Address Batch API

Applies to: see pricing tiers.

The Search Address Batch API sends batches of queries to Search Address API using just a single API call. You can call Search Address Batch API to run either asynchronously (async) or synchronously (sync). The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries.

Submit Synchronous Batch Request

The Synchronous API is recommended for lightweight batch requests. When the service receives a request, it will respond as soon as the batch items are calculated and there will be no possibility to retrieve the results later. The Synchronous API will return a timeout error (a 408 response) if the request takes longer than 60 seconds. The number of batch items is limited to 100 for this API.

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Submit Asynchronous Batch Request

The Asynchronous API is appropriate for processing big volumes of relatively complex search requests

  • It allows the retrieval of results in a separate call (multiple downloads are possible).
  • The asynchronous API is optimized for reliability and is not expected to run into a timeout.
  • The number of batch items is limited to 10,000 for this API.

When you make a request by using async request, by default the service returns a 202 response code along a redirect URL in the Location field of the response header. This URL should be checked periodically until the response data or error information is available. The asynchronous responses are stored for 14 days. The redirect URL returns a 404 response if used after the expiration period.

Please note that asynchronous batch request is a long-running request. Here's a typical sequence of operations:

  1. Client sends a Search Address Batch POST request to Azure Maps

  2. The server will respond with one of the following:

    HTTP 202 Accepted - Batch request has been accepted.

    HTTP Error - There was an error processing your Batch request. This could either be a 400 Bad Request or any other Error status code.

  3. If the batch request was accepted successfully, the Location header in the response contains the URL to download the results of the batch request. This status URI looks like following:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Client issues a GET request on the download URL obtained in Step 3 to download the batch results.

POST Body for Batch Request

To send the search address queries you will use a POST request where the request body will contain the batchItems array in json format and the Content-Type header will be set to application/json. Here's a sample request body containing 5 search address queries:

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

A search address query in a batch is just a partial URL without the protocol, base URL, path, api-version and subscription-key. It can accept any of the supported search address URI parameters. The string values in the search address query must be properly escaped (e.g. " character should be escaped with \ ) and it should also be properly URL-encoded.

The async API allows caller to batch up to 10,000 queries and sync API up to 100 queries, and the batch should contain at least 1 query.

Download Asynchronous Batch Results

To download the async batch results you will issue a GET request to the batch download endpoint. This download URL can be obtained from the Location header of a successful POST batch request and looks like the following:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Here's the typical sequence of operations for downloading the batch results:

  1. Client sends a GET request using the download URL.

  2. The server will respond with one of the following:

    HTTP 202 Accepted - Batch request was accepted but is still being processed. Please try again in some time.

    HTTP 200 OK - Batch request successfully processed. The response body contains all the batch results.

Batch Response Model

The returned data content is similar for async and sync requests. When downloading the results of an async batch request, if the batch has finished processing, the response body contains the batch response. This batch response contains a summary component that indicates the totalRequests that were part of the original batch request and successfulRequestsi.e. queries which were executed successfully. The batch response also includes a batchItems array which contains a response for each and every query in the batch request. The batchItems will contain the results in the exact same order the original queries were sent in the batch request. Each item in batchItems contains statusCode and response fields. Each response in batchItems is of one of the following types:

  • SearchAddressResponse - If the query completed successfully.

  • Error - If the query failed. The response will contain a code and a message in this case.

Here's a sample Batch Response with 2 successful and 1 failed result:

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

URI Parameters

Name In Required Type Description
format
path True

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

api-version
query True
  • string

Version number of Azure Maps API.

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
batchItems

The list of queries to process.

Responses

Name Type Description
200 OK

OK

202 Accepted

Supported only for async request. Request Accepted: The request has been accepted for processing. Please use the URL in the Location Header to retry or access the results.

Headers

  • Location: string
Other Status Codes

An unexpected error occurred.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

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

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

Scopes

Name Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

This is a shared key that is provisioned when you Create an Azure Maps account in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.

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

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

Type: apiKey
In: query

SAS Token

This is a shared access signature token is created from the List SAS operation on the Azure Maps resource through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.

With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.

For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the Map account resource to limit rendering abuse and regularly renew the SAS Token.

Type: apiKey
In: header

Examples

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

Sample Request

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

Sample Response

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivision": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivision": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivision": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}
Location: URL to download the results of the long-running batch request.

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.

BatchRequest

This type represents the request body for the Batch service.

BatchRequestItem

Batch request object

BoundingBox

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

BoundingBoxCompassNotation

The bounding box of the location.

Brand

The brand associated with the POI

Classification

The classification for the POI being returned

ClassificationName

Name for the classification

DataSources

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

Entity

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

EntryPoint

The entry point for the POI being returned.

EntryPointType

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

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

GeographicEntityType

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

Geometry

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

JsonFormat

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

LatLongPairAbbreviated

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

MatchType

Types of match for a reverse address search operation.

OperatingHours

Opening hours for a POI (Points of Interest).

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.

Response

The result of the query. SearchAddressResponse if the query completed successfully, ErrorResponse otherwise.

SearchAddressBatchItem

An item returned from Search Address Batch service call.

SearchAddressBatchProcessResult

This object is returned from a successful Search Address Batch service call.

SearchAddressResultItem

Result object for a Search API response.

SearchAddressResultType

One of:

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

Summary object for a Search API response.

Summary

Summary of the results for the batch request

Address

The address of the result

Name Type Description
boundingBox

The bounding box of the location.

buildingNumber
  • string

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

country
  • string

Country name

countryCode
  • string

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

countryCodeISO3
  • string

ISO alpha-3 country code

countrySecondarySubdivision
  • string

County

countrySubdivision
  • string

State or Province

countrySubdivisionName
  • string

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

countryTertiarySubdivision
  • string

Named Area

crossStreet
  • string

The name of the street being crossed.

extendedPostalCode
  • string

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

freeformAddress
  • string

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

localName
  • string

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

municipality
  • string

City / Town

municipalitySubdivision
  • string

Sub / Super City

postalCode
  • string

Postal Code / Zip Code

routeNumbers
  • string[]

The codes used to unambiguously identify the street

street
  • string

The street name. DEPRECATED, use streetName instead.

streetName
  • string

The street name.

streetNameAndNumber
  • string

The street name and number.

streetNumber
  • string

The building number on the street.

AddressRanges

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

Name Type Description
from

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

rangeLeft
  • string

Address range on the left side of the street.

rangeRight
  • string

Address range on the right side of the street.

to

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

BatchRequest

This type represents the request body for the Batch service.

Name Type Description
batchItems

The list of queries to process.

BatchRequestItem

Batch request object

Name Type Description
query
  • string

This parameter contains a query string used to perform an unstructured geocoding operation. The query string will be passed verbatim to the search API for processing.

BoundingBox

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

Name Type Description
btmRightPoint

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

topLeftPoint

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

BoundingBoxCompassNotation

The bounding box of the location.

Name Type Description
entity

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

northEast
  • string

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

southWest
  • string

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

Brand

The brand associated with the POI

Name Type Description
name
  • string

Name of the brand

Classification

The classification for the POI being returned

Name Type Description
code
  • string

Code property

names

Names array

ClassificationName

Name for the classification

Name Type Description
name
  • string

Name property

nameLocale
  • string

Name Locale property

DataSources

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

Name Type Description
geometry

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

Entity

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

Name Type Description
position
  • string

Position entity

EntryPoint

The entry point for the POI being returned.

Name Type Description
position

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

type

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

EntryPointType

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

Name Type Description
main
  • string
minor
  • string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

GeographicEntityType

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

Name Type Description
Country
  • string

Country name

CountrySecondarySubdivision
  • string

County

CountrySubdivision
  • string

State or Province

CountryTertiarySubdivision
  • string

Named Area

Municipality
  • string

City / Town

MunicipalitySubdivision
  • string

Sub / Super City

Neighbourhood
  • string

Neighbourhood

PostalCodeArea
  • string

Postal Code / Zip Code

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.

JsonFormat

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

Name Type Description
json
  • string

The JavaScript Object Notation Data Interchange Format

LatLongPairAbbreviated

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

Name Type Description
lat
  • number

Latitude property

lon
  • number

Longitude property

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

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

Response

The result of the query. SearchAddressResponse if the query completed successfully, ErrorResponse otherwise.

Name Type Description
error

The error object.

results

A list of Search API results.

summary

Summary object for a Search API response

SearchAddressBatchItem

An item returned from Search Address Batch service call.

Name Type Description
response

The result of the query. SearchAddressResponse if the query completed successfully, ErrorResponse otherwise.

statusCode
  • integer

HTTP request status code.

SearchAddressBatchProcessResult

This object is returned from a successful Search Address Batch service call.

Name Type Description
batchItems

Array containing the batch results.

summary

Summary of the results for the batch request

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

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.

Summary

Summary of the results for the batch request

Name Type Description
successfulRequests
  • integer

Number of successful requests in the batch

totalRequests
  • integer

Total number of requests in the batch