Release v2

This commit is contained in:
2026-07-16 02:12:29 -03:00
parent 6f98163632
commit 76cbd799ce
47 changed files with 2409 additions and 2810 deletions
+5
View File
@@ -0,0 +1,5 @@
These endpoints return basic information about users in different platforms. Currently,
the only supporter platforms are Discord and GitHub.
Third-party API responses are cached for 10 minutes to work around rate limits and
prevent abuse, so don't be surprised to see slightly-outdated information sometimes.
+33
View File
@@ -0,0 +1,33 @@
Welcome to Nyeki's API! This is a tiny API I built to provide some basic information I
found myself needing in more than one place. This at the moment only includes Discord
profiles, GitHub profiles, and a reverse proxy, but I may add more stuff as I see
myself needing it.
The API is versioned, so API endpoints will always be prefixed with `/v{version}`. The
current version is 2 (i.e. stuff is prefixed by `/v2`). All responses are JSON (or
redirects).
The API is not meant to be used by anyone but me, so I don't guarantee that it will
always be available or that it will always return the same data (nor that it's in any
way reliable in production). You're free to use it if you want, but don't expect any
serious API guarantees.
## Errors
Errors are quite simple and they all follow the same structure:
```ts
{
// The HTTP status code of the error.
\"status\": Number,
// A human-readable message describing the error.
\"message\": String,
}
```
## About
This API is open source and available at https://git.moan.dev/nyeki/nyeki-api to
self-host. Liked it? Found it useful? A donation would be appreciated! You can do so at
https://ko-fi.com/nyeki.
+1
View File
@@ -0,0 +1 @@
A simple API to solve my own needs.