Place - v4

Place version for merged location search¶

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

URL¶

https://maps.vietmap.vn/api/place/v4?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	auto:RAkPcicmZ3d-NQhac2kADHYlbFAkBiEeAQAkCV0EXwdF_KakgoWOrg0FFWZfh4jFXA1kXfbZFlNRGFUYCAJXAF8BUQBVCAZUC18EA1VMAwUYXwJQBBQFBQVTHVFacANBQlU

Example¶

Input:

 https://maps.vietmap.vn/api/place/v4?apikey={your-apikey}&refid=auto:RAkPcicmZ3d-NQhac2kADHYlbFAkBiEeAQAkCV0EXwdF_KakgoWOrg0FFWZfh4jFXA1kXfbZFlNRGFUYCAJXAF8BUQBVCAZUC18EA1VMAwUYXwJQBBQFBQVTHVFacANBQlU

Response body:

Note: Response model will auto response like output format of previous API. If input refid is from new format API response, response model will be new format and vice versa.

{
    "display": "197 Đường Trần Phú,Phường Chợ Quán,Thành Phố Hồ Chí Minh",
    "name": "",
    "hs_num": "197",
    "street": "Đường Trần Phú",
    "address": "197 Đường Trần Phú",
    "city_id": 12,
    "city": "Thành Phố Hồ Chí Minh",
    "district_id": 0,
    "district": "",
    "ward_id": 18700,
    "ward": "Phường Chợ Quán",
    "lat": 10.759222947000069,
    "lng": 106.67590269100003
}

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. Currently, it is always `0` for the new display format. For the old display format, it will be the district ID.
district	string	Name of the district. Currently, it is always an empty string for the new display format. For the old display format, it will be the district name.
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