Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

ResourceWhat it covers
of.postsFeed, search, CRUD, pin / unpin, archive / unarchive, hide, toggleLike, polls (vote, voters), paidAuthors, paidPinned, pinPaid, sortPaidPinned, per-post statistics.
of.posts.commentsComment thread for a post.
of.commentsTop-level comment ops (like / unlike / delete / pin / unpin) regardless of parent type.
of.mediaVault listing, vault lists, retrieve, upload, vaultMediaPosts(mediaId), bulk delete.
of.storiesList, retrieve, delete, like / unlike, mark-watched, blocked-viewer management, top-stories.
of.highlightsStory highlights list / retrieve.
of.streamsLive + scheduled streams, finish, checkActive, viewers, tippers, comments, tip goals, top-streams.
of.bookmarksCategories CRUD, add / remove items, categoriesForPost, listForPost.
of.giphySearch GIFs in the chat composer.
of.labelsList labels (creator-side audience tags).

Recipes

// Home feed
const page = await of.posts.feed({ limit: 10 });

// Like a post (toggle — calling again unlikes)
const r = await of.posts.toggleLike(postId, authorUserId);
console.log(r.isFavorite, r.favoritesCount);

// Bookmarks
const cat = await of.bookmarks.addCategory("favourites");
await of.bookmarks.add(postId, cat.id);
await of.bookmarks.removeAll(postId); // remove from every category
like() and unlike() are aliases of toggleLike(). Many fan-side write actions require an age-verified account — see SDK errors.