Overview
Overview
Bring opt-in Discord presence to your website with @iconical/presencekit.
PresenceKit is a typed SDK for user profiles, availability, status, Discord activities, Spotify details, and live updates. It runs in JavaScript/TypeScript and offers dedicated integrations for React, Vue, and Svelte. The API origin is built in—your website does not need Discord login credentials.
To display your Discord presence with PresenceKit, join the Discord server below and use the /confirm command to enable presence sharing. Your status and activities will then appear automatically.
Simply
import { createPresenceClient } from "@iconical/presencekit";
const client = createPresenceClient();
const result = await client.getPresence("123456789012345678");
console.log(result.profile.displayName, result.presence?.status);Replace the example ID with an opted-in Discord user's ID. presence can be null, even if a profile is available.
Start here
Getting started — first request, opt-in, and next steps
Installation — Bun, npm, pnpm, Yarn, or build from source
Quick start — practical copy-and-adapt examples
Sharing and availability — consent, pending, and unavailable states
Learn the API
API reference — complete export map and response concepts
Client methods — single and batch REST requests
Live subscriptions — SSE, polling fallback, cleanup
Types and data shapes — profile, presence, activities, Spotify, errors
Helpers — Spotify, custom status, games, artwork, timers
Shared connections — connection management and diagnostics
Frameworks and UI
Framework overview — choose the right import
Features — Spotify, artwork, ready-made React UI
Help
Package: @iconical/presencekit
Source: himinthevoid/presencekit
API: https://presence-api.iconical.dev
Was this page helpful?