Place

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
}

Response description¶

Parameter	Type	Description
display	string	Display name containing detailed information of the address
name	string	Name of the street or location
hs_num	string	House number or building number
street	string	Name of the street
address	string	Additional address information (if available)
city_id	int	Unique identifier for the city
city	string	Name of the city
district_id	int	Unique identifier for the district
district	string	Name of the district
ward_id	int	Unique identifier for the ward
ward	string	Name of the ward
lat	number	Latitude coordinate of the address
lng	number	Longitude coordinate of the address