Skip to content

Search - demo

geocode

Updating Geocode demo API is a powerful tool for developers to integrate location search functionality into their applications with optimized performance. Additionally, this latest version utilizes intelligent search algorithms and methods to provide accurate and speedy search results for users.

URL

https://maps.vietmap.vn/api/search/demo?apikey={your-apikey}&text={text}&focus={lat,long}&display_type={display_type}

Method

GET

Parameter

Parameter Type Required Description Example
apikey string yes API provided by VIETMAP for customer's account.
text string yes User desired input Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt
focus string no GPS cordinates 10.759540242000032, 106.67660114000005
display_type enum no Determines how the result is displayed after Vietnam's administrative merge. 1 = new format (default), 2 = old format. 1
layers string no Represent for certain type of data such as POI,ADDRESS,VILLAGE,WARD,DIST,CITY,STREET POI
circle_center number no The central coordinate(lat/lng) position of the area to be searched 10.758867051669924,106.6755666901197
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
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

Example

Input 

https://maps.vietmap.vn/api/search/demo?apikey={your-apikey}&focus=10.75887508,106.67538868&display_type=1&text=Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt,HCM

Respone

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

New display format

[
    {
        "ref_id": "auto:RAkPYywrDwppXwAncBwGBXEnaFtYD1QWcvPRXAEVMklFe9fZp0RlW4LYklwNh4nKXEoUcdTYiAwGFiDMi5MLEqKlh4v2GGAL09-yR0MhXVsNKFqhk0NcFXgKzNngWEJjUF1F9vbz1tHepVgFEjBH0tnFWxJjDvHAXA1g9oENFllQBkwaBAhcBVYHUgJVCAZSAVYOAlNUGwQaUwZUAxwABQVTHVJVDSRMXUMA",
        "distance": 0,
        "address": "Phường An Đông,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 Đường Trần Nhân Tôn",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Chi Nhánh Miền Nam Đường Trần Nhân Tôn Phường An Đông,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 18956,
                "name": "An Đông",
                "prefix": "Phường",
                "full_name": "Phường An Đông"
            },
            {
                "type": 0,
                "id": 12,
                "name": "Hồ Chí Minh",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Hồ Chí Minh"
            }
        ],
        "categories": [
            "6001"
        ],
        "entry_points": []
    },
    {
        "ref_id": "auto:RAkPYywrDwEaJAQjAB1wDXFaHFtRdSYWcvPRXAEVMklFe9fZp0RlW4LYklwNh4nKXEoUcdTYiAwGFiDMi5MLEqKlh4v2GGAL09-yR0M2R0dDARI28Y9ZFXeCl8EOFirukV4NEqKloICEg6sMVURhQYLYklwNNlqhiBYPBAVNGldYB1sdCAZUAlYFVgVdAwdSBEoDBFZaAgEbXgdSAh0EAw4lTA4SUw",
        "distance": 0,
        "address": "Phường Chợ Quán,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành Đường Trần Phú",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành Đường Trần Phú Phường Chợ Quán,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 18700,
                "name": "Chợ Quán",
                "prefix": "Phường",
                "full_name": "Phường Chợ Quán"
            },
            {
                "type": 0,
                "id": 12,
                "name": "Hồ Chí Minh",
                "prefix": "Thành Phố",
                "full_name": "Thành Phố Hồ Chí Minh"
            }
        ],
        "categories": [
            "6001"
        ],
        "entry_points": []
    }
]

Old display format

[
    {
        "ref_id": "vm:POI:7057AB748BFD685B",
        "distance": 0.069199492010845,
        "address": "197 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt 197 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 656652,
                "name": "4",
                "prefix": "Phường",
                "full_name": "Phường 4"
            },
            {
                "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"
        ],
        "entry_points": []
    },
    {
        "ref_id": "vm:POI:37B6A20D8D9190CD",
        "distance": 0.06445065459645513,
        "address": "199 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "name": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành",
        "display": "Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt Trung Tâm Bảo Hành 199 Đường Trần Phú,Phường 4,Quận 5,Thành Phố Hồ Chí Minh",
        "boundaries": [
            {
                "type": 2,
                "id": 656652,
                "name": "4",
                "prefix": "Phường",
                "full_name": "Phường 4"
            },
            {
                "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"
        ],
        "entry_points": []
    }
]

Response description

Geocode 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). For the new display format, the boundaries will be returned as an array of objects, each containing ward and city
categories array Array containing categories associated with the POI
entry_points array Array containing entry points associated with the POI. This value will available for some special address, like airport, hotel,...

For the boundaries array:

Sub-Parameter Type Description
type integer Type of boundary (0 for city, 1 for district, 2 for ward)
id integer 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)

For the entry_points array:

Sub-Parameter Type Description
ref_id string Reference ID for the Point of Interest (POI)
name string Name of the Point of Interest (POI)

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

facebook
Tổng đài hỗ trợ
089.616.4567 facebook Chat Facebook zalo Chat Zalo