Introduction

zRuvix is a Go service that exposes your live Discord presence and activities as a REST API and WebSocket gateway, backed by Redis. It is compatible with the Lanyard API shape, so existing Lanyard clients work with minimal changes.

Base URL

All REST endpoints are served from a single base URL. Throughout these docs the examples use:

https://api.zruvix.com

The current release is v1.4.0. A machine-readable version + changelog is available at GET /v1/version.

How it works

The bot must share at least one Discord server with you to "monitor" your presence. Once monitored:

• Reads are public and unauthenticated — anyone can fetch your presence, status card, history, and stats.
• Writes require an API key — setting custom KV data or reading /@me needs your key, which you get by DMing the bot.

Quick example

curl https://api.zruvix.com/v1/users/94490510688792576

{
  "success": true,
  "data": {
    "discord_user": { "id": "...", "username": "..." },
    "discord_status": "online",
    "active_on_discord_desktop": true,
    "listening_to_spotify": true,
    "spotify": { "...": "..." },
    "listening_to_youtube_music": false,
    "youtube_music": null,
    "now_playing": { "...": "..." },
    "activities": ["..."],
    "kv": { "location": "Tokyo" }
  }
}