Various open source projects make use of the ProtonMail API. Due to the lack of an official API documentation by ProtonMail, their developers generally reverse engineer the ProtonMail API from the open source ProtonMail clients.
The idea of this project is to pool developer resources and maintain a community-edited documentation of the ProtonMail API.
This project is not endorsed or supported by Proton Technologies AG.
The documentation is written in OpenAPI format to allow automatic code generation for client and server applications.
You can find a user-friendly rendering of the documentation using the Swagger UI here.
You can use the online Swagger Editor to edit the documentation and view the changes in real time.
To open a pull request when using the Swagger Editor:
- copy the edited code from Swagger Editor into the clipboard
- find the file
protonmail-api.yamlon github, e.g. by clicking here - click the
Edit this filebutton - paste your edited code from Swagger Editor & create a pull request
This project is looking for contributors and maintainers. Please open an issue if you are interested.