Reverse
Updating Reverse 3.0 API is a valuable resource for developers who want to incorporate location search features into their applications while achieving optimal performance. With its intelligent search algorithms and techniques, this latest version can swiftly deliver precise search results for users. This API is a powerful tool that can help enhance the user experience of location-based applications.
URL¶
Method¶
GET
Parameters¶
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
apikey | string | yes | API provided by VIETMAP for customer's account | |
lng | number | yes | Longitude of desired place | 106.675461 |
lat | number | yes | Latitude of desired place | 10.758970 |
cats | string | no | Provide full list of POI categories. Click here POI Categories | 1002-1 |
Example¶
Input
https://maps.vietmap.vn/api/reverse/v3?apikey={your-apikey}&lng=106.67546114000004&lat=10.758970242000032
[
{
"lat": 10.758970242000032,
"lng": 106.67546114000004,
"ref_id": "vm:ADDRESS:MM03541B04565A0C051D540650021D04050651165351004C1B060551045704520055080652065F06133710D4888A08122C5AEE965B1537EED60F",
"distance": 4.214098139843284E-05,
"address": "Phường 9,Quận 5,Thành Phố Hồ Chí Minh",
"name": "3 Trần Nhân Tôn",
"display": "3 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": []
}
]
Response description¶
Reverse API will respond to a list
that contains up to 10 places
.
Parameter | Type | Description |
---|---|---|
lat | double | Latitude coordinate of the POI |
lng | double | Longitude coordinate of the POI |
ref_id | string | Reference ID for the POI |
distance | int | Distance of the POI from a reference point (if applicable), value response in kilometer |
address | string | Full address including street , ward , district , and city |
name | string | Name of the 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) |