> ## 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.

# onlyfanskit

> Build on OnlyFans from TypeScript, REST, the CLI, or an AI agent. Connect an account, read and send messages, pull earnings, and react to events in real time.

<div className="ofk-page">
  <div className="ofk-hero">
    <div className="ofk-hero-copy">
      <h1>onlyfanskit documentation</h1>

      <p className="ofk-hero-sub">
        The production-grade toolkit for building on OnlyFans — designed for
        humans and AI agents alike. Connect an account once, then read and send
        messages, manage content, pull earnings, and react to activity in real
        time.
      </p>

      <div className="ofk-hero-cta">
        <a className="ofk-link-primary" href="/quickstart">Start building →</a>
        <a className="ofk-link-muted" href="/concepts">Core concepts</a>
      </div>
    </div>

    <div className="ofk-hero-art" aria-hidden="true">
      <svg width="168" height="118" viewBox="0 0 168 118" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path d="M84 12 145 42 84 72 23 42 84 12Z" stroke="rgba(255,255,255,.08)" />

        <path d="M23 42v34l61 30 61-30V42" stroke="rgba(255,255,255,.06)" />

        <path d="M84 72v34" stroke="rgba(255,255,255,.06)" />

        <path d="M72 39c-7 0-9 4-9 10v4c0 3-1.6 4.8-4.6 4.8v6.4c3 0 4.6 1.8 4.6 4.8v4c0 6 2 10 9 10" stroke="#AEB2E6" strokeWidth="3" strokeLinecap="round" strokeLinejoin="round" />

        <path d="M96 39c7 0 9 4 9 10v4c0 3 1.6 4.8 4.6 4.8v6.4c-3 0-4.6 1.8-4.6 4.8v4c0 6-2 10-9 10" stroke="#AEB2E6" strokeWidth="3" strokeLinecap="round" strokeLinejoin="round" />

        <path d="M84 46v31" stroke="rgba(174,178,230,.35)" strokeWidth="2" strokeLinecap="round" />
      </svg>
    </div>
  </div>

  <div className="ofk-sec">
    <div className="ofk-sec-head">
      <div>
        <h2>Get started</h2>
        <p>Start building with onlyfanskit.</p>
      </div>
    </div>

    <div className="ofk-grid ofk-grid-3">
      <a className="ofk-pcard" href="/quickstart">
        <div className="ofk-preview">
          <div className="c"># your first call</div>
          <div><span className="k">await</span> of.users.me()</div>
          <div><span className="k">await</span> of.messages.send(id, {`{`} text {`}`})</div>
          <div> </div>

          <div className="dim">
            {`→ live in ~2 minutes`}
          </div>
        </div>

        <div className="ofk-pcard-body">
          <h3>Quickstart</h3>
          <p>Get a working call over REST or the SDK in about two minutes.</p>
        </div>
      </a>

      <a className="ofk-pcard" href="/connect/embed">
        <div className="ofk-preview">
          <div className="c"># link a creator account</div>
          <div>embedded UI · email login</div>
          <div>mobile / QR approval</div>
          <div className="dim">→ account\_id on our infra</div>
        </div>

        <div className="ofk-pcard-body">
          <h3>Connect an account</h3>
          <p>Hosted connect — embed, email login, or mobile approval. No cookies.</p>
        </div>
      </a>

      <a className="ofk-pcard" href="/introduction/coding-agents">
        <div className="ofk-preview ofk-chat">
          <div className="ofk-bubble ofk-bubble-in">scaffold an onlyfanskit bot</div>
          <div className="ofk-bubble ofk-bubble-out">on it — reading the docs 🤖</div>
        </div>

        <div className="ofk-pcard-body">
          <h3>Coding agent support</h3>
          <p>Turn your coding agent into an onlyfanskit expert via llms.txt + MCP.</p>
        </div>
      </a>
    </div>

    <div className="ofk-grid ofk-grid-2 mt-4">
      <a className="ofk-scard" href="/concepts">
        <Icon icon="book-open" />

        <div>
          <h3>Understanding onlyfanskit</h3>
          <p>Concepts, the account model, and how the pieces fit together.</p>
        </div>
      </a>

      <a className="ofk-scard" href="/api-reference/introduction">
        <Icon icon="code" />

        <div>
          <h3>API reference</h3>
          <p>Every endpoint for the hosted REST API, grouped by resource.</p>
        </div>
      </a>
    </div>
  </div>

  <div className="ofk-sec">
    <div className="ofk-sec-head">
      <div>
        <h2>End-to-end platform</h2>
        <p>Tooling and guides for every stage of your integration.</p>
      </div>
    </div>

    <div className="ofk-grid ofk-grid-4">
      <a className="ofk-mini" href="/build/overview">
        <Icon icon="hammer" />

        <h3>Build</h3>
        <p>Connect accounts, then message fans, manage content, and pull earnings.</p>
      </a>

      <a className="ofk-mini" href="/connect/overview">
        <Icon icon="link" />

        <h3>Connect</h3>
        <p>Cookie, cURL, email login, or hosted approval — pick a connect flow.</p>
      </a>

      <a className="ofk-mini" href="/realtime">
        <Icon icon="bolt" />

        <h3>Stream</h3>
        <p>React to messages, subscriptions, and tips over SSE or webhooks.</p>
      </a>

      <a className="ofk-mini" href="/platform/overview">
        <Icon icon="gauge" />

        <h3>Operate</h3>
        <p>Scopes, rate limits, errors, and production checklists.</p>
      </a>
    </div>
  </div>

  <div className="ofk-sec">
    <div className="ofk-sec-head">
      <div>
        <h2>Common use-cases</h2>
        <p>Patterns people ship with onlyfanskit.</p>
      </div>

      <a className="ofk-see-all" href="/build/overview">See all guides</a>
    </div>

    <div className="ofk-grid ofk-grid-4">
      <a className="ofk-mini" href="/guides/messaging">
        <Icon icon="comments" />

        <h3>Chatbots</h3>
        <p>Auto-reply, qualify fans, and send paid messages in chat.</p>
      </a>

      <a className="ofk-mini" href="/guides/mass-messaging">
        <Icon icon="paper-plane" />

        <h3>Mass-message CRM</h3>
        <p>Segment fans into lists and run targeted broadcast campaigns.</p>
      </a>

      <a className="ofk-mini" href="/guides/earnings-and-analytics">
        <Icon icon="chart-line" />

        <h3>Analytics dashboards</h3>
        <p>Sync earnings, transactions, and top-fan data into your own UI.</p>
      </a>

      <a className="ofk-mini" href="/mcp/overview">
        <Icon icon="robot" />

        <h3>Autonomous agents</h3>
        <p>Let an MCP agent run an account end to end in plain language.</p>
      </a>
    </div>
  </div>

  <div className="ofk-sec">
    <div className="ofk-sec-head">
      <div>
        <h2>Surfaces & SDKs</h2>
        <p>One capability set, four ways in. Pick what fits your stack.</p>
      </div>

      <a className="ofk-see-all" href="/introduction/surfaces">Compare surfaces</a>
    </div>

    <div className="ofk-cols">
      <div className="ofk-col">
        <div className="ofk-col-head">Libraries</div>
        <a href="/sdk/overview">TypeScript SDK</a>
        <a href="/sdk/client">Client setup</a>
        <a href="/sdk/errors">Error handling</a>
      </div>

      <div className="ofk-col">
        <div className="ofk-col-head">Hosted</div>
        <a href="/api-reference/introduction">REST API</a>
        <a href="/authentication">Authentication</a>
        <a href="/platform/rate-limiting">Rate limits</a>
      </div>

      <div className="ofk-col">
        <div className="ofk-col-head">AI agents</div>
        <a href="/mcp/overview">MCP server</a>
        <a href="/mcp/install">Install</a>
        <a href="/mcp/tools">Tools</a>
      </div>

      <div className="ofk-col">
        <div className="ofk-col-head">Command line</div>
        <a href="/cli/overview">CLI overview</a>
        <a href="/cli/commands">Commands</a>
        <a href="/realtime/webhooks">Webhooks</a>
      </div>
    </div>
  </div>

  <div className="ofk-divider" />

  <p className="ofk-disclaimer">
    Not affiliated with OnlyFans or Fenix International Limited. onlyfanskit is
    an independent project. You are responsible for complying with OnlyFans'
    terms and applicable law.
  </p>

  <div className="h-12" />
</div>