| Resource | What it covers |
|---|---|
of.users | The most surface-rich resource: me(), retrieve(idOrUsername), lookup(username), search(query), searchPerformers(q), mentionAutocomplete(prefix), profile-visitor analytics, today-activity widget, GDPR / cookie consent, account lifecycle (changePassword, changeEmail, requestDeletion, restoreAccess, appeal), audience moderation (block, unblock, restrict, unrestrict), settings groups, profile links, promo banners, hints / alerts, helper-login flows. |
of.subscriptions | listActive, listExpired, listAll, listRecentExpired, topSubscribers, subscribersChart, subscribersLatest, bundles, plus per-sub mutations (setHidePosts, applyDiscount, setAutoProlong, history) and bundle CRUD. |
of.security | TOTP / trusted-flow OTP, WebAuthn credentials, face-ID postpone. |
of.helpers | List / get / connect / disconnect helper sub-accounts, switch context, mint helper auth and OTP tokens. |
of.sessions | Active sessions and revoke. |
of.referrals | list, balance, payoutRequests. |
of.streaks | Per-fan engagement streak counters. |
Recipes
// Authenticated user
const me = await of.users.me();
// Resolve a creator by username or id
const u1 = await of.users.retrieve("kalanitv");
const u2 = await of.users.retrieve(6734618);
// Active subscribers
const active = await of.subscriptions.listActive({ limit: 50 });
Every method carries JSDoc covering the underlying API path, request shape,
and gotchas — point your editor at the
users / subscriptions resources
for the complete signatures.