Skip to content

Autocomplete

autocomplete

Updating Autocomplete 3.0 API is a valuable resources that allows developers to integrate autocomplete functionality into their applications. This API is designed to help users quickly find and select items from a large set of options by suggesting potential matches as they type.

The API is built on a machine learning model that analyzes user input and suggests potential matches based on the context of the search. This model can be updated in real-time, allowing the API to continuously improve its suggestions as more data becomes available.

URL

https://maps.vietmap.vn/api/autocomplete/v3?apikey={your-apikey}&cityId={cityId}&text={text}&circle_center={circle_center}&circle_radius={circle_radius}&layers={layers}

Method

GET

Parameters

Parameter Type Required Description Example
apikey string yes API provided by VIETMAP for customer's account
cityId number no Every city has a unique ID, which is used to filter search results 12
distId number no Every district has a unique ID, which is used to filter search results 1292
wardId number no Every ward has a unique ID, which is used to filter search results 984332
circle_center number no The central coordinate (lat,lng) position of the area to be searched 10.758867,106.6755666
circle_radius number no The radius of the search area (in meters) 200
cats string no Provide full list of POI categories. Click here POI Categories 1002-1
focus number no Specify the center of the search context expressed as coordinates. 10.758867,106.675566
text string yes User desired input Cong ty
layers string no Represent for certain type of data such as POI,ADDRESS,BUILDING,VILLAGE,WARD,DIST,CITY,STREET POI

Example

Input 

https://maps.vietmap.vn/api/autocomplete/v3?apikey={your-apikey}&cityId=12&text=Cong ty&circle_center=10.758867,106.675566&circle_radius=200&layers=POI
Response

If you need detailed information about the place, please use the Vietmap Place API 

[
    {
        "ref_id": "vm:POI:8D92EB120DDE9996",
        "address": "3 Đường Trần Nhân Tôn,Phường 9,Quận 5,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Chi Nhánh Miền Nam",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Chi Nhánh Miền Nam 3 Đường Trần Nhân Tôn,Phường 9,Quận 5,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 984332,
                "name": "9",
                "prefix": "Phường",
                "full_name": "Phường 9"
            },
            {
                "type": 1,
                "id": 1292,
                "name": "5",
                "prefix": "Quận",
                "full_name": "Quận 5"
            },
            {
                "type": 0,
                "id": 12,
                "name": "Hồ Chí Minh",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Hồ Chí Minh"
            }
        ],
        "categories": [
            "6001"
        ]
    }
]

Response description

Autocomplete API will respond to a list that contains up to 10 places.

Parameter Type Description
ref_id string Reference ID for the Point of Interest (POI), using for get detail info from Vietmap Place API
address string Full address including street, ward, district, and city
name string Name of the Point of Interest (POI)
display string Display name containing detailed information of the POI address
boundaries array Array containing boundary information (ward, district, city)
categories array Array containing categories associated with the POI

For the boundaries array:

Sub-Parameter Type Description
type int Type of boundary (0 for city, 1 for district, 2 for ward)
id int Unique identifier for the boundary
name string Name of the boundary
prefix string Prefix of the boundary (e.g., "Phường" for ward)
full_name string Full name of the boundary (e.g., "Phường 9" for ward)