WHwhat3words
what3words API

Grid section

Changed on

Returns a section of the 3m x 3m what3words grid for a bounding box. The bounding box is specified by lat,lng,lat,lng as south,west,north,east. You can request the grid in GeoJSON format, making it very simple to display on a map.

get/grid-section

Request

  • Base URL
    https://api.what3words.com/v3
  • Auth
    • API key in query parameter key
    • or API key in header X-Api-Key

Query parameters

keystring

A valid API key. Provide it as query parameter key; X-Api-Key header is also supported.

bounding-boxstring required
Example:52.207988,0.116126,52.208867,0.117540

Bounding box, as a lat,lng,lat,lng, for which the grid should be returned. The requested box must not exceed 4km from corner to corner, or a BadBoundingBoxTooBig error will be returned. Latitudes must be >= -90 and <= 90, but longitudes are allowed to wrap around 180. To specify a bounding-box that crosses the anti-meridian, use longitude greater than 180. e.g.: bounding-box=50.0,179.995,50.01,180.0005

format'json' | 'geojson'

Return data format type; can be either json (the default) or geojson

Response

Successful grid section retrieval

Example response

{
  "lines": [
    {
      "start": {
        "lat": 51.520847,
        "lng": -0.195521
      },
      "end": {
        "lat": 51.520847,
        "lng": -0.195521
      }
    }
  ]
}

Changes

  • 89db2437e8b6Revision changes
    • warning

      added the new BadInput enum value to the / response property for the response status

    • warning

      added the new BadInput enum value to the // response property for the response status

    • warning

      added the new BadNFocusResults enum value to the / response property for the response status

    • warning

      added the new BadNFocusResults enum value to the // response property for the response status

    • warning

      added the new BadNResults enum value to the / response property for the response status

    • warning

      added the new BadNResults enum value to the // response property for the response status

    • warning

      added the new DuplicateParameter enum value to the / response property for the response status

    • warning

      added the new DuplicateParameter enum value to the // response property for the response status

    • warning

      added the new MissingKey enum value to the / response property for the response status

    • warning

      added the new MissingKey enum value to the // response property for the response status

    • info

      the endpoint scheme security ApiKeyHeader was added to the API

    • info

      the query request parameter key became optional

    • info

      removed the BadLocale enum value from the / response property for the response status

    • info

      removed the BadLocale enum value from the // response property for the response status