https://github.com/what3words/what3words-api-docs
Host public Openapi spec and llms files for the what3words Public API
https://github.com/what3words/what3words-api-docs
llms llmstxt openapi postman-collection what3words what3words-api
Last synced: 23 days ago
JSON representation
Host public Openapi spec and llms files for the what3words Public API
- Host: GitHub
- URL: https://github.com/what3words/what3words-api-docs
- Owner: what3words
- Created: 2025-05-23T11:14:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-16T07:39:28.000Z (4 months ago)
- Last Synced: 2026-03-16T20:06:44.825Z (4 months ago)
- Topics: llms, llmstxt, openapi, postman-collection, what3words, what3words-api
- Homepage: http://openapi.what3words.com/
- Size: 309 KB
- Stars: 0
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](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](https://developer.what3words.com)
- [API Reference (OpenAPI)](https://openapi.what3words.com/openapi/openapi.yaml)
- [Postman Collection](https://openapi.what3words.com/what3words.postman_collection.json)
- [GitHub Repositories](https://github.com/what3words)
## ⚙️ 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](mailto:support@what3words.com).
## 📜 License
See [what3words Developer Terms of Service](https://developer.what3words.com/terms-of-service) for usage guidelines.