Skip to main content
Everything in onlyfanskit revolves around one idea: connect an account once, then act on it. These are the nouns you’ll use across every surface.

Connect

A connect attempt turns a creator’s login into a reusable account.

Act

Call any resource method on that account — over the SDK or REST.

Listen

Receive activity in realtime over SSE, webhooks, or WebSocket.

​
Account

A connected OnlyFans creator account. You connect it once on the hosted API — via embedded connect, email + password, or mobile / QR — and from then on reference it by its account id. onlyfanskit stores the session; you never paste browser cookies. The REST API is how you act on that account. The TypeScript SDK documents the same methods and types.

​
Connect attempt

A connect attempt is the lifecycle of one login. It starts pending, may park on a challenge (a verification code or device approval), and ends completed_success (with an account_id) or completed_failed. You poll an attempt until it resolves. See Two-factor & challenges.

​
Resource & method

The SDK groups the API into resources (users, posts, messages, earnings, …) — 38 in total. Each resource has methods that map 1:1 to API calls. The REST API exposes the same surface at /v1/accounts/{id}/{resource}/{method}.

​
API key, org & scope

Hosted API calls authenticate with a bearer API key. Each key belongs to an org and carries a set of scopes that gate what it can do (accounts:read, sdk:call, webhooks:write, …). See Scopes.

​
Realtime delivery

Account activity — messages, subscriptions, tips, posts — can reach you three ways:
  • Live stream (SSE) — subscribe over HTTP (guide).
  • Webhooks — receive signed HTTP callbacks (guide).
  • WebSocket — connect directly from the SDK (guide).