← Tools Reference

what3words

what3words integration (Location, Data). Imported from open-connector.

API key5 toolshttps://api.what3words.com/v3
GET
what3words_convert_to_coordinates
Convert a three word address into coordinates and square metadata.

/convert-to-coordinates

3 parameters
ParamTypeRequiredDescription
wordsstringrequiredThe three word address to convert, such as filled.count.soap.
formatstringoptionalThe response format requested from what3words.
localestringoptionalA supported language code used to localize the response.
GET
what3words_convert_to_3wa
Convert coordinates into a three word address.

/convert-to-3wa

4 parameters
ParamTypeRequiredDescription
latnumberrequiredThe latitude in decimal degrees.
lngnumberrequiredThe longitude in decimal degrees.
languagestringoptionalThe language code for the returned three word address.
formatstringoptionalThe response format requested from what3words.
GET
what3words_autosuggest
Return ranked three word address suggestions for partial or mistyped input.

/autosuggest

13 parameters
ParamTypeRequiredDescription
inputstringrequiredThe partial or mistyped three word address.
nResultsintegeroptionalThe maximum number of suggestions to return.
focusLatnumberoptionalThe latitude used to bias suggestions.
focusLngnumberoptionalThe longitude used to bias suggestions.
nFocusResultsintegeroptionalThe number of results to prioritize around the focus point.
clipToCountrystringoptionalA comma-separated list of ISO 3166-1 alpha-2 country codes used to restrict sug…
clipToCirclestringoptionalA circle restriction formatted as latitude,longitude,kilometers.
clipToBoundingBoxstringoptionalA bounding box restriction formatted as southwest-lat,southwest-lng,northeast-l…
clipToPolygonstringoptionalA polygon restriction formatted as comma-separated latitude,longitude coordinat…
inputTypestringoptionalThe autosuggest input type.
languagestringoptionalThe language code for autosuggest matching.
preferLandbooleanoptionalWhether suggestions should prefer land locations.
localestringoptionalA supported language code used to localize place names.
GET
what3words_grid_section
Return what3words grid line segments for a bounding box.

/grid-section

5 parameters
ParamTypeRequiredDescription
southwestLatnumberrequiredThe southwest latitude of the bounding box.
southwestLngnumberrequiredThe southwest longitude of the bounding box.
northeastLatnumberrequiredThe northeast latitude of the bounding box.
northeastLngnumberrequiredThe northeast longitude of the bounding box.
formatstringoptionalThe response format requested from what3words.
GET
what3words_available_languages
List the languages supported by the what3words API.

/available-languages