Documentation •⩊• PresenceKit •⩊• Iconical

Api Reference

All documented methods below exist in the published SDK source at himinthevoid/presencekit.

Import paths

Import path	Main exports
`@iconical/presencekit`	`createPresenceClient`, `PresenceKitError`, `DiscordActivityType`, Spotify/activity helpers, `createPresenceConnectionManager`, `getSharedPresenceClient`, types
`@iconical/presencekit/react`	`usePresence`, `usePresences`, `useConnectionDiagnostics`
`@iconical/presencekit/react-ui`	`LivePresenceCard`, `LiveTeamCards`, `PresenceProfileCard`, `SpotifyCard`, `ActivityCard`, `ActivityArtwork`, `ConnectionStatus`
`@iconical/presencekit/vue`	`usePresence`, `usePresences`, `useConnectionDiagnostics`
`@iconical/presencekit/svelte`	`createPresenceStore`, `createPresencesStore`, `createConnectionDiagnosticsStore`

Choose a task

Client methods: getPresence, getPresences
Live subscriptions: subscribePresence, subscribePresences, transport options
Type reference: PresenceResult, PresenceSnapshot, PresenceActivity, SpotifyNowPlaying, errors
Convenience helpers: Spotify, activities, images, elapsed time
Shared connections: watchPresences, getDiagnostics, subscription deduplication
React UI components: ready-made and customizable cards

Complete core example

example.tstypescript

import { createPresenceClient } from "@iconical/presencekit";

const client = createPresenceClient();
const result = await client.getPresence("123456789012345678");
console.log(result.availability, result.presence?.activities);

No consumer-configurable API base URL or authentication key is required. Use the SDK's official built-in API endpoint rather than passing baseUrl options that don't exist. (The official endpoint is https://presence-api.iconical.dev/)

In this section

Client Methods Utility helpers Shared Connections Subscriptions Types

Was this page helpful?

Spotify Client Methods