How do I get partial zip code typeahead matches in Azure Maps Address Search?

Parker Ben - Nashville 0

I'm new to Azure Maps, and I'm trying to find documentation around the options with typeahead address search.

My use case is this - I want to provide a partial zip code (example: "372") and get zip code results only (screenshot below).

User's image

Google's Places API allows you to optionally pass "postal_codes" as a "types" parameter to only serve zip code results. Is there similar functionality in Azure Maps?

Thanks!

2 answers

Deleted

This answer has been deleted due to a violation of our Code of Conduct. The answer was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.

Comments have been turned off. Learn more

rbrundritt 16,331 Microsoft Employee

For this scenario I recommend using the Search Address (V1 search service). With that you can add &entityType=PostalCodeArea to limit the results to postal/zip codes. You can add &typeahead=true to tell it the request is part of an autocomplete scenario and it will be more forgiving on what it would normally consider "garbage" input. Pass your input into the query parameter. Optionally you can use the countrySet parameter to limit the results to a set of countries. https://video2.skills-academy.com/en-us/rest/api/maps/search/get-search-address?view=rest-maps-1.0&tabs=HTTP

Parker Ben - Nashville 0

Thanks for the reply - I've tried this and unfortunately it doesn't work.

Here is the url I'm using:

https://atlas.microsoft.com/search/address/json?api-version=1.0&query=372&subscription-key=...&entityType=PostalCodeArea&typeahead=true&countryset=US

Notice the query is "372" - this returns no results

{
    "summary": {
        "query": "372",
        "queryType": "NON_NEAR",
        "queryTime": 7,
        "numResults": 0,
        "offset": 0,
        "totalResults": 0,
        "fuzzyLevel": 2
    },
    "results": []
}

However, if I supply a full 5 digit zip code (37221), it returns one result

https://atlas.microsoft.com/search/address/json?api-version=1.0&query=37221&subscription-key=...&entityType=PostalCodeArea&typeahead=true&countryset=US

{
    "summary": {
        "query": "37221",
        "queryType": "NON_NEAR",
        "queryTime": 15,
        "numResults": 1,
        "offset": 0,
        "totalResults": 1,
        "fuzzyLevel": 1
    },
    "results": [
        {
            "type": "Geography",
            "id": "X2twYzom87j1hBpij4jn8w",
            "score": 1,
            "entityType": "PostalCodeArea",
            "matchConfidence": {
                "score": 1
            },
            "address": {
                "municipality": "Nashville",
                "countrySecondarySubdivision": "Davidson",
                "countrySubdivision": "TN",
                "countrySubdivisionName": "Tennessee",
                "countrySubdivisionCode": "TN",
                "postalCode": "37221",
                "postalName": "Nashville",
                "countryCode": "US",
                "country": "United States",
                "countryCodeISO3": "USA",
                "freeformAddress": "Nashville, TN 37221"
            },
            "position": {
                "lat": 36.06803,
                "lon": -86.95261
            },
            "viewport": {
                "topLeftPoint": {
                    "lat": 36.12146,
                    "lon": -87.05466
                },
                "btmRightPoint": {
                    "lat": 35.99708,
                    "lon": -86.86729
                }
            },
            "boundingBox": {
                "topLeftPoint": {
                    "lat": 36.12146,
                    "lon": -87.05466
                },
                "btmRightPoint": {
                    "lat": 35.99708,
                    "lon": -86.86729
                }
            },
            "dataSources": {
                "geometry": {
                    "id": "0000544e-3200-2800-0000-00000bf4c6f5"
                }
            }
        }
    ]
}

Is there something I'm missing?

rbrundritt 16,331 Reputation points Microsoft Employee

2024-07-02T14:28:14.77+00:00

Nope, you have it right. It seems like the test zip code I was using seemed to work but most others didn't. Doing more testing, this scenario is not well supported by any of the Azure Maps services at this time. Microsoft has been moving some of the Bing Maps services to Azure Maps. The Bing Maps autosuggest API may be better suited for this scenario. I'll check to see if the team plans on bring that service over (I believe they do).

Share via

How do I get partial zip code typeahead matches in Azure Maps Address Search?

2 answers