You're viewing version 1.3 of the OpenSearch documentation. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Geopoint field type

A geopoint field type contains a geographic point specified by latitude and longitude.

Example

Create a mapping with a geopoint field type:

PUT testindex1
{
  "mappings": {
    "properties": {
      "point": {
        "type": "geo_point"
      }
    }
  }
}

Formats

Geopoints can be indexed in the following formats:

• An object with a latitude and longitude

PUT testindex1/_doc/1
{
  "point": { 
    "lat": 40.71,
    "lon": 74.00
  }
}

• A string in the “latitude,longitude” format

PUT testindex1/_doc/2
{
  "point": "40.71,74.00" 
}

• A geohash

PUT testindex1/_doc/3
{
  "point": "txhxegj0uyp3"
}

• An array in the [longitude, latitude] format

PUT testindex1/_doc/4
{
  "point": [74.00, 40.71] 
}

• A Well-Known Text POINT in the “POINT(longitude latitude)” format

PUT testindex1/_doc/5
{
  "point": "POINT (74.00 40.71)"
}

• GeoJSON format, where the coordinates are in the [longitude, latitude] format

PUT testindex1/_doc/6
{
  "point": {
    "type": "Point",
    "coordinates": [74.00, 40.71]
  }
}

Parameters

The following table lists the parameters accepted by geopoint field types. All parameters are optional.