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.