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.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.
Account
A connected OnlyFans creator account. You connect it once — by cookie, login, or a hosted page the creator approves — and from then on reference it by its accountid and act on it without re-supplying credentials.
In the SDK you construct an OnlyFans client directly from a session; the
account model is what the REST API stores and
manages on your behalf.
Connect attempt
A connect attempt is the lifecycle of one login. It startspending, 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.
| State | Meaning |
|---|---|
pending | Login is running in the background. |
awaiting_mobile_session | Waiting for the creator to approve on their device. |
needs_otp | SMS code required. |
needs_app_otp | Authenticator (TOTP) code required. |
needs_email | Email device-verification code required. |
needs_face_otp | Selfie / Face ID required. |
wrong_2fa_code_retry | Last code was wrong; resubmit. |
completed_success | Connected — account_id is set. |
completed_failed | Could not connect. |
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.