Geocode¶
Geocode API is a feature provided by VIETMAP that allows developers to convert a street address or place name into geographic coordinates (latitude and longitude). With the Geocode API, developers can create applications that can translate an address or place name into a location on the map, and display it in a custom map.
URL¶
https://maps.vietmap.vn/api/search?api-version=1.1&apikey={your-apikey}&text={text}&forcus.point.lat={forcus.point.lat}&forcus.point.lon={forcus.point.lon}&boundary.rect.min_lon={boundary.rect.min_lon}&boundary.rect.max_lon={boundary.rect.max_lon}&boundary.rect.min_lat={boundary.rect.min_lat}&boundary.rect.max_lat={boundary.rect.max_lat}&boundary.circle.lat={boundary.circle.lat}&boundary.circle.lon={boundary.circle.lon}&boundary.circle.radius={boundary.circle.radius}&layers={layers}
Method¶
GET
Parameter¶
| Parameter | Type | Required | Default | Example |
|---|---|---|---|---|
| text | string | yes | none | Trần Phú |
| focus.point.lat | floating point number | no | none | 10.756271 |
| focus.point.lon | floating point number | no | none | 106.661280 |
| boundary.rect.min_lon | floating point number | no | none | 106.3564 |
| boundary.rect.max_lon | floating point number | no | none | 107.012794 |
| boundary.rect.min_lat | floating point number | no | none | 11.160291 |
| boundary.rect.max_lat | floating point number | no | none | 10.376715 |
| boundary.circle.lat | floating point number | no | none | 10.756271 |
| boundary.circle.lon | floating point number | no | none | 106.661280 |
| boundary.circle.radius | floating point number | no | 50 | 35 |
| layers | string | no | all layers: address,street,venue | address,venue |
Filter Feature (as the same with autocomplete)¶
✔️ Layer filtering
✔️ Global scope, local focus
✔️ Search within a circular region
✔️ Search within categories
1. Layer filtering¶
| Layer | Description |
|---|---|
| venue | points of interest, businesses, things with walls |
| address | places with a street address |
| street | streets, roads, highways |
URL:
https://maps.vietmap.vn/api/search?api-version=1.1&apikey={your-apikey}&focus.point.lat={focus.point.lat}&focus.point.lon={focus.point.lon}
2. Global scope, local focus¶
| Parameter | Description |
|---|---|
| focus.point.lat | latitude coordinate |
| focus.point.lon | longitude coordinate |
URL:
https://maps.vietmap.vn/api/search?api-version=1.1&apikey={your-apikey}&focus.point.lat={focus.point.lat}&focus.point.lon={focus.point.lon}&text={text}
3. Search within a circular region¶
Focus on searching with pair of coordinates together with specific radius
| Parameter | Value |
|---|---|
| text | 193 Trần Phú |
| boundary.circle.lat | 10.756271 |
| boundary.circle.lon | 106.661280 |
| boundary.circle.radius | 0.5 |
URL:
https://maps.vietmap.vn/api/search?api-version=1.1&apikey={your-apikey}&focus.point.lat={focus.point.lat}&focus.point.lon={focus.point.lon}&boundary.circle.lon={boundary.circle.lon}&boundary.circle.lat={boundary.circle.lat}&boundary.circle.radius={boundary.circle.radius}&text={text}
4. Search within categories¶
Focus on searching with poi categories | chainName categories
| Parameter | Value |
|---|---|
| text | 193 Trần Phú |
| boundary.circle.lat | 10.756271 |
| boundary.circle.lon | 106.661280 |
| boundary.circle.radius | 0.5 |
URL:
