From 86e6cdb9ea9484e0f6165e3b06fd20b5f34e646d Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Tue, 12 Mar 2024 14:31:38 +0000 Subject: [PATCH] Adds API docs --- .github/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/README.md b/.github/README.md index 5ec91b6..171f2aa 100644 --- a/.github/README.md +++ b/.github/README.md @@ -4989,6 +4989,19 @@ but feel free to reach out if you need any help 😊 --- +## The API + +We also have a free, no-auth, CORS-enabled RESR API, which you can use to access +Awesome Privacy's data programmatically, or to build your own apps on top of it. + +To get started, try our [Swagger Explorer](https://awesome-privacy.xyz/api), +which outlines all endpoints, usage and examples. + +You can either use our public instance, at: [`https://api.awesome-privacy.xyz`](https://api.awesome-privacy.xyz) +or self-host your own, with the source of the [`api/`](https://github.com/Lissy93/awesome-privacy/tree/main/api) directory. + +--- + ## Acknowledgements ### Sponsors