Quickstart

Make your first OnlyFans API call in under 2 minutes with the BetterFans Link SDK — the infrastructure behind OFManager. Fetch profiles, list chats, send messages, and listen to real-time events.

This guide walks you through creating a client, fetching your profile, listing recent chats, and sending a message — all with full type safety.

Prerequisites

You have API access and the SDK installed
Your BFL_API_KEY is in your environment
You know the OnlyFans user ID of the account you're operating on

Fetch your profile

Every request targets a specific OnlyFans account. Use .for() to scope the client to an account ID, then call any route:

profile.ts

import { OfApiClient } from "@betterfans/link-sdk"

const client = new OfApiClient({
  apiKey: process.env.BFL_API_KEY,
})

const account = client.for("123456789")

const [error, me] = await account.request("GET /users/me", {})

if (error) {
  console.error(error.code, error.message)
  process.exit(1)
}

console.log(me.name, me.username)
// → "Jane Doe" "janedoe"

The me object is fully typed as UserFull — your editor autocompletes every field.

List recent chats

Pass query parameters to control the results:

chats.ts

const [error, chats] = await account.request("GET /chats", {
  query: { limit: 10, offset: 0, order: "recent", skip_users: "all" },
})

if (!error) {
  for (const chat of chats.list) {
    const user = chat.withUser
    console.log(`${user.name}: ${chat.lastMessage?.text ?? "(media)"}`)
  }
}

Send a message

Write operations use POST, PUT, or DELETE routes. The SDK enforces the correct body shape at compile time:

send-message.ts

import { markdownToHtml } from "@betterfans/link-sdk/utils"

const [error, message] = await account.request(
  "POST /chats/:id/messages",
  {
    pathParams: { id: "98765" },
    body: {
      text: markdownToHtml("Hey! Thanks for subscribing"),
    },
  },
)

if (!error) {
  console.log("Sent:", message.id)
}

Listen for real-time events

Connect to the EventBus to receive events like new messages, tips, and subscriber activity:

events.ts

import { OfWsClient } from "@betterfans/link-sdk"

const ws = new OfWsClient({
  apiKey: process.env.BFL_API_KEY,
  wsToken: process.env.BFL_WS_TOKEN,
  subscribe: ["chat_message", "new_subscriber", "tip"],
})

ws.onEnvelope("chat_message", (ctx) => {
  console.log(`New message from account ${ctx.accountId}`)
})

ws.onEnvelope("new_subscriber", (ctx) => {
  console.log(`New subscriber: ${ctx.payload.fanId}`)
})

ws.connect()

Quickstart

Prerequisites

Fetch your profile

List recent chats

Send a message

Listen for real-time events

Next steps

HTTP Client

Batch requests

WebSocket EventBus

On this page