(Excel) Azure Maps Get Search Address

Get information for a given address.

For more information, see https://docs.microsoft.com/en-us/rest/api/maps/search/getsearchaddress

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

http.Accept = "application/json"


url = "https://atlas.microsoft.com/search/address/{$format}?subscription-key=[subscription-key]&api-version=1.0&query={$query}"

Dim success As Boolean
success = http.SetUrlVar("format","json")
success = http.SetUrlVar("query","15127 NE 24th Street, Redmond, WA 98052")


strResp = http.QuickGetStr(url)
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Debug.Print "Response Status Code: "; http.LastStatus

Dim jsonResponse As Chilkat.JsonObject
Set jsonResponse = Chilkat.NewJsonObject
success = jsonResponse.Load(strResp)
jsonResponse.EmitCompact = False
Debug.Print jsonResponse.Emit()

If (http.LastStatus <> 200) Then
    Debug.Print "Failed."
    Exit Sub
End If

' Sample output...
' (See the parsing code below..)
' 
' Use this online tool to generate parsing code from sample JSON: 
' Generate Parsing Code from JSON

' {
'   "summary": {
'     "query": "15127 NE 24th Street, Redmond, WA 98052",
'     "queryType": "NON_NEAR",
'     "queryTime": 58,
'     "numResults": 1,
'     "offset": 0,
'     "totalResults": 1,
'     "fuzzyLevel": 1
'   },
'   "results": [
'     {
'       "type": "Point Address",
'       "id": "US/PAD/p0/19173426",
'       "score": 14.51,
'       "address": {
'         "streetNumber": "15127",
'         "streetName": "NE 24th St",
'         "municipalitySubdivision": "Redmond",
'         "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
'         "countrySecondarySubdivision": "King",
'         "countryTertiarySubdivision": "Seattle East",
'         "countrySubdivision": "WA",
'         "postalCode": "98052",
'         "extendedPostalCode": "980525544",
'         "countryCode": "US",
'         "country": "United States Of America",
'         "countryCodeISO3": "USA",
'         "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
'         "countrySubdivisionName": "Washington"
'       },
'       "position": {
'         "lat": 47.6308,
'         "lon": -122.1385
'       },
'       "viewport": {
'         "topLeftPoint": {
'           "lat": 47.6317,
'           "lon": -122.13983
'         },
'         "btmRightPoint": {
'           "lat": 47.6299,
'           "lon": -122.13717
'         }
'       },
'       "entryPoints": [
'         {
'           "type": "main",
'           "position": {
'             "lat": 47.6315,
'             "lon": -122.13852
'           }
'         }
'       ]
'     }
'   ]
' }
' 

summaryQuery = jsonResponse.StringOf("summary.query")
summaryQueryType = jsonResponse.StringOf("summary.queryType")
summaryQueryTime = jsonResponse.IntOf("summary.queryTime")
summaryNumResults = jsonResponse.IntOf("summary.numResults")
summaryOffset = jsonResponse.IntOf("summary.offset")
summaryTotalResults = jsonResponse.IntOf("summary.totalResults")
summaryFuzzyLevel = jsonResponse.IntOf("summary.fuzzyLevel")
i = 0
count_i = jsonResponse.SizeOfArray("results")
Do While i < count_i
    jsonResponse.I = i
    v_type = jsonResponse.StringOf("results[i].type")
    id = jsonResponse.StringOf("results[i].id")
    score = jsonResponse.StringOf("results[i].score")
    addressStreetNumber = jsonResponse.StringOf("results[i].address.streetNumber")
    addressStreetName = jsonResponse.StringOf("results[i].address.streetName")
    addressMunicipalitySubdivision = jsonResponse.StringOf("results[i].address.municipalitySubdivision")
    addressMunicipality = jsonResponse.StringOf("results[i].address.municipality")
    addressCountrySecondarySubdivision = jsonResponse.StringOf("results[i].address.countrySecondarySubdivision")
    addressCountryTertiarySubdivision = jsonResponse.StringOf("results[i].address.countryTertiarySubdivision")
    addressCountrySubdivision = jsonResponse.StringOf("results[i].address.countrySubdivision")
    addressPostalCode = jsonResponse.StringOf("results[i].address.postalCode")
    addressExtendedPostalCode = jsonResponse.StringOf("results[i].address.extendedPostalCode")
    addressCountryCode = jsonResponse.StringOf("results[i].address.countryCode")
    addressCountry = jsonResponse.StringOf("results[i].address.country")
    addressCountryCodeISO3 = jsonResponse.StringOf("results[i].address.countryCodeISO3")
    addressFreeformAddress = jsonResponse.StringOf("results[i].address.freeformAddress")
    addressCountrySubdivisionName = jsonResponse.StringOf("results[i].address.countrySubdivisionName")
    positionLat = jsonResponse.StringOf("results[i].position.lat")
    positionLon = jsonResponse.StringOf("results[i].position.lon")
    viewportTopLeftPointLat = jsonResponse.StringOf("results[i].viewport.topLeftPoint.lat")
    viewportTopLeftPointLon = jsonResponse.StringOf("results[i].viewport.topLeftPoint.lon")
    viewportBtmRightPointLat = jsonResponse.StringOf("results[i].viewport.btmRightPoint.lat")
    viewportBtmRightPointLon = jsonResponse.StringOf("results[i].viewport.btmRightPoint.lon")
    j = 0
    count_j = jsonResponse.SizeOfArray("results[i].entryPoints")
    Do While j < count_j
        jsonResponse.J = j
        v_type = jsonResponse.StringOf("results[i].entryPoints[j].type")
        positionLat = jsonResponse.StringOf("results[i].entryPoints[j].position.lat")
        positionLon = jsonResponse.StringOf("results[i].entryPoints[j].position.lon")
        j = j + 1
    Loop
    i = i + 1
Loop