Search - Get Geocode Autocomplete
Permet d’obtenir une liste classée d’entités suggérées en fonction de l’emplacement d’un utilisateur et d’une requête partielle.
Étant donné une requête avec l’emplacement d’un utilisateur et une requête partielle qui sert de préfixe d’une chaîne de requête complète (appelée préfixe de requête), l’API de saisie semi-automatique Azure Maps retourne une liste d’entités suggérées que l’utilisateur est le plus susceptible de rechercher. Ces entités sont classées de la plus probable à la moins probable.
Important
À l’aide de cette fonctionnalité, vous acceptez les conditions légales de la préversion. Pour plus d’informations, consultez préversion des conditions supplémentaires.
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query={query}
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query={query}&coordinates={coordinates}&bbox={bbox}&top={top}&resultTypeGroups={resultTypeGroups}&resultTypes={resultTypes}&view={view}&countryRegion={countryRegion}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Numéro de version de l’API Azure Maps. |
|
query
|
query | True |
string |
Obligatoire. Préfixe de requête de l’utilisateur. Exemple : « 1 Micro » ou « Muir Woods ». |
|
bbox
|
query |
number[] |
Obligatoire lorsqu’il Exemple : lon1,lat1,lon2,lat2. Taille minimale : environ 0,00001 degrés (~0,01 mètre). Taille maximale : jusqu’à l’étendue globale complète (-180,-90 à 180,90) |
|
|
coordinates
|
query |
number[] |
Obligatoire lorsqu’il
Note: |
|
|
country
|
query |
string |
Signal pour le résultat de la saisie semi-automatique vers un code de région/pays ISO 3166-1 Alpha-2 spécifié, par exemple FR. Seuls les résultats dans le pays/la région spécifiés seront renvoyés. |
|
|
result
|
query |
Liste des groupes de types d’entités renvoyés, séparés par des virgules. Les valeurs possibles sont
|
||
|
result
|
query |
Liste des types d’entités renvoyés, séparés par des virgules. Lorsque le groupe de types est défini sur Adresse, les types pris en charge sont les suivants :
Tous les autres types appartiennent au groupe de types Lieu. Il peut s’agir d’entités telles que AdminDivision1, Neighborhood, PopulatedPlace, etc. La valeur par défaut correspond à tous les types d’entités possibles. |
||
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Nombre maximal de réponses qui seront retournées. Par défaut : 5, minimum : 1 et maximum : 20. |
|
|
view
|
query |
string |
Chaîne qui représente un code de région/pays ISO 3166-1 Alpha-2. Cela modifiera les frontières et les étiquettes géopolitiques contestées pour s’aligner sur la région d’utilisateur spécifiée. Par défaut, le paramètre View est défini sur « Auto » même si vous ne l’avez pas défini dans la requête. Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Spécifie le compte destiné à être utilisé conjointement avec le modèle de sécurité Azure AD. Il représente un ID unique pour le compte Azure Maps et peut être récupéré à partir de l’API compte de plan de gestion Azure Maps. Pour plus d’informations sur l’utilisation de la sécurité Microsoft Entra ID dans Azure Maps, consultez Gérer l’authentification dans Azure Maps. |
|
| Accept-Language |
string |
Langue dans laquelle les résultats de recherche doivent être retournés. Pour plus d’informations, consultez langues prises en charge. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Ok Media Types: "application/geo+json" En-têtes x-ms-request-id: string |
|
| Other Status Codes |
Une erreur inattendue s’est produite. Media Types: "application/geo+json" |
Sécurité
AADToken
Il s’agit des flux Microsoft Entra OAuth 2.0. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Note
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-idpour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps. - La
Authorization URLest spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations d’ID Microsoft Entra. - Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
- L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Pour plus d’informations sur la plateforme d’identités Microsoft, consultez vue d’ensemble de la plateforme d’identités Microsoft.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Il s’agit d’une clé partagée provisionnée lors de la création d’une ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, kits SDK Azure ou API REST.
Avec cette clé, toute application est autorisée à accéder à toutes les API REST. En d’autres termes, ces clés peuvent être traitées comme des clés principales pour le compte pour lequel elles sont émises.
Pour les applications exposées publiquement, nous vous recommandons d’utiliser l’accès serveur à serveur des API REST Azure Maps où cette clé peut être stockée en toute sécurité.
Type:
apiKey
Dans:
header
SAS Token
Il s’agit d’un jeton de signature d’accès partagé créé à partir de l’opération List SAS sur la ressource Azure Maps via le plan de gestion Azure via le portail Azure, PowerShell, CLI, azure SDK ou LES API REST.
Avec ce jeton, toute application est autorisée à accéder avec des contrôles d’accès en fonction du rôle Azure et un contrôle précis à l’expiration, au taux et aux régions d’utilisation pour le jeton particulier. En d’autres termes, le jeton SAP peut être utilisé pour permettre aux applications de contrôler l’accès de manière plus sécurisée que la clé partagée.
Pour les applications exposées publiquement, nous vous recommandons de configurer une liste spécifique d’origines autorisées sur la ressource de compte mapper pour limiter l’abus de rendu et renouveler régulièrement le jeton SAP.
Type:
apiKey
Dans:
header
Exemples
Autocomplete API call to search for '1 Microsoft'
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=1 Microsoft&coordinates=-113.301894,49.201888
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"streetNumber": "1",
"streetName": "Microsoft Way",
"addressLine": "1 Microsoft Way",
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington"
},
{
"name": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "1 Microsoft Way, Redmond, Washington 98052, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "LandmarkBuilding",
"address": {
"locality": "Bellevue",
"adminDistricts": [
{
"name": "Washington"
},
{
"name": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "Bellevue, Washington, United States"
},
"name": "Microsoft-Advanta C"
}
}
]
}
Autocomplete API call to search for '1 Microsoft Way, Redmond', filtered by roadblock resultTypes, place resultTypeGroups, and return empty result
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=1 Microsoft Way, Redmond&coordinates=-113.301894,49.201888&resultTypeGroups=Place&resultTypes=RoadBlock
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "Address",
"address": {
"streetName": "Muir Woods Rd",
"addressLine": " Muir Woods Rd",
"locality": "Sausalito",
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "94965",
"formattedAddress": "Muir Woods Rd, Sausalito, California 94965, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"streetName": "Muir St",
"addressLine": " Muir St",
"locality": "Grosse Pointe Farms",
"adminDistricts": [
{
"name": "Michigan"
},
{
"name": "Wayne County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "48236",
"formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
}
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park and populated place resultTypes, place resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place&resultTypes=Park,PopulatedPlace
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Park"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by park resultTypes
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by place resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Forest",
"address": {
"adminDistricts": [
{
"name": "Wisconsin"
},
{
"name": "Dane County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "Wisconsin"
},
"name": "Muir Woods"
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "PopulatedPlace",
"address": {
"locality": "Muir Woods",
"adminDistricts": [
{
"name": "Georgia"
},
{
"name": "Fulton County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "30349",
"formattedAddress": "Muir Woods, Georgia 30349, United States"
}
}
},
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Place",
"type": "Park",
"address": {
"adminDistricts": [
{
"name": "California"
},
{
"name": "Marin County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"formattedAddress": "California"
},
"name": "Muir Woods National Monument"
}
}
]
}
Autocomplete API call to search for 'Muir Woods', filtered by roadblock resultTypes, address resultTypeGroups
Exemple de requête
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address&resultTypes=RoadBlock
Exemple de réponse
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": null,
"properties": {
"typeGroup": "Address",
"type": "RoadBlock",
"address": {
"streetName": "Muir St",
"addressLine": " Muir St",
"locality": "Grosse Pointe Farms",
"adminDistricts": [
{
"name": "Michigan"
},
{
"name": "Wayne County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "48236",
"formattedAddress": "Muir St, Grosse Pointe Farms, Michigan 48236, United States"
}
}
}
]
}
Définitions
| Nom | Description |
|---|---|
| Address |
Adresse du résultat |
|
Admin |
Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région. |
|
Autocomplete |
Caractéristiques du résultat de la saisie semi-automatique |
|
Autocomplete |
Propriétés du résultat de la saisie semi-automatique |
|
Autocomplete |
Cet objet est renvoyé à partir d’un appel de saisie semi-automatique réussi. |
|
Autocomplete |
Type de suggestion |
|
Autocomplete |
Adresse ou lieu |
|
Country |
Pays ou région avec son nom et son code ISO. |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Feature |
Spécifie le type |
|
Feature |
Le type d’une fonction doit être Fonctionnalité. |
|
Geo |
Type de géométrie |
| Intersection |
L’adresse du résultat. |
Address
Adresse du résultat
| Nom | Type | Description |
|---|---|---|
| addressLine |
string |
Ligne d’adresse qui comprend le nom et le numéro de la rue |
| adminDistricts |
Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région. |
|
| countryRegion |
Pays ou région avec son nom et son code ISO. |
|
| formattedAddress |
string |
Propriété d’adresse formatée |
| intersection |
L’adresse du résultat. |
|
| locality |
string |
Localité propriété |
| neighborhood |
string |
Propriété de quartier |
| postalCode |
string |
Propriété du code postal |
| streetName |
string |
Le nom de la rue à partir de formattedAddress |
| streetNumber |
string |
Le numéro dans la rue, le cas échéant, à partir de formattedAddress |
AdminDistricts
Nom de la sous-division dans le pays ou la région d’une adresse. Cet élément est généralement traité comme la première division administrative de l’ordre, mais dans certains cas, il contient également la deuxième, troisième ou quatrième division d’ordre dans un pays, une dépendance ou une région.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Le nom du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom complet de l’État tel que Washington, Pour adminDistrict[1], il peut s’agir du nom complet du comté |
| shortName |
string |
Le nom abrégé du champ adminDistrict correspondant, Pour adminDistrict[0], il peut s’agir du nom abrégé de l’État tel que WA, Pour adminDistrict[1], il peut s’agir du nom abrégé du comté |
AutocompleteFeature
Caractéristiques du résultat de la saisie semi-automatique
| Nom | Type | Description |
|---|---|---|
| geometry |
Type de géométrie |
|
| properties |
Propriétés du résultat de la saisie semi-automatique |
|
| type |
Spécifie le type |
AutocompleteProperties
Propriétés du résultat de la saisie semi-automatique
| Nom | Type | Description |
|---|---|---|
| address |
Adresse du résultat |
|
| name |
string |
Le nom du lieu. Ce champ n’apparaîtra pas si le type renvoyé est Adresse. |
| type |
Type de suggestion |
|
| typeGroup |
Adresse ou lieu |
AutocompleteResponse
Cet objet est renvoyé à partir d’un appel de saisie semi-automatique réussi.
| Nom | Type | Description |
|---|---|---|
| features |
Caractéristiques du résultat de la saisie semi-automatique |
|
| nextLink |
string |
Il s’agit du lien vers la page suivante des fonctionnalités retournées. S’il s’agit de la dernière page, aucun champ n’est présent. |
| type |
Spécifie le type |
AutocompleteResultTypeEnum
Type de suggestion
| Valeur | Description |
|---|---|
| Address | |
| AdminDivision1 | |
| AdminDivision2 | |
| AdminDivision3 | |
| AdministrativeBuilding | |
| Airport | |
| AirportTerminal | |
| AmusementPark | |
| AncientSite | |
| Aquarium | |
| Archipelago | |
| Basin | |
| Battlefield | |
| Bay | |
| Beach | |
| Bridge | |
| BusinessStructure | |
| Camp | |
| Canal | |
| Casino | |
| Castle | |
| Cave | |
| Cemetery | |
| Channel | |
| Church | |
| Cliff | |
| Coast | |
| CommunityCenter | |
| Continent | |
| CountryRegion | |
| Crater | |
| CulturalRegion | |
| Dam | |
| Delta | |
| Desert | |
| DrainageBasin | |
| Dune | |
| FacilityStructure | |
| FerryTerminal | |
| FinancialStructure | |
| FireStation | |
| Forest | |
| Fort | |
| Garden | |
| Geyser | |
| Glacier | |
| GolfCourse | |
| GreaterPopulatedPlace | |
| HigherEducationFacility | |
| HistoricalSite | |
| Hospital | |
| HotSpring | |
| Ice | |
| IndigenousPeoplesReserve | |
| IndustrialStructure | |
| Island | |
| Isthmus | |
| Lake | |
| LandArea | |
| Landform | |
| LandmarkBuilding | |
| Library | |
| Lighthouse | |
| Marina | |
| Market | |
| MedicalStructure | |
| MetroStation | |
| MilitaryBase | |
| Mission | |
| Monument | |
| Mosque | |
| Mountain | |
| MountainRange | |
| MultiModalStation | |
| Museum | |
| NauticalStructure | |
| Neighborhood | |
| Oasis | |
| ObservationPoint | |
| Ocean | |
| OfficeBuilding | |
| Other | |
| Park | |
| ParkingStructure | |
| Pass | |
| Peninsula | |
| Plain | |
| Planet | |
| Plateau | |
| Playground | |
| PlayingField | |
| Pole | |
| PoliticalUnit | |
| PopulatedPlace | |
| Port | |
| Postcode1 | |
| Promontory | |
| RaceTrack | |
| RailwayStation | |
| Reef | |
| ReligiousStructure | |
| Reserve | |
| ResidentialStructure | |
| River | |
| RoadBlock | |
| Ruin | |
| ScientificResearchBase | |
| Sea | |
| SeaplaneLandingArea | |
| Shrine | |
| SkiArea | |
| Spring | |
| Stadium | |
| StatisticalDistrict | |
| Temple | |
| Theater | |
| TouristRailway | |
| TouristStructure | |
| Trailhead | |
| TransportationStructure | |
| Tunnel | |
| Valley | |
| Volcano | |
| Walkway | |
| Wall | |
| WaterFeature | |
| Waterfall | |
| Wetland | |
| Winery | |
| Zoo |
AutocompleteResultTypeGroupsEnum
Adresse ou lieu
| Valeur | Description |
|---|---|
| Address |
Un emplacement d’adresse spécifique. Les types pris en charge sont les suivants :
|
| Place |
Tous les autres types appartiennent au groupe de types Lieu. Il peut s’agir d’entités telles que AdminDivision1, Neighborhood, PopulatedPlace, etc. |
CountryRegion
Pays ou région avec son nom et son code ISO.
| Nom | Type | Description |
|---|---|---|
| ISO |
string |
ISO du pays/de la région |
| name |
string |
nom du pays/de la région |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
| Nom | Type | Description |
|---|---|---|
| info |
object |
Informations supplémentaires. |
| type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
FeatureCollectionEnum
Spécifie le type GeoJSON. Le seul type d’objet pris en charge est FeatureCollection. Pour plus d’informations, consultez la RFC 7946.
| Valeur | Description |
|---|---|
| FeatureCollection |
Spécifie le type d’objet |
FeatureTypeEnum
Le type d’une fonction doit être Fonctionnalité.
| Valeur | Description |
|---|---|
| Feature |
Spécifie le type d’objet Feature |
GeoJsonPoint
Type de géométrie GeoJSON Point valide. Pour plus d’informations, reportez-vous à RFC 7946.
| Nom | Type | Description |
|---|---|---|
| bbox |
number[] (double) |
Cadre englobant. Projection utilisée - EPSG :3857. Pour plus d’informations, reportez-vous à RFC 7946. |
| coordinates |
number[] (double) |
Un |
| type |
string:
Point |
Spécifie le type |
Intersection
L’adresse du résultat.
| Nom | Type | Description |
|---|---|---|
| baseStreet |
string |
Rue principale pour l’emplacement. |
| displayName |
string |
Nom complet de l’intersection. |
| intersectionType |
string |
Type d’intersection. |
| secondaryStreet1 |
string |
La première rue qui se croise. |
| secondaryStreet2 |
string |
Le cas échéant, la deuxième rue qui se croise. |