How to handle errors in What 3 Words

A successful API call will return an HTTP status code of 200. However, your code should always also handle potential errors. The most common error is a BadWords, which occurs when you call convert-to-coordinates with an invalid 3 word address. In this case, you will get the appropriate HTTP error status (400 in this case). Also, the body will contain an error block with a code and a message. code can be used programmatically so you can respond appropriately. message is intended as a helpful message to help you understand what went wrong.

Example error

URL: https://what3words.search.hereapi.com/v3/convert-to-coordinates?words=no.address.here&key=[API-KEY]

The response will be an HTTP 400, with the following body:

JSON

{
  "error": {
      "code": "BadWords",
      "message": "Invalid or non-existent 3 word address"
  }
}

Below is a list of all HTTP error codes. This is not an exhaustive list; new error codes may be added in future.