Search - Get Geocode Autocomplete
사용자의 위치 및 부분 쿼리를 기반으로 제안된 엔터티의 순위 목록을 가져오는 데 사용합니다.
사용자의 위치와 전체 쿼리 문자열(쿼리 접두사라고 함)의 접두사 역할을 하는 부분 쿼리가 있는 요청이 주어지면 Azure Maps 자동 완성 API는 사용자가 검색할 가능성이 가장 높은 제안된 엔터티 목록을 반환합니다. 이러한 엔터티는 가능성이 가장 높은 것부터 가장 낮은 것까지 순위가 매겨집니다.
중요합니다
이 기능을 사용하면 미리 보기 약관에 동의하게 됩니다. 자세한 내용은 미리 보기 추가 약관참조하세요.
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}
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Azure Maps API의 버전 번호입니다. |
|
query
|
query | True |
string |
필수 사항입니다. 사용자의 쿼리 접두사입니다. 예: "1 Micro" 또는 "Muir Woods". |
|
bbox
|
query |
number[] |
제공되지 않는 경우 예: lon1,lat1,lon2,lat2. 최소 크기: 약 0.00001도(~0.01미터). 최대 크기: 전체 전역 범위(-180,-90 - 180,90) |
|
|
coordinates
|
query |
number[] |
제공되지 않는 경우
메모: |
|
|
country
|
query |
string |
지정된 ISO 3166-1 Alpha-2 지역/국가 코드 (예: FR)에 대한 자동 완성 결과에 대한 신호입니다. 지정된 국가/지역의 결과만 반환됩니다. |
|
|
result
|
query |
반환된 엔터티 형식 그룹의 쉼표로 구분된 목록입니다. 가능한 값은 다음과 같습니다.
|
||
|
result
|
query |
반환된 엔터티 형식의 쉼표로 구분된 목록입니다. 유형 그룹이 주소로 설정된 경우 지원되는 유형은 다음과 같습니다.
다른 모든 유형은 장소 유형 그룹에 속합니다. 여기에는 AdminDivision1, Neighborhood, PopulatedPlace 등과 같은 엔터티가 포함될 수 있습니다. 기본값은 가능한 모든 엔터티 형식입니다. |
||
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
반환될 최대 응답 수입니다. 기본값: 5, 최소: 1 및 최대: 20. |
|
|
view
|
query |
string |
ISO 3166-1 Alpha-2 지역/국가 코드를 나타내는 문자열입니다. 이렇게 하면 지정학적 분쟁 경계와 레이블이 지정된 사용자 지역에 맞게 변경됩니다. 기본적으로 View 매개 변수는 요청에서 정의하지 않은 경우에도 "Auto"로 설정됩니다. 자세한 내용은 지원되는 뷰 참조하고 사용 가능한 보기를 확인하세요. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Azure AD 보안 모델과 함께 사용할 계정을 지정합니다. Azure Maps 계정에 대한 고유 ID를 나타내며 Azure Maps 관리 평면 계정 API에서 검색할 수 있습니다. Azure Maps에서 Microsoft Entra ID 보안을 사용하는 방법에 대한 자세한 내용은 Azure Maps에서 인증 관리를 참조하세요. |
|
| Accept-Language |
string |
검색 결과를 반환해야 하는 언어입니다. 자세한 내용은 지원되는 언어 참조하세요. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
그래 Media Types: "application/geo+json" 헤더 x-ms-request-id: string |
|
| Other Status Codes |
예기치 않은 오류가 발생했습니다. Media Types: "application/geo+json" |
보안
AADToken
다음은 Microsoft Entra OAuth 2.0 흐름에
시나리오를 구현하려면
비고
- 이 보안 정의
x-ms-client-id헤더를 사용하여 애플리케이션이 액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API가져올 수 있습니다. -
Authorization URLAzure 퍼블릭 클라우드 인스턴스와 관련이 있습니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Microsoft Entra ID 구성이 있습니다. - Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해
Azure 관리 평면에서 구성됩니다. - Azure Maps Web SDK 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 사용할 수 있습니다.
- Microsoft ID 플랫폼에 대한 자세한 내용은 Microsoft ID 플랫폼 개요참조하세요.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name | Description |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해
이 키를 사용하면 모든 애플리케이션이 모든 REST API에 액세스할 수 있는 권한이 부여됩니다. 즉, 이러한 키는 현재 발급된 계정의 마스터 키로 처리될 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 이 키를 안전하게 저장할 수 있는 Azure Maps REST API의 서버-서버 액세스를 사용하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
header
SAS Token
공유 액세스 서명 토큰은 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면을 통해
이 토큰을 사용하면 모든 애플리케이션이 Azure 역할 기반 액세스 제어를 사용하여 액세스하고 특정 토큰에 사용할 만료, 속도 및 지역에 대한 세분화된 제어 권한을 부여받습니다. 즉, SAS 토큰을 사용하여 애플리케이션이 공유 키보다 더 보안이 유지되는 방식으로 액세스를 제어할 수 있습니다.
공개적으로 노출된 애플리케이션의 경우 렌더링 남용을 제한하고 정기적으로 SAS 토큰을 갱신하도록 맵 계정 리소스 허용된 원본의 특정 목록을 구성하는 것이 좋습니다.
형식:
apiKey
In(다음 안에):
header
예제
Autocomplete API call to search for '1 Microsoft'
샘플 요청
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=1 Microsoft&coordinates=-113.301894,49.201888
샘플 응답
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
샘플 요청
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
샘플 응답
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": []
}
Autocomplete API call to search for 'Muir Woods', filtered by address resultTypeGroups
샘플 요청
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-113.301894,49.201888&resultTypeGroups=Address
샘플 응답
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
샘플 요청
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
샘플 응답
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
샘플 요청
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypes=Park
샘플 응답
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
샘플 요청
GET https://atlas.microsoft.com/geocode:autocomplete?api-version=2025-06-01-preview&query=Muir Woods&coordinates=-122.581711,37.896980&resultTypeGroups=Place
샘플 응답
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
샘플 요청
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
샘플 응답
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"
}
}
}
]
}
정의
| Name | Description |
|---|---|
| Address |
결과의 주소입니다. |
|
Admin |
주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분화로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다. |
|
Autocomplete |
자동 완성 결과의 기능 |
|
Autocomplete |
자동 완성 결과의 속성 |
|
Autocomplete |
이 개체는 성공적인 자동 완성 호출에서 반환됩니다. |
|
Autocomplete |
제안 유형 |
|
Autocomplete |
주소 또는 장소 |
|
Country |
이름 및 ISO 코드가 있는 국가 또는 지역입니다. |
|
Error |
리소스 관리 오류 추가 정보입니다. |
|
Error |
오류 세부 정보입니다. |
|
Error |
오류 응답 |
|
Feature |
|
|
Feature |
피처 유형은 피쳐여야 합니다. |
|
Geo |
유효한 |
| Intersection |
결과의 주소입니다. |
Address
결과의 주소입니다.
| Name | 형식 | Description |
|---|---|---|
| addressLine |
string |
거리 이름과 번호가 포함된 AddressLine |
| adminDistricts |
주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분화로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다. |
|
| countryRegion |
이름 및 ISO 코드가 있는 국가 또는 지역입니다. |
|
| formattedAddress |
string |
형식이 지정된 주소 속성 |
| intersection |
결과의 주소입니다. |
|
| locality |
string |
지역 속성 |
| neighborhood |
string |
인근 부동산 |
| postalCode |
string |
우편 번호 속성 |
| streetName |
string |
formattedAddress의 거리 이름 |
| streetNumber |
string |
formattedAddress의 거리의 번호(사용 가능한 경우) |
AdminDistricts
주소에 대한 국가 또는 지역의 세분화 이름입니다. 이 요소는 일반적으로 첫 번째 순서 관리 세분화로 처리되지만 경우에 따라 국가, 종속성 또는 지역의 두 번째, 세 번째 또는 네 번째 순서 세분화도 포함됩니다.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
해당 adminDistrict 필드의 이름, adminDistrict[0]의 경우 Washington과 같은 주의 전체 이름일 수 있고, adminDistrict[1]의 경우 카운티의 전체 이름일 수 있습니다. |
| shortName |
string |
해당 adminDistrict 필드의 짧은 이름, adminDistrict[0]의 경우 WA와 같은 주의 짧은 이름일 수 있습니다. adminDistrict[1]의 경우 카운티의 짧은 이름일 수 있습니다 |
AutocompleteFeature
자동 완성 결과의 기능
| Name | 형식 | Description |
|---|---|---|
| geometry |
유효한 |
|
| properties |
자동 완성 결과의 속성 |
|
| type |
|
AutocompleteProperties
자동 완성 결과의 속성
| Name | 형식 | Description |
|---|---|---|
| address |
결과의 주소입니다. |
|
| name |
string |
장소의 이름입니다. 반환된 형식이 주소인 경우 이 필드는 표시되지 않습니다. |
| type |
제안 유형 |
|
| typeGroup |
주소 또는 장소 |
AutocompleteResponse
이 개체는 성공적인 자동 완성 호출에서 반환됩니다.
| Name | 형식 | Description |
|---|---|---|
| features |
자동 완성 결과의 기능 |
|
| nextLink |
string |
반환된 기능의 다음 페이지에 대한 링크입니다. 마지막 페이지인 경우 이 필드가 없습니다. |
| type |
|
AutocompleteResultTypeEnum
제안 유형
| 값 | 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
주소 또는 장소
| 값 | Description |
|---|---|
| Address |
특정 주소 위치입니다. 지원되는 형식은 다음과 같습니다.
|
| Place |
다른 모든 유형은 장소 유형 그룹에 속합니다. 여기에는 AdminDivision1, Neighborhood, PopulatedPlace 등과 같은 엔터티가 포함될 수 있습니다. |
CountryRegion
이름 및 ISO 코드가 있는 국가 또는 지역입니다.
| Name | 형식 | Description |
|---|---|---|
| ISO |
string |
국가/지역의 ISO |
| name |
string |
국가/지역의 이름 |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| info |
object |
추가 정보입니다. |
| type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보입니다. |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상입니다. |
ErrorResponse
오류 응답
| Name | 형식 | Description |
|---|---|---|
| error |
오류 개체입니다. |
FeatureCollectionEnum
GeoJSON 형식을 지정합니다. 지원되는 유일한 개체 형식은 FeatureCollection. 자세한 내용은 RFC 7946을 참조하세요.
| 값 | Description |
|---|---|
| FeatureCollection |
|
FeatureTypeEnum
피처 유형은 피쳐여야 합니다.
| 값 | Description |
|---|---|
| Feature |
|
GeoJsonPoint
유효한 GeoJSON Point 기하 도형 형식입니다. 자세한 내용은 RFC 7946 참조하세요.
| Name | 형식 | Description |
|---|---|---|
| bbox |
number[] (double) |
경계 상자. 사용된 프로젝션 - EPSG:3857. 자세한 내용은 RFC 7946 참조하세요. |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
|
Intersection
결과의 주소입니다.
| Name | 형식 | Description |
|---|---|---|
| baseStreet |
string |
위치의 기본 거리입니다. |
| displayName |
string |
교차로의 전체 이름입니다. |
| intersectionType |
string |
교차 유형. |
| secondaryStreet1 |
string |
첫 번째 교차 거리. |
| secondaryStreet2 |
string |
있는 경우 두 번째 교차 거리입니다. |