External APIs

Pawkey uses only two external APIs which are hosted on https://pawkey.dev/api and https://registry-api.pawkey.dev

All of them are maintained by the Pawkey team

What are they used for?

  • Server List

    The opt-in server list on the Servers page

  • Update Checker

    It just checks if your version string matches the latest one on git

What information is being transferred

Update Checker

Requests https://pawkey.dev/api/release/check-update with body:

{
	"running_version": "2026.3.2-02175c4"
}

and responds with:

{
	"update_required": true,
	"running_version": "2026.3.2-02175c4",
	"latest_version": "2026.2.3-83503e1",
	"current_commit_sha": "83503e1",
	"commit_message": "feat: [frontend] properly show attachment number in notifications for reboops\n",
	"commit_title": "feat: [frontend] properly show attachment number in notifications for reboops"
}

Client-side code: PWAUpdateChecker.svelte on Boykissers Git

Server List

Requests https://registry-api.pawkey.dev/instance/register with body:

{
    "name": "Instance Name",
    "url": "Instance URL",
    "icon": "Instance Icon",
    "description": "Instance Description",
    "banner": "Instance Banner",
    "userCount": 30,
    "noteCount": 150
}

Additionally, we use your instance Public Key to authenticate with the registry api to make sure its a real instance.

Client-side registration endpoint code: register.ts on Boykissers Git