what3words API Docs: Developer resources, OpenAPI specs, and LLM integration guides for precise location technology.
Last-Modified: 2026-03-02

what3words Developer Documentation

what3words is a global addressing system that has divided the world into 3m squares, each with a unique 3 word address. This documentation provides comprehensive resources for developers integrating what3words technology into applications, websites, and services.

HIGH-VALUE FAQ

Q: How do I add a 3 word address search box to my website?
A: Use the JavaScript AutoSuggest Component – see guide ➜ https://developer.what3words.com/tutorial/javascript-autosuggest-component

Q: How do I convert coordinates to a 3WA in code?
A: Call GET /convert‑to‑3wa in our REST API – see API docs ➜ https://developer.what3words.com/public-api/docs#convert-to-3wa

Q: Where do I get an API key?
A: Create one in the Developer Dashboard ➜ https://accounts.what3words.com/create-api-key

Q: How do I add the what3words Search box component to a Replit project?
A: Use the CDN version of the component to avoid vite.config issues

GET STARTED

This section provides essential resources for beginning your integration with what3words technology.

Overview – Introduction to what3words API capabilities and integration options
UX guidelines – Fundamental user experience considerations for integrating what3words
Migrating an application from API V2 to API V3 – Guide to transition applications from what3words API version 2 to version 3

SEARCH BOX

Implement what3words address search functionality across different platforms with these integration guides.

Web Search Box

Add what3words address search to websites and web applications.

Using the JavaScript AutoSuggest Component (v5) – Add a what3words AutoSuggest input box to your website
Using JavaScript SDK – Integrate what3words into web apps using the JavaScript SDK and web components

iOS Search Box SDK

Implement what3words address search in iOS applications.

Creating an AutoSuggest field in Swift – Add a 3 word address text field with AutoSuggest to an iOS app (Swift)
Creating an AutoSuggest field in Objective-C – Add a 3 word address text field with AutoSuggest (dropdown) to an iOS app (Obj-C)
Swift Samples (GitHub) – Sample Swift projects and code examples for integrating what3words into iOS applications

Android Search Box SDK

Implement what3words address search in Android applications.

Creating an AutoSuggest field in Android – Add a 3 word address input (AutoSuggest EditText) to an Android app

E-commerce plugins

Add what3words address functionality to e-commerce platforms for precise delivery locations.

Shopify app – Installing and configuring the what3words Shopify (Plus and Basic) apps
WooCommerce plugin – Installing and configuring the what3words WooCommerce address field plugin
Adobe Commerce (Magento 2) extension – Installing and configuring the what3words Adobe Commerce (Magento 2) extension
Adding what3words to e-commerce checkout – Enable customers to enter 3 word addresses at checkout for precise delivery locations
BigCommerce app – Installing and configuring the what3words BigCommerce app
Ecwid on Wix integration – Adding the what3words Ecwid app to a Wix site
Shopware plugin – Installing and configuring the what3words Shopware plugin
Ecwid app – Installing and configuring the what3words Ecwid app
AeroCommerce extension – Installing and configuring the what3words AeroCommerce extension
CubeCart extension – Installing and configuring the what3words CubeCart extension
OpenCart extension – Installing and configuring the what3words OpenCart plugin
WordPress plugin – Installing and configuring the what3words WordPress address field plugin
Adobe Commerce (Magento 1) extension – Installing and configuring the what3words Adobe Commerce (Magento 1) extension
Haravan store integration – Thêm trường what3words vào cửa hàng Haravan (adding AutoSuggest field to Haravan checkout)

Delivery notes component

Add what3words address input to existing text fields.

Using the Notes Component – Add a what3words address field to an existing textarea using the Notes Component

Enable Existing Search Box

Integrate what3words into existing search functionality.

Ride-hailing Integration – How to add what3words to a ride-hailing platform – Guide to integrate what3words into a ride-hailing platform

CONVERSIONS

Convert between what3words addresses and geographic coordinates.

what3words → coordinates – Convert a 3 word address to latitude and longitude coordinates
Coordinates → what3words – Convert latitude and longitude coordinates to a 3 word address

CONVERSATIONAL CHAT

Integrate what3words with AI and conversational interfaces.

AI & LLM integrations – New page coming soon - Integrate what3words with AI assistants and large language models

POSTAL ADDRESSES VIA SWIFTCOMPLETE

Enhance address input with Swiftcomplete's address autocomplete, validation, and geocoding.

Address Autocomplete

Implement address autocomplete functionality across platforms.

Plugins

Add address autocomplete to e-commerce platforms.

Swiftcomplete Address Autocomplete - Shopify Plus – Implement address autocomplete in Shopify Plus stores
Swiftcomplete Address Autocomplete - WooCommerce – Implement address autocomplete in WooCommerce stores
Swiftcomplete Address Autocomplete - BigCommerce – Implement address autocomplete in BigCommerce stores
Swiftcomplete Address Autocomplete - Ecwid – Implement address autocomplete in Ecwid stores
Adding Swiftcomplete Address Autocomplete to E-commerce Checkout – General guide for adding address autocomplete to e-commerce platforms

