Skip to main content

Forward Geocoding

Find locations based on addresses or place names

Description​

Forward geocoding is used for finding latitude and longitude coordinates based on addresses or place names—like typing an address into a search bar to see its location on a map.

tip

When using that, just use our Enterprise Dashboard or guild API Key to create your API Key try for free!

Base URL​

The base URL for all API requests is:

https://mapapis.openmap.vn/v1

Endpoint​

GET /geocode/forward

Google format​

API references​

ParameterTypeRequiredDefaultExample
addressstringyesnonephuong mai dich
admin_v2booleannofalseReturn information about new locations after administrative boundary consolidation

Example​

Request:

GET /geocode/forward?address=12 Ngõ 1 Dịch Vọng Hậu, Dịch Vọng Hậu, Cầu Giấy, Hà Nội&apikey=YOUR_API_KEY

Response:

{
  "results": [
    {
      "address": "phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
      "address_components": [
        {
          "long_name": "12 Ngõ 1 Phố Dịch Vọng Hậu",
          "short_name": "12 Ngõ 1 Phố Dịch Vọng Hậu"
        },
        {
          "long_name": "phường Dịch Vọng Hậu",
          "short_name": "Dịch Vọng Hậu"
        },
        {
          "long_name": "quận Cầu Giấy",
          "short_name": "Cầu Giấy"
        },
        {
          "long_name": "thành phố Hà Nội",
          "short_name": "Hà Nội"
        }
      ],
      "formatted_address": "12 Ngõ 1 Phố Dịch Vọng Hậu, phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
      "geometry": {
        "location": {
          "lat": 21.032783,
          "lng": 105.787915
        }
      },
      "name": "12 Ngõ 1 Phố Dịch Vọng Hậu",
      "place_id": "IbRaWQQeWAktoVyLNm16X6HCFG1o3lF9mXJwfXTCneX1UnE9aM_1YWy2mGm0",
      "types": [""]
    }
  ],
  "status": "OK"
}

OSM format​

API references​

ParameterTypeRequiredDefaultExample
textstringyesnonephuong mai dich
sizeintegerno11
admin_v2booleannofalseReturn information about new locations after administrative boundary consolidation

Example​

Request:

GET /geocode/forward?text=12 Ngõ 1 Dịch Vọng Hậu, Dịch Vọng Hậu, Cầu Giấy, Hà Nội&apikey=YOUR_API_KEY

Response:

{
  "bbox": [],
  "errors": null,
  "features": [
    {
      "geometry": {
        "coordinates": [105.787915, 21.032783],
        "type": "Point"
      },
      "properties": {
        "category": [""],
        "continent": "Asia",
        "country": "Việt Nam",
        "country_code": "VN",
        "county": "quận Cầu Giấy",
        "distance": null,
        "housenumber": "",
        "id": "IbRaWQQeWAktoVyLNm16X6HCFG1o3lF9mXJwfXTCneX1UnE9aM_1YWy2mGm0",
        "label": "12 Ngõ 1 Phố Dịch Vọng Hậu, phường Dịch Vọng Hậu, quận Cầu Giấy, thành phố Hà Nội",
        "locality": "phường Dịch Vọng Hậu",
        "name": "12 Ngõ 1 Phố Dịch Vọng Hậu",
        "opening_hours": null,
        "opening_hours_v2": null,
        "phone": null,
        "postalcode": null,
        "region": "thành phố Hà Nội",
        "short_address": "",
        "source": "openmapvn",
        "street": "",
        "website": null
      },
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}