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.campaignsNative campaigns API: list, create, delete, transition, claimers, chart, share-access.
of.trackingLinksThin alias of campaigns — /tracking-links doesn’t exist on the native API.
of.trialLinksList, create, delete, toggle, share-access, stats, chart.
of.promotionsSubscriber promos: list, create, delete, finish, claim, invite, offers CRUD, reserve, stats, chart.
of.listsAudience lists: CRUD, list members, add / remove users, plus criteria-based bulk add (addSubscribers, addTopSubscribers, addAwardWinners, addQueueBuyers, addStreamSegment, addStorySegment, addPostSegment, addClaimers, addCampaignClaimers).
of.schedulesScheduled posts and chats counters, laterPosts, laterChats, publish(id).
of.followingFollow / unfollow, follow feed.
of.socialSpotify / Spring / Shopify / OpenSea connections + custom social buttons (link-tree).

​
Recipes

// Build a segment, then target it
const vip = await of.lists.create("VIP fans");
await of.lists.addTopSubscribers(vip.id);

// Trial link
const trial = await of.trialLinks.create({ /* ... */ });

// Publish a scheduled post now
await of.schedules.publish(scheduledPostId);
See Fans & subscribers for list-based targeting and Mass messaging for campaigns.