what3words API Docs

Welcome to the official documentation repository for the what3words API. This repository hosts the OpenAPI specifications, developer resources, and LLM-friendly metadata for integrating what3words location technology into your applications.

🔍 About

what3words provides a simple way to communicate precise locations using unique three-word addresses. This repository includes API references, SDK guides, OpenAPI specifications, Postman collections, and resources for integrating with LLMs (Large Language Models).

🚀 Live OpenAPI Documentation

Explore the live interactive OpenAPI documentation here:
👉 https://openapi.what3words.com/openapi/openapi.yaml

📂 Repository Structure

The repository is organised as follows:

• docs/
  Main documentation folder, including:
  • index.html: Landing page for API docs and resources
  • llms.txt, llms-full.txt: LLM-friendly metadata for AI tools
  • openapi/: OpenAPI specifications (openapi.yaml, openapi.json) and viewer
  • what3words.postman_collection.json: Postman collection for API testing
  • assets/: Images and static assets

📚 Key Resources

• what3words Developer Site
• API Reference (OpenAPI)
• Postman Collection
• GitHub Repositories

⚙️ Usage

• Browse the documentation in the docs/ folder or open docs/index.html in your browser.
• Use the OpenAPI specs and Postman collection for API integration and testing.
• Reference llms.txt and llms-full.txt for LLM and AI tool onboarding.

🤝 Contributing

This repository is maintained by the what3words Developer Team. For suggestions or issues, please contact support@what3words.com.

📜 License

See what3words Developer Terms of Service for usage guidelines.