Skip to content

Geocode

Geocode version 3.0

geocode

Updating Geocode 3.0 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/v3?apikey={your-apikey}&text={text}&focus={lat,long}&layers={Layers}

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
layers string no Represent for certain type of data such as POI,ADDRESS,BUILDING,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/v3?apikey={your-apikey}&text=Công Ty Cổ Phần Ứng Dụng Bản Đồ Việt,HCM&layers=POI&cityId=12&distId=1292&wardId=984332

Respone 

{
        "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"
        ]
    }

Place version 3.0

The Place API service endpoint provides detailed information about the Place found by its identifier (refid).

URL

https://maps.vietmap.vn/api/place/v3?apikey={your-apikey}&refid={refid}

Method

GET

Parameter

Parameter Type Required Description Example
apikey string yes API provided by VIETMAP for customer's account.
refid string yes A unique refid identifier generated from search response vm:ADDRESS:8D92EB120DDE9996

Example

Input: 

 https://maps.vietmap.vn/api/place/v3?apikey={your-apikey}&refid=vm:ADDRESS:8D92EB120DDE9996

Respone body:

{
    "display": "3 Đường Trần Nhân Tôn Phường 9,Quận 5,Thành Phố Hồ Chí Minh",
    "name": "3 Đường Trần Nhân Tôn",
    "hs_num": "3",
    "street": "Đường Trần Nhân Tôn",
    "address": "",
    "city_id": 12,
    "city": "Thành Phố Hồ Chí Minh",
    "district_id": 1292,
    "district": "Quận 5",
    "ward_id": 984332,
    "ward": "Phường 9",
    "lat": 10.759011645000044,
    "lng": 106.67545328800009
}