Web and Mobile Components

Implement address autocomplete in custom applications.

Swiftcomplete Address Autocomplete - JavaScript Component – Add address autocomplete to websites and web applications

Address Validation

Validate postal addresses for accuracy and deliverability.

No tutorials available yet

Batch Validation

Process multiple addresses for validation in batch operations.

No tutorials available yet

Geocoding

Convert postal addresses to geographic coordinates.

No tutorials available yet

ENTERPRISE SUITE

Advanced solutions for enterprise-level integrations with offline capabilities.

Overview – Introduction to what3words Enterprise Suite capabilities
Mobile SDKs – Offline-capable SDKs for mobile applications
C++ & Java SDKs – Native SDKs for C++ and Java applications
Self-Hosted API – Host the what3words API on your own infrastructure

DISPLAY MAP

Visualize what3words grid and addresses on maps across platforms.

Web Map component

Display what3words grid on web-based maps.

Using the Web Map Component – Display the what3words 3m grid and marker on a Google Map (web)

iOS Map SDK

Display what3words grid on iOS maps.

Using the iOS Map Component – Display the what3words grid and marker on Apple Maps in an iOS app

Android Map SDK

Display what3words grid on Android maps.

Using the Android Map Component – Display the what3words grid and a 3 word address marker on Google Maps/Mapbox in an Android app

Others (Google/Mapbox/Leaflet/Bing)

Integrate what3words with various mapping frameworks.

Displaying the what3words grid on a Google Map – Add a Google Map to your site with the what3words grid overlay
Displaying the what3words grid on a Mapbox Map – Add a Mapbox map to your site with the what3words grid overlay
Displaying the what3words grid on a LeafletJS Map – Add a LeafletJS map to your site with the what3words grid overlay
Displaying the what3words grid on a Bing Map – Add a Bing Maps component to your website showing the what3words 3m grid
Combining AutoSuggest with a Google Map – Integrate the what3words AutoSuggest field with a Google Maps API map on your site
Combining AutoSuggest with a Mapbox GL JS map – Integrate the what3words AutoSuggest field with a Mapbox GL JS map on your website
Combining AutoSuggest with a LeafletJS map – Integrate the what3words AutoSuggest field with a Leaflet map on your website

SCANNING

Scan and recognize what3words addresses from images.

iOS OCR Component

Implement optical character recognition for what3words addresses in iOS apps.

Using the iOS OCR Component – Scan images for what3words addresses in an iOS app using the OCR component

Android OCR Component

Implement optical character recognition for what3words addresses in Android apps.

Using the Android OCR Component – Scan images for what3words addresses in an Android app using the OCR component

SPEECH-TO-TEXT

Convert spoken what3words addresses to text.

Using inputType=voice – Implement speech recognition for what3words addresses

GIS & SPREADSHEET TOOLS

Integrate what3words with geographic information systems and spreadsheet applications.

Excel Add-in

Use what3words in Microsoft Excel.

what3words for Excel add-in – Use Excel to convert coordinates to 3 word addresses (and vice versa), translate addresses, and get AutoSuggest results

GSheets Add-in

Use what3words in Google Sheets.

what3words for Google Sheets add-on – Use Google Sheets to convert coordinates to 3 word addresses, translate them, and get AutoSuggest suggestions

ArcGIS extension

Integrate what3words with Esri ArcGIS platform.

ArcGIS Platform (All) – Use the what3words Locator across the ArcGIS platform
ArcGIS Online (Locator) – Add the what3words Locator to ArcGIS Online (as a utility service)
ArcGIS Desktop (ArcMap/ArcCatalog) – Add the what3words Locator to ArcGIS Desktop (ArcMap, ArcCatalog, ArcToolbox)
ArcGIS Online & Survey123 – Add the what3words Locator to ArcGIS Online and set up a Survey123 form
ArcMap (ArcGIS Desktop) – Use the geocoding toolbar in ArcMap (ArcGIS Desktop) with the what3words Locator
ArcGIS Online: Search addresses – Search for a 3 word address in ArcGIS Online and publish it in a web app
ArcGIS Online: Plot CSV of addresses – Drag-and-drop a CSV of 3 word addresses onto an ArcGIS Online map
ArcGIS Pro – Use the what3words Locator within ArcGIS Pro (desktop GIS)
ArcGIS Enterprise (Portal) – Add the what3words Locator to Portal for ArcGIS Enterprise
ArcGIS Online & Field Maps – Add the what3words Locator to ArcGIS Online and set up a survey for Field Maps
ArcGIS API for JavaScript – Use the what3words Locator within the ArcGIS API for JavaScript
ArcGIS for SharePoint – Add the what3words Locator to ArcGIS for SharePoint
ArcGIS for Office (Excel & PowerPoint) – Add the what3words Locator to ArcGIS for Office (Microsoft Excel and PowerPoint)
ArcGIS Experience Builder widget – Add the what3words Locator to a custom ArcGIS Experience Builder widget
ArcGIS Web AppBuilder widget – Add the what3words Locator to a custom ArcGIS Web AppBuilder widget

QGIS plugin

Integrate what3words with QGIS open-source GIS.

QGIS plugin (Planet Federal) – Add and configure the what3words plugin for QGIS

Grid endpoints

Access what3words grid data via API.

Grid endpoints – API endpoints for retrieving what3words grid information

Other GIS integrations

Integrate what3words with additional GIS platforms.

GE Smallworld integration – Add the what3words Java API to GE Smallworld (GIS)
Geocortex Essentials – Configure Geocortex Essentials to use what3words services
Cadcorp SIS WebMap – Add what3words support to your Cadcorp SIS WebMap instance
MapInfo Pro – Add and configure the what3words extension in MapInfo Pro

API & SDK REFERENCE

Technical reference documentation for what3words APIs and SDKs.

Cloud REST API

Core API documentation for what3words services.

Cloud REST API – Complete reference for the what3words REST API

Client libraries & wrappers

Official API wrappers for various programming languages.

JavaScript API Wrapper – Getting started with the what3words JavaScript API wrapper
Swift API Wrapper – Getting started with the what3words Swift API wrapper
Java API Wrapper – Getting started with the what3words Java API wrapper
Python API Wrapper – Getting started with the what3words Python API wrapper
PHP API Wrapper – Getting started with the what3words PHP API wrapper
.NET API Wrapper – Getting started with the what3words .NET API wrapper
Ruby API Wrapper – Getting started with the what3words Ruby API wrapper
Golang API Wrapper – Getting started with the what3words Go API wrapper
Rust API Wrapper – Getting started with the what3words Rust API wrapper
Dart API Wrapper – Getting started with the what3words Dart API wrapper
Flutter API Wrapper – Getting started with the what3words Flutter API wrapper
Android API Wrapper (v4) – Getting started with the what3words Android API wrapper
Migrating Android API Wrapper from 3.x to 4.x – Update guide for the Android wrapper (v3 to v4)
Objective-C API Wrapper – Getting started with the what3words Objective-C API wrapper
Legacy Android API Wrapper – (v3.x) Getting started with the older what3words Android API wrapper

Regex

Validate what3words addresses without API calls.

Detecting if text is a what3words address using RegEx – Check if a string matches the pattern of a 3 word address without calling the API

Error codes & rate limits

Understand API error handling and usage limits.

Error codes & rate limits – Reference for API error codes and rate limiting policies

Playground

Interactive API testing environment.

Playground – Test what3words API endpoints interactively

GUIDELINES & SUPPORT

Resources for implementation best practices and support.

UX guidelines – Best practices for user experience when implementing what3words
FAQs – Frequently asked questions about what3words implementation

QUICK LINKS & RESOURCES

Essential resources for what3words developers.

Developer site - Public API – Public API documentation and resources
Developer site - Enterprise Suite – Enterprise-level integration solutions
Plan Pricing – API pricing and subscription plans
Help & Support – Contact the support team for assistance
OpenAPI Spec – OpenAPI specification for what3words API
Postman collection – Ready-to-use Postman collection for API testing

Blog deep-dives

Minimum word and address lengths in what3words: code points vs characters – Why length limits are defined in Unicode code points
Understanding locales in what3words – How language and script variants are represented in API codes
Demystifying the alias parameter in what3words address URLs – How alias links work and when to use them
How what3words addresses work in left-to-right (LTR) and right-to-left (RTL) scripts – Directionality and UI handling guidance
How what3words supports natural variants across languages using secondary words – How alternative accepted forms map to canonical addresses
Understanding the what3words regex: a human-friendly guide – Regex scope, capabilities, and limitations

Optional

Additional resources organized by implementation type.

UI Components

Additional UI component implementations.

Creating an AutoSuggest input box (v3.1, deprecated) – Deprecated: Add a what3words AutoSuggest address input to a webpage in just a few lines of code

Mobile Integration

Additional mobile integration options.

Mobile linking to the what3words app – Use URL schemes/intents to open the what3words mobile app at a specific 3 word address

Server-Side Solutions

Backend implementation guides.

Hiding your API Key (Proxy Setup) – Proxy API calls through your server to avoid exposing your what3words API key in client-side code

Website Integration

Additional website integration options.

Import and Plot 3 word addresses on the Map Site (CSV) – Upload a CSV of what3words addresses to the what3words Map Site, plot them on the map, and sync to the mobile app

Enterprise & Platform Integrations

Integrations with enterprise platforms.

Procore integration – Add what3words functionality to the Procore construction management platform
Yext integration – Add what3words address search to Yext (marketing/locations platform)
Salesforce integration – Add what3words API capabilities to Salesforce (e.g. in forms or workflows)

Industry Use Case Guides

Implementation guides for specific industries.

Navigation – How to add what3words to a navigation app – Guide to integrate what3words into a navigation or maps application