API reference

The FansDev API

268 endpoints for your OnlyFans accounts: stats, fans, chats, posts, stories, vault, tracking links, P&L, alerts and exports. OnlyFans' request signing, sessions and proxies are handled for you, and anything else the OnlyFans website can request goes through the raw passthrough.

Getting started

  1. Sign in to app.fansdev.com and connect an OnlyFans account under Connections.
  2. Create an API key on the API page. A key belongs to one workspace and reaches its accounts.
  3. List your accounts, then call any endpoint with the account's id in the path.
curl https://app.fansdev.com/api/accounts \
  -H "Authorization: Bearer $FANSDEV_KEY"

curl https://app.fansdev.com/api/ava/statistics/overview \
  -H "Authorization: Bearer $FANSDEV_KEY"

Base URL: https://app.fansdev.com/api. Account endpoints live under /api/{account}/…, where {account} is the account's id from GET /api/accounts (it never changes; its label can). Workspace endpoints such as /api/traffic or /api/pnl cover every account the key reaches.

Authentication

Send your key as a Bearer token on every request: Authorization: Bearer <key>. Keys are made and revoked on the panel's API page by the workspace owner.

  • Read-only keys answer 403 to anything but GET. Give them to dashboards and reporting tools.
  • Keep keys on your server. Anyone holding a key can act on the workspace's accounts.

Responses and paging

Every answer has the same envelope:

{
  "data": [ … ],
  "_pagination": { "next_page": "https://app.fansdev.com/api/ava/chats?…" },
  "_meta": { "account": "ava", "workspace": "ws_…", "took_ms": 212 }
}
  • Follow _pagination.next_page, a full URL, until it is null. It works the same whatever OnlyFans pages by underneath (an offset, an id or a time).
  • A page can hold fewer items than limit while next_page carries on: OnlyFans leaves deleted accounts out.
  • Fan lists stop at 5,000 fans, the most OnlyFans hands out. The last page then has _pagination.cut_off: true. Counts still count everyone, and spend filters narrow a big list.

Fresh reads

To stay fast and gentle on OnlyFans, some reads are kept briefly: the profile, statistics, payouts, transactions and counts for up to 60 seconds; fan lists, new fans, posts, the queue, stories, the vault and single users for up to 30 seconds. Chats and messages are read live.

  • A kept answer says so: _meta.cached: true and _meta.age_ms.
  • Send Cache-Control: no-cache to read fresh.
  • Any write to an account clears what was kept for it.

Writes and scheduling

  • Writes are off for every account until you turn them on in the panel (Connections → Writes). Until then, anything that would change the account answers 403.
  • Request bodies use OnlyFans' own field names, so you can copy a request from the OnlyFans website's developer tools and send the same body.
  • To schedule a post, a mass message or a chat message, add "scheduledDate": "2026-12-01T18:00:00Z". It goes into OnlyFans' own queue. A date less than a minute ahead is refused rather than published now.
  • Stories can be scheduled too, with POST /api/{account}/stories/scheduled, which OnlyFans itself can't do.
  • Add ?check_words=block to a send to refuse it, with a 422, when it contains words OnlyFans blocks.
  • Withdrawals, bank details, passwords and 2FA can't be reached through the API, including the raw passthrough.

Errors

Errors come with an HTTP status and a short message:

{ "error": { "status": 403, "message": "…" } }
400Something in the request is missing or wrong, or OnlyFans refused it. OnlyFans' own answer is included as error.onlyfans.
401The key is missing or wrong, or the account's OnlyFans session has ended: reconnect it in the panel.
403Not allowed: a read-only key, writes off for the account, or a blocked path.
404No such account, route or item.
422A send was refused for words OnlyFans blocks (check_words=block).
429Too many requests. Wait and try again.
502OnlyFans didn't answer properly. Try again shortly.

Uploading media

  • Small files: POST /api/{account}/media?name=photo.jpg with the raw bytes and the right Content-Type returns a mediaFile to put in a post or message (up to about 200 MB).
  • Big files, in parts: start with POST /api/{account}/media/uploads and { "filename", "size", "contentType" }, PUT each part (4 MB by default, any order), then call completeUrl. Up to 1 GB.
  • From a link: send { "url": "…" } instead, for example a Google Drive file shared as "Anyone with the link".
  • Put the upload id ("upl_…") straight into mediaFiles of a post, message or story; it is swapped for the finished file.

Media links

OnlyFans' own media links only open from the address that fetched them, so every answer swaps them for FansDev links: https://app.fansdev.com/media/<token>/…. They open anywhere with no key, in an <img> or <video> tag or from your server, for as long as OnlyFans' link would (about a day). They support Range, so video can seek.

Webhooks

Webhooks send a signed POST to your URL when something happens on your accounts. Each destination gets every event or only the ones you pick, in order, retried up to 3 times. The last 300 deliveries are kept, and any of them can be sent again.

{ "id": "evt_…", "type": "transaction.new", "created": "2026-11-18T10:00:00Z",
  "workspace": "ws_…", "account": "ava", "data": { … } }

Check the signature with your destination's secret before trusting a delivery:

const expected = 'sha256=' + crypto.createHmac('sha256', SECRET).update(rawBody).digest('hex');
if (expected !== req.headers['x-webhook-signature']) return reject();

Other headers: x-webhook-event (the type), x-event-id (the same on a resend, to drop duplicates) and x-webhook-delivery.

subscription.newA fan subscribed: new, returning or free trial (data.kind says which)
subscription.renewedA subscription renewed: a recurring payment came in
transaction.newAny payment came in: subscription, tip, message, post or stream (data.transaction)
tip.receivedA fan tipped
ppv.unlockedA fan bought a paid (PPV) message
post.purchasedA fan bought a paid post
message.receivedA fan sent a message (with Live on: the moment it arrives, data.message)
fan.onlineA big spender came online (Live on; data.fan, data.spent)
link.subscriberA new fan came through a tracking or free trial link (data.link, data.fan)
interactionA like, favorite or comment
notificationAny other OnlyFans notification
story.publishedA scheduled story went up
story.failedA scheduled story couldn't be posted
session.deadAn account's OnlyFans session stopped working
session.restoredAn account's session works again
signing.brokenOnlyFans changed its request signing; API calls fail until it's fixed
signing.recoveredRequest signing works again

AI assistants (MCP)

https://app.fansdev.com/mcp is an MCP server over this API, so Claude Code, Claude Desktop or Cursor can read and work your accounts in plain English. It takes the same key and follows the same rules: read-only keys get only the tools that read, and sends need writes on. Tools that change something are marked, so assistants ask first.

claude mcp add --transport http fansdev https://app.fansdev.com/mcp \
  --header "Authorization: Bearer $FANSDEV_KEY"

For Cursor and other tools that take a URL:

{ "mcpServers": { "fansdev": { "url": "https://app.fansdev.com/mcp",
  "headers": { "Authorization": "Bearer <key>" } } } }

Tools: list_accounts, get_earnings, get_statistics, list_transactions, list_chats, get_messages, list_fans, get_fan, top_fans, get_traffic, get_profit_and_loss, list_mass_messages, list_scheduled, check_words, search_endpoints and api_get; plus send_message, update_fan and api_write, which change things.

Session status

GET /api/accounts says, instantly and without calling OnlyFans, whether each account's session works: status is ok, expired (reconnect it in the panel), error (the last check failed for another reason) or unknown. Poll it, or listen for the session.dead and session.restored webhooks.

Endpoints

Account 17

Profile, settings, notes, welcome message

GET/api/{account}/meGet profile

Your own OnlyFans profile and account details (name, bio, counts, avatar).

PATCH/api/{account}/meUpdate profile

Update your own profile — display name, bio, and similar fields.

GET/api/{account}/settingsGet settings

Your account settings.

GET/api/{account}/settings/chatGet chat settings

Your messaging / chat settings.

PATCH/api/{account}/settings/chatUpdate chat settings

Change your messaging / chat settings.

PATCH/api/{account}/settings/messagesUpdate message settings

Change your messaging settings (e.g. welcome-message behaviour).

GET/api/{account}/settings/postsGet post settings

Your default post settings.

PATCH/api/{account}/settings/postsUpdate post settings

Change your default post settings.

GET/api/{account}/settings/social-buttonsList social buttons

The social-media links shown on your profile.

POST/api/{account}/settings/social-buttonsAdd a social button

Add a social-media link button to your profile.

PUT/api/{account}/settings/social-buttons/{button_id}Update a social button

Edit one of your profile’s social-media link buttons.

DELETE/api/{account}/settings/social-buttons/{button_id}Remove a social button

Remove a social-media link button from your profile.

GET/api/{account}/notesGet scheduling notes

Notes for whoever schedules this account: what to post and when, what to avoid. With who edited them last, and when.

PUT/api/{account}/notesSave scheduling notes

Save the notes: { "text": "…" } (up to 5,000 characters; an empty string clears them).

POST/api/{account}/welcome-messageSet the welcome message

Set the automatic welcome message new subscribers receive.

GET/api/{account}/model-start-dateGet the creator start date

The date this account started as a creator on OnlyFans.

GET/api/{account}/today-activityGet today’s activity

Today’s activity summary so far — new subs, messages, earnings.

Statistics 11

Overview, profile visits, subscribers, top fans, posts and stories, message stats

GET/api/{account}/statistics/overviewGet the stats overview

Headline stats for a date range — earnings, views, and change vs. the previous period.

GET/api/{account}/statistics/profile-visitsGet profile visits

Profile visitors per day (chart data). Add ?by=guests (visitors not signed in) or ?by=users (signed-in OnlyFans users); ?by=all returns total, guests and users side by side. Guests + users = total.

GET/api/{account}/statistics/subscriber-countGet the subscriber count

Your current subscriber count.

GET/api/{account}/statistics/subscribersGet the new subscribers chart

New-subscriber chart over a date range.

GET/api/{account}/statistics/top-fansGet top fans for a period

Your highest-spending fans for a date range.

GET/api/{account}/statistics/top-postsGet top posts

Your best-performing posts for a date range.

GET/api/{account}/statistics/top-storiesGet top stories

Your best-performing stories for a date range.

GET/api/{account}/engagement/direct-messagesGet direct message stats

Direct messages you sent, newest first, with OnlyFans’ statistics (price, how many bought or viewed). start_date / end_date (last 30 days by default), ?limit= up to 100 (default 10); next_page goes further back.

GET/api/{account}/engagement/mass-messagesGet mass message stats

Mass messages sent, newest first: text, price, how many it went to (sentCount) and how many viewed it (viewedCount). start_date / end_date (last 30 days by default); next_page goes further back.

GET/api/{account}/engagement/mass-messages-chartGet the mass messages chart

A performance chart for your mass messages.

GET/api/{account}/engagement/top-messageGet the top message

Your single top-earning message for a date range.

Earnings 10

Transactions, balances, payouts, chargebacks

GET/api/{account}/transactionsList transactions

Individual earning transactions, newest first. ?limit= up to 100 (default 10); start_date (default 30 days ago) is how far back to go, end_date (a day, taking in all of it, or a date-time) where to start; next_page goes further back.

GET/api/{account}/transactions.csvDownload transactions (CSV)

Every transaction in a date range as a spreadsheet (CSV): ?start_date=2026-11-01&end_date=2026-11-30 (UTC days, both included; the last 30 days by default). Date, type, fan, gross, fee, net, status — oldest first. /api/transactions.csv (no account) gives every account in one file, with an Account column.

GET/api/{account}/payouts/balancesGet balances

Your current available and pending balance.

GET/api/{account}/payouts/chargeback-ratioGet the chargeback ratio

Your chargeback ratio over a date range.

GET/api/{account}/payouts/earning-statisticsGet earnings by day

Earnings per day, broken down by source (subs, tips, posts, messages, streams), gross and net.

GET/api/{account}/payouts/eligibilityGet payout eligibility

Whether you’re currently eligible to receive a payout.

GET/api/{account}/payouts/referral-balanceGet the referral balance

Your referral-program earnings balance.

GET/api/{account}/payouts/requestsList payout requests

Your past payout / withdrawal requests (read-only — withdrawals aren’t automated).

GET/api/{account}/payouts/statsGet payout stats

Payout statistics over a date range.

GET/api/{account}/chargebacksList chargebacks

Chargeback records over a date range.

Chats 29

Chats, messages, mass messages, saved messages

GET/api/{account}/chatsList chats

Conversations, most recent first, each with the fan’s profile attached. limit up to 50.

GET/api/{account}/chats/{chat_id}Get a chat

One conversation’s details.

DELETE/api/{account}/chats/{chat_id}Delete a chat

Delete a whole conversation.

POST/api/{account}/chats/{chat_id}/hideHide a chat

Hide (archive) a conversation from your inbox.

PUT/api/{account}/chats/{chat_id}/ignoreIgnore a chat

Ignore a chat. Optional { "name", "username" }, up to 200 characters each. Sent again: updates those, keeps at and by.

DELETE/api/{account}/chats/{chat_id}/ignoreStop ignoring a chat

Stop ignoring a chat.

POST/api/{account}/chats/{chat_id}/mark-readMark a chat as read

Mark a conversation as read.

POST/api/{account}/chats/{chat_id}/mark-unreadMark a chat as unread

Mark a conversation as unread.

GET/api/{account}/chats/{chat_id}/media/{type}List a chat’s media

Media shared in a conversation, filtered by type (photos / videos), newest first. ?limit= is how many of the chat’s messages to look through (up to 100), so a page can hold fewer; next_page goes further back.

GET/api/{account}/chats/{chat_id}/messagesList messages

The messages inside one conversation. With order=desc they come newest first, 10 at a time; next_page (?id= the oldest you have) goes further back.

POST/api/{account}/chats/{chat_id}/messagesSend a message

Send a direct message in a conversation. Can be free, priced (pay-to-unlock), or carry media.

POST/api/{account}/chats/{chat_id}/muteMute a chat

Mute a conversation.

DELETE/api/{account}/chats/{chat_id}/muteUnmute a chat

Unmute a conversation.

GET/api/{account}/chats/ignoredList ignored chats

Ignored chats, newest first: { id, name, username, at, by }. id is the fan’s user id. In GET /chats each chat has ignored: true or false.

POST/api/{account}/chats/mark-all-readMark all chats as read

Mark every conversation as read.

DELETE/api/{account}/messages/{message_id}Delete a message

Delete a single message you sent.

PUT/api/{account}/messages/{message_id}/hideHide a message

Hide a single message.

POST/api/{account}/messages/{message_id}/likeLike a message

Like a message.

DELETE/api/{account}/messages/{message_id}/likeUnlike a message

Remove your like from a message.

POST/api/{account}/messages/{message_id}/pinPin a message

Pin a message to the top of the chat.

DELETE/api/{account}/messages/{message_id}/pinUnpin a message

Unpin a pinned message.

GET/api/{account}/mass-messagingList mass messages

Your mass messages (queued and sent) over a date range.

POST/api/{account}/mass-messagingSend a mass message

Send one message to many fans at once (optionally to a list, priced, with media). Set "scheduledDate" to schedule it.

GET/api/{account}/mass-messaging/{message_id}Get a mass message

One mass message’s details.

PUT/api/{account}/mass-messaging/{message_id}Update a mass message

Edit a queued (not-yet-sent) mass message.

DELETE/api/{account}/mass-messaging/{message_id}Delete a mass message

Cancel / delete a queued mass message.

GET/api/{account}/mass-messaging/{message_id}/buyersList a mass message’s buyers

Fans who bought / unlocked a given mass message.

GET/api/{account}/saved-for-later/messagesList saved messages

Draft messages you saved for later, limit at a time (10 by default, up to 100); next_page goes on.

Fans 20

Active, expired and new fans, counts, spending, notes

PUT/api/{account}/fans/{user_id}/custom-nameSet a fan’s custom name

Give a fan a name only you see, on OnlyFans: { "name": "…" } (up to 100 characters; empty goes back to their own name). Needs Writes on.

DELETE/api/{account}/fans/{user_id}/custom-nameRemove a fan’s custom name

Take a fan’s custom name off, back to their own name. Needs Writes on.

PUT/api/{account}/fans/{user_id}/discountGive a fan a discount

Offer a specific fan a subscription discount.

GET/api/{account}/fans/{user_id}/notesGet a fan’s notes

A fan’s notes and the custom name you gave them, OnlyFans’ own (only you see them): { id, notes, custom_name, name }.

PUT/api/{account}/fans/{user_id}/notesSave a fan’s notes

Save a fan’s notes on OnlyFans: { "notes": "…" } (up to 200 characters; line breaks kept). Needs Writes on. Shows in OnlyFans too.

DELETE/api/{account}/fans/{user_id}/notesClear a fan’s notes

Clear a fan’s notes on OnlyFans. Needs Writes on.

GET/api/{account}/fans/{user_id}/subscription-historyGet a fan’s subscription history

One fan’s full subscription history with you.

GET/api/{account}/fans/activeList active fans

Your current (active) subscribers, each with what they’ve spent in subscribedOnData. Filter with total_spent=100 or tips=50 (at least that many dollars), total_spent_under=500 or tips_under=50 (under that many), online=true, or query= (the start of a username). Up to 5,000 fans: OnlyFans hands out no more, and the page that reaches them has _pagination.cut_off: true (/fans/active/count counts them all).

GET/api/{account}/fans/active/countCount active fans

How many active fans match the filters (total_spent, tips, their _under ends, online, query): { count }.

GET/api/{account}/fans/allList all fans

Every fan, active or expired, with what they’ve spent. Same filters as /fans/active. Up to 5,000 fans, like /fans/active (_pagination.cut_off).

GET/api/{account}/fans/all/countCount all fans

How many fans in all match the filters (total_spent, tips, their _under ends, query): { count }.

GET/api/{account}/fans/countGet fan counts

Fan counts: "subscribers" holds your fans (active, expired, all, restricted, blocked); "subscriptions" counts the accounts you follow.

GET/api/{account}/fans/expiredList expired fans

Fans whose subscription has lapsed, with what they spent. Same filters as /fans/active: total_spent=100 finds the former big spenders worth winning back. Up to 5,000 fans, like /fans/active (_pagination.cut_off).

GET/api/{account}/fans/expired/countCount expired fans

How many expired fans match the filters (total_spent, tips, their _under ends, query): { count }.

GET/api/{account}/fans/latestList latest fans

Recent subscribers as OnlyFans picks them: it ignores dates, and each page comes in user-id order, not by time. For subscriptions in order with their times (and a period), use GET /fans/new.

GET/api/{account}/fans/newList new subscriptions

Your subscriptions, newest first: new, returning and free-trial fans, each with the fan’s profile, when they subscribed (at), the kind and the price (null when free). ?limit= up to 100 (default 10); next_page goes further back, as far as OnlyFans keeps them. start_date / end_date (a day, YYYY-MM-DD, taking in all of it, or a date-time) keep to that period, e.g. ?start_date=2026-11-14&end_date=2026-11-14 for one UTC day; follow next_page until it’s null to get all of it. Reading them doesn’t mark OnlyFans’ notifications read.

GET/api/{account}/fans/recent-expiredList recently expired fans

Fans whose subscription expired recently.

GET/api/{account}/fans/spendingGet fans’ spending

What fans have spent, by user id: ?ids=123,456 (up to 50) → { "123": { total, subscriptions, tips, messages, posts, streams } }; null: never subscribed. Read from each fan’s profile and kept 15 minutes. A fan that couldn’t be read is left out.

GET/api/{account}/fans/topList top fans

Top fans ranked by total spend (over a date range). ?limit=, &offset=; next_page carries on until a page comes back empty.

GET/api/{account}/fans.csvDownload fans (CSV)

Fans as a spreadsheet (CSV): ?type=active|expired|all plus the fan list’s filters (total_spent, tips, total_spent_under, tips_under, query). Spending, subscription dates, custom name and notes. Up to 1,000 fans (header x-capped: 1 when there were more; narrow it with the filters). /api/fans.csv for every account.

Lists 12

Fan lists and the users in them

GET/api/{account}/user-listsList fan lists

Your fan lists (custom groups of users).

POST/api/{account}/user-listsCreate a fan list

Create a new fan list.

GET/api/{account}/user-lists/{list_id}Get a fan list

One fan list.

PATCH/api/{account}/user-lists/{list_id}Rename a fan list

Rename a fan list.

DELETE/api/{account}/user-lists/{list_id}Delete a fan list

Delete a fan list.

GET/api/{account}/user-lists/{list_id}/pinnedList a list’s pinned users

The pinned users in a fan list.

GET/api/{account}/user-lists/{list_id}/usersList a list’s users

The users inside a fan list.

DELETE/api/{account}/user-lists/{list_id}/usersRemove users from a list

Remove several users from a list at once.

POST/api/{account}/user-lists/{list_id}/users/{user_id}Add a user to a list

Add one user to a list.

DELETE/api/{account}/user-lists/{list_id}/users/{user_id}Remove a user from a list

Remove one user from a list.

POST/api/{account}/user-lists/{list_id}/users/{user_id}/pinPin a user in a list

Pin a user to the top of a list.

POST/api/{account}/user-lists/usersAdd users to lists

Add users to lists in bulk.

Users 13

Profiles, search, blocked and restricted users, following

POST/api/{account}/users/{user_id}/blockBlock a user

Block a user.

DELETE/api/{account}/users/{user_id}/blockUnblock a user

Unblock a user.

POST/api/{account}/users/{user_id}/restrictRestrict a user

Restrict a user (they stay subscribed but can’t interact).

DELETE/api/{account}/users/{user_id}/restrictUnrestrict a user

Remove a restriction from a user.

GET/api/{account}/users/{user}Get a user

A user’s profile, by id or username. For one of your fans it includes subscribedOnData: what they’ve spent (total, tips, messages, posts, subscriptions), when they subscribed and when it ends.

GET/api/{account}/users/{user}/highlightsList a user’s highlights

A user’s story highlights.

GET/api/{account}/users/{user}/postsList a user’s posts

A user’s posts (by their numeric id). ?limit= up to 100 (read 50 at a time), &offset=.

GET/api/{account}/users/{user}/social-buttonsList a user’s social buttons

A user’s linked social buttons.

GET/api/{account}/users/blockedList blocked users

Users you have blocked.

GET/api/{account}/users/restrictedList restricted users

Users you have restricted.

GET/api/{account}/followingList followed creators

Creators you follow / subscribe to.

GET/api/{account}/following/countCount followed creators

How many creators you follow.

Posts 29

Posts, queue, saved posts, labels, comments

GET/api/{account}/postsList posts

Your feed posts, newest first (?order=publish_date_asc for oldest first). ?limit= up to 100 (read 50 at a time), &offset=.

POST/api/{account}/postsCreate a post

Create a post. Publishes now, or set "scheduledDate" (ISO, e.g. 2026-12-01T18:00:00Z) to schedule it in OnlyFans’ own queue. Attach media with mediaFiles from POST /media, or the id of an upload from POST /media/uploads.

GET/api/{account}/posts/{post_id}Get a post

One post.

PUT/api/{account}/posts/{post_id}Update a post

Edit an existing post.

DELETE/api/{account}/posts/{post_id}Delete a post

Delete a post. For a scheduled post this takes it out of the queue (use the post’s id: entity.id in GET /queue). Its media are no longer marked as used.

POST/api/{account}/posts/{post_id}/archiveArchive a post

Move a post to your archive.

GET/api/{account}/posts/{post_id}/buyersList a post’s buyers

Fans who bought a paid post.

GET/api/{account}/posts/{post_id}/commentsList a post’s comments

Comments on a post.

POST/api/{account}/posts/{post_id}/commentsComment on a post

Add a comment to a post.

POST/api/{account}/posts/{post_id}/pinPin a post

Pin a post to the top of your profile.

GET/api/{account}/posts/{post_id}/statsGet a post’s stats

A post’s performance stats, with a chart.

GET/api/{account}/posts/{post_id}/tipsList a post’s tips

Tips received on a post.

POST/api/{account}/posts/{post_id}/unarchiveUnarchive a post

Bring a post back from the archive.

GET/api/{account}/posts/archivedList archived posts

Your archived posts (hidden from fans), newest first; ?order=publish_date_asc for oldest first.

GET/api/{account}/queueList scheduled items

Scheduled posts, messages and streams waiting to go out, in OnlyFans’ own queue. ?start_date= and ?end_date= (YYYY-MM-DD; default the next 90 days), ?timezone= (e.g. Europe/Lisbon; default UTC), ?type=post (or chat, stream; comma-separated). Each item is { id, type, publishDateTime, entity: the post or message }.

PUT/api/{account}/queue/{item_id}/publishPublish a scheduled item now

Publish a scheduled item right now instead of waiting. Use the queue item’s own id from GET /queue (not the post id).

GET/api/{account}/queue/countCount scheduled items by day

How many items are scheduled on each day: ?start_date=, ?end_date= (at most 6 weeks), ?timezone=, ?type=. Returns { days: { "2026-12-01": { post, chat, stream } }, totals }.

GET/api/{account}/saved-for-later/postsList saved posts

Draft posts you saved for later, limit at a time (10 by default, up to 100); next_page goes on.

GET/api/{account}/post-labelsList post labels

Your post labels (tags for organising posts).

POST/api/{account}/post-labelsCreate a post label

Create a post label.

PATCH/api/{account}/post-labels/{label_id}Rename a post label

Rename a post label.

DELETE/api/{account}/post-labels/{label_id}Delete a post label

Delete a post label.

POST/api/{account}/post-labels/{label_id}/postsAdd posts to a label

Add posts to a label.

DELETE/api/{account}/post-labels/{label_id}/posts/{post_id}Remove a post from a label

Remove a post from a label.

DELETE/api/{account}/comments/{comment_id}Delete a comment

Delete a comment.

POST/api/{account}/comments/{comment_id}/likeLike a comment

Like a comment.

DELETE/api/{account}/comments/{comment_id}/likeUnlike a comment

Remove your like from a comment.

POST/api/{account}/comments/{comment_id}/pinPin a comment

Pin a comment.

DELETE/api/{account}/comments/{comment_id}/pinUnpin a comment

Unpin a comment.

Stories 16

Stories, scheduled stories, highlights

GET/api/{account}/storiesList stories

Your current (live) stories.

POST/api/{account}/storiesPost a story

Post a story now: { "mediaFiles": [ <mediaFile from POST /media> or a vault media id ] }. Add "scheduledDate" to post it later instead.

GET/api/{account}/stories/{story_id}Get a story

One story.

DELETE/api/{account}/stories/{story_id}Delete a story

Delete a story.

GET/api/{account}/stories/{story_id}/statsGet a story’s stats

A story’s stats.

GET/api/{account}/stories/{story_id}/viewersList a story’s viewers

Who viewed a story.

GET/api/{account}/stories/archiveList archived stories

Your archived (expired) stories, newest first. ?limit= up to 100; next_page goes further back.

GET/api/{account}/stories/scheduledList scheduled stories

Scheduled stories, with their status: pending, published or failed.

POST/api/{account}/stories/scheduledSchedule a story

Schedule a story. Send the image/video bytes with Content-Type and ?scheduled_date=…&name=…, or JSON { "scheduledDate": …, "mediaFiles": [a vault media id, or an upload id from POST /media/uploads] }.

DELETE/api/{account}/stories/scheduled/{id}Cancel a scheduled story

Cancel a scheduled story (or clear a finished one from the list).

POST/api/{account}/story-highlightsCreate a highlight

Create a story highlight.

GET/api/{account}/story-highlights/{highlight_id}Get a highlight

One story highlight.

PUT/api/{account}/story-highlights/{highlight_id}Set a highlight’s stories

Replace the stories inside a highlight.

PATCH/api/{account}/story-highlights/{highlight_id}Rename a highlight

Rename or update a highlight.

DELETE/api/{account}/story-highlights/{highlight_id}Delete a highlight

Delete a highlight.

DELETE/api/{account}/story-highlights/{highlight_id}/{story_id}Remove a story from a highlight

Remove one story from a highlight.

Vault & uploads 25

Vault media and lists, uploads, Drive folders, used media

GET/api/{account}/vault/listsList vault lists

Your vault folders / lists.

POST/api/{account}/vault/listsCreate a vault list

Create a vault folder / list.

GET/api/{account}/vault/lists/{list_id}Get a vault list

One vault folder / list.

PATCH/api/{account}/vault/lists/{list_id}Rename a vault list

Rename a vault folder / list.

DELETE/api/{account}/vault/lists/{list_id}Delete a vault list

Delete a vault folder / list.

POST/api/{account}/vault/lists/{list_id}/mediaAdd media to a vault list

Add media to a vault folder / list.

DELETE/api/{account}/vault/lists/{list_id}/mediaRemove media from a vault list

Remove media from a vault folder / list.

GET/api/{account}/vault/mediaList vault media

Media files in your vault (everything you’ve uploaded).

GET/api/{account}/vault/media-typesList vault media types

The media types available in your vault.

GET/api/{account}/vault/media/{media_id}Get a vault media file

One vault media file’s details.

GET/api/{account}/vault/media/{media_id}/buyersList a media file’s buyers

Fans who bought content that used this media.

PUT/api/{account}/vault/media/hiddenHide or unhide vault media

Hide or unhide vault media.

POST/api/{account}/mediaUpload a file

Upload a photo or video: POST the raw file bytes with the right Content-Type and ?name=. Returns a mediaFile object you drop into a post or message so the content is attached. For big files (or from a host that limits request size, like Vercel), use POST /media/uploads.

GET/api/{account}/media/uploadsList uploads

Your recent big uploads, with their status. Finished ones are listed for a day.

POST/api/{account}/media/uploadsStart an upload

Start a big upload. In parts: send { "filename", "size", "contentType" } and the reply lists the parts to PUT (4 MB each by default), then call completeUrl. From a link: send { "url": "…" } (Google Drive share links work). Either way it ends with a mediaFile.

GET/api/{account}/media/uploads/{upload_id}Get an upload

One upload’s progress: uploading → processing → ready (with its mediaFile) or failed (with the reason). While parts are missing it lists them, so an interrupted upload can carry on.

DELETE/api/{account}/media/uploads/{upload_id}Cancel an upload

Cancel an unfinished upload, or clear a finished one.

POST/api/{account}/media/uploads/{upload_id}/completeComplete an upload

Finish an upload once every part is in. Processing continues in the background: check the upload until it’s ready, or put its id straight into mediaFiles.

PUT/api/{account}/media/uploads/{upload_id}/parts/{part_number}Send an upload part

Send one part of the file: the raw bytes of that part’s byteRange. Parts can go in any order, and a failed part can simply be sent again.

GET/api/{account}/foldersList Drive folders

The Google Drive folders linked to this account, where its content lives.

POST/api/{account}/foldersLink a Drive folder

Link a Google Drive folder: { "url": "<the folder’s link>", "name": optional }. The folder must be shared as “Anyone with the link” (Viewer).

DELETE/api/{account}/folders/{folder_id}Unlink a Drive folder

Unlink a Drive folder. Nothing in Drive changes.

GET/api/{account}/folders/{folder_id}/filesList a folder’s files

A linked folder’s files and subfolders (?folder=<subfolder id> opens one). Each file says if it was already used in a post or story ("used"). To post one, send its Drive link to POST /media/uploads and put the upload id in mediaFiles.

GET/api/{account}/usedList used media

Media already used in a post or story: { "vault:<id>" or "drive:<file id>": { at, kind, ref, when } }. Deleting the post or cancelling the story frees them.

DELETE/api/{account}/usedMark media as unused

Mark one as unused again: ?key=vault:<media id> or drive:<file id>.

Tracking 21

Traffic, tracking links, free trial links

GET/api/{account}/trafficGet traffic by platform

New subscribers, clicks and revenue for every tracking and free trial link, by platform, for a period (?days=7, up to 365) next to the period before it. The period ends today, or on ?date=YYYY-MM-DD (UTC; ?days=1&date= is that one day). Per-link numbers start at the account’s recorded_since; revenue covers each link’s fans’ whole history (free trial links from revenue.trials_since). totals.all = every new subscriber (OnlyFans’ count: new, returning and free trial) as tracked (through links) and untracked, from the first whole recorded day (all.since); each day adds all and untracked. totals.revenue.all = every transaction of the account (net) and untracked = what fans who came through no link brought in this period, by type. Platforms carry lifetime (all-time subscribers and clicks of their links). &split=0 leaves out the tracked vs untracked subscribers (one OnlyFans read less).

GET/api/{account}/traffic.csvDownload traffic (CSV)

Every tracking and free trial link as a spreadsheet (CSV): platform, link, new subscribers, clicks and revenue for ?days= (default 7) and all-time, spenders, revenue per subscriber. /api/traffic.csv for every account.

POST/api/{account}/tracking-linksCreate a tracking link

Create a tracking link: { "name": "Reddit - u/yourname" } (up to 100 characters). Add "platform" (a platform id or name, e.g. "Reddit") to file it under that platform.

POST/api/{account}/free-trial-linksCreate a free trial link

Create a free-trial link: { "trialLinkName" (up to 64 characters, optional), "subscribeDays" (trial length: 1, 3, 7, 14, 30, 90, 180 or 360), "subscribeCounts" (how many fans can claim it: 0 for no limit, 1-10, 50 or 100), "expireDays" (link expires in 1-30 days, 0 for never) }. Add "platform" to file it under a platform.

Promotions 8

Promotions, subscription bundles

GET/api/{account}/promotionsList promotions

Your subscription promotions / discount campaigns.

POST/api/{account}/promotionsCreate a promotion

Create a promotion (a subscription discount campaign).

DELETE/api/{account}/promotions/{promotion_id}Delete a promotion

Delete a promotion.

POST/api/{account}/promotions/{promotion_id}/stopStop a promotion

Stop / finish a running promotion.

GET/api/{account}/subscription-bundlesList bundles

Your subscription bundle offers (e.g. 3 months at a discount).

POST/api/{account}/subscription-bundlesCreate a bundle

Create a subscription bundle offer.

PUT/api/{account}/subscription-bundles/{bundle_id}Update a bundle

Edit a subscription bundle.

DELETE/api/{account}/subscription-bundles/{bundle_id}Delete a bundle

Delete a subscription bundle.

Notifications 6

Notifications, unread counts

GET/api/{account}/notificationsList notifications

Your OnlyFans notifications feed, newest first (?type=subscribed, tip, … for one kind). ?limit= up to 100 (default 10); next_page goes further back.

POST/api/{account}/notifications/{notification_id}/readMark a notification as read

Mark one notification as read.

GET/api/{account}/notifications/countsCount unread notifications

Unread notification counts.

POST/api/{account}/notifications/mark-all-readMark all notifications as read

Mark all notifications as read.

GET/api/{account}/notifications/tabs-orderGet the tabs order

Your saved order for the notification tabs.

POST/api/{account}/notifications/tabs-orderSave the tabs order

Save the order of your notification tabs.

Release forms 6

Release forms, invitation links, mentions

GET/api/{account}/release-formsList release forms

Your release forms (co-creator consent documents).

POST/api/{account}/release-forms/attachAttach a release form

Attach a release form to content.

POST/api/{account}/release-forms/invitation-linkCreate an invitation link

Create a release-form invitation link for a co-creator.

GET/api/{account}/release-forms/mentionsList release form mentions

Release-form mentions.

PATCH/api/{account}/release-forms/renameRename a release form

Rename a release form.

PATCH/api/{account}/release-forms/toggle-showShow or hide a release form

Toggle whether a release form is shown.

P&L 3

Profit and loss, costs, commission

GET/api/pnlGet P&L settings

Profit and loss per account and month: net revenue (from the transactions) and chat sales (messages and tips), commission, costs (percentages, every month, one-off) and profit; cut_costs: what each of the account’s cuts takes that month, in their order. ?from=2026-01&to=2026-11 (default the last 12 months), ?account= for one. Accounts whose transactions aren’t read yet: ready false. On one account (/api/{account}/pnl): its P&L settings, the fields PUT /pnl takes.

GET/api/{account}/pnlGet P&L settings

Profit and loss per account and month: net revenue (from the transactions) and chat sales (messages and tips), commission, costs (percentages, every month, one-off) and profit; cut_costs: what each of the account’s cuts takes that month, in their order. ?from=2026-01&to=2026-11 (default the last 12 months), ?account= for one. Accounts whose transactions aren’t read yet: ready false. On one account (/api/{account}/pnl): its P&L settings, the fields PUT /pnl takes.

PUT/api/{account}/pnlUpdate P&L settings

An account’s P&L settings: { "commission" (%), "cuts": [{ "label", "percent", "of": "revenue" or "chat_sales", "from"?, "to"?, "skip"? }], "monthly": [{ "label", "amount", "from"?, "to"?, "skip"? }], "costs": [{ "month": "2026-11", "label", "amount" }] }. A cut takes its percent of the month’s net revenue or chat sales (messages and tips). A cut or monthly cost counts from "from" to "to" (months, both optional), except the months in "skip" (a list). An expense on several accounts: a copy on each with the same "group"; "split": true on a monthly or one-off cost whose amount is its account’s share of an amount split between them. Workspace owners (and API keys).

Alerts 28

Rules, reports, chats, log, checks, bumps

GET/api/alertsGet alerts setup

Everything about alerts for the workspace: rules, daily reports, its chats (Telegram, Discord, webhooks; tokens and URLs shown in part) and its account names.

POST/api/alerts/chatsAdd a chat

Add a chat for alerts and reports: { "kind": "telegram", "token" (from @BotFather), "chat_id" (or "@channel"), "label" } or { "kind": "discord", "url" (the channel’s webhook URL), "label" }.

DELETE/api/alerts/chats/{chat_id}Remove a chat

Remove a chat: rules and reports stop sending to it.

POST/api/alerts/chats/{chat_id}/testSend a test message

A test message to the chat: { delivered, status, error }.

GET/api/alerts/logGet the alerts log

Alerts sent and findings of checks, newest first, each with what happened next and how it was marked. ?kind=dry|waiting|unread|bump|payment|online|session|check, ?account=, ?open=1 (only the ones nobody marked yet), ?limit= (up to 200, default 50), &offset=. _meta.open = how many nobody marked yet.

POST/api/alerts/log/{alert_id}Mark an alert

Mark an alert: { "action": "fixed" | "tried" | "handled" | "bumped" | "skipped" | "note" | "reopen", "note": "…" }.

POST/api/alerts/reportsCreate a report

Add a report: revenue per account (net, by kind, against the period before, month so far) and/or each tracking and free trial link’s new subscribers, clicks and revenue. covers: yesterday, today or week (UTC days); time "09:00" in tz (e.g. Europe/Lisbon); days: [] for every day, or 0 (Sunday) to 6; links: "all" (those with activity), "none" or ["tracking:123", "trials:4"]; to: chat ids.

PUT/api/alerts/reports/{report_id}Update a report

Change a report: any of its fields, or { "active": false } to pause it.

DELETE/api/alerts/reports/{report_id}Delete a report

Delete a report.

POST/api/alerts/reports/{report_id}/sendSend a report now

Send a report now, as it would go out: { sent, failed }.

POST/api/alerts/rulesCreate an alert rule

Add an alert rule. type: waiting (a fan wrote and nobody answered) or unread, with marks (minutes to alert at, e.g. [15, 30, 60, 120]; the last one is the last alert for that chat) and min_spent; payment (min_amount, kinds: tips, messages, posts, subscriptions, streams); online (a big spender came online, min_spent; needs Live on); session (the session ended or works again). accounts: ["*"] or names; to: chat ids.

PUT/api/alerts/rules/{rule_id}Update an alert rule

Change an alert rule: any of its fields, or { "active": false } to pause it.

DELETE/api/alerts/rules/{rule_id}Delete an alert rule

Delete an alert rule.

GET/api/alerts/skipGet skipped fans’ marks

Skipped fans: the marks (an emoji or a word in a fan’s custom name) that leave a fan out of alerts and bumps, and the emoji seen in custom names: { marks, seen: [{ mark, fans }] }.

PUT/api/alerts/skipSet skipped fans’ marks

Set the skipped fans’ marks: { "marks": ["❌", "🚫", "⛔", "no money"] }. [] skips nobody.

POST/api/alerts/telegram-chatsFind a Telegram bot’s chats

The chats a Telegram bot was added to or got a message in lately: { "token" } -> [{ id, name, type }].

GET/api/checksList checks

The latest one-off checks, newest first, each with its status and findings.

POST/api/checksRun a check

Run a check now: { "kind": "dry" | "bumps" | "waiting", "accounts": "*" or names, "hours": 24 | 72 | 168 }. Returns the check; its findings come in while it runs (GET /checks/:check_id).

GET/api/checks/{check_id}Get a check

One check: its progress and findings. counts.chats: chats read (at most 1,500 an account); counts.more: true when an account had more within the period.

DELETE/api/checks/{check_id}Stop or delete a check

Stop a running check, or delete a finished one.

POST/api/checks/{check_id}/bumpsAdd a check’s chats to Bumps

Add the chats a finished bumps check found to Bumps, each under the bump rule that covers its account.

POST/api/checks/{check_id}/sendSend a check’s findings

Send a finished check’s dry replies or waiting fans to chats: { "to": [chat ids] } -> { sent }.

GET/api/bumpsList bumps

Bumps: the rules, the bumps waiting (upcoming), the ones sent or closed (recent), and the workspace’s chats and accounts.

POST/api/bumps/items/{bump_id}/dismissDismiss a bump

Drop a waiting bump.

POST/api/bumps/items/{bump_id}/sendSend a bump now

Send a waiting bump’s reminder now.

POST/api/bumps/rulesCreate a bump rule

Add a bump rule: { "accounts": ["*"] or names, "to": [chat ids], "min_spent", "skip_creators", "opener", "default_hours": 3 | 6 | 12 | 24 }.

PUT/api/bumps/rules/{rule_id}Update a bump rule

Change a bump rule: any of its fields, or { "active": false } to pause it.

DELETE/api/bumps/rules/{rule_id}Delete a bump rule

Delete a bump rule. Its waiting bumps are cancelled.

Live 4

Live status, big spenders online, live events

GET/api/liveGet Live

Live, for every account (/api/live) or one: whether it’s on, its OnlyFans socket (state: live, connecting, waiting, session, off), who counts as a big spender (min_spent: net, all-time) and the big spenders online now.

GET/api/{account}/liveGet Live

Live, for every account (/api/live) or one: whether it’s on, its OnlyFans socket (state: live, connecting, waiting, session, off), who counts as a big spender (min_spent: net, all-time) and the big spenders online now.

PUT/api/{account}/liveTurn Live on or off

Turn Live on or off: { "enabled": true }, and set who counts as a big spender: { "min_spent": 100 } (dollars, net, all-time). With Live on the account keeps OnlyFans’ socket open, as its web app does: messages come in at once (message.received) and big spenders coming online fire fan.online. OnlyFans may show the account as online meanwhile.

GET/api/live/eventsStream live events

What happens as it happens, as server-sent events (text/event-stream): message (a chat got a message: account, chat_id, from fan or me), fan.online (a big spender came online: account, fan with what they spent), live (an account’s socket changed state). Accounts with Live on only.

Exports 5

Vault backups, spreadsheets

GET/api/exportsList exports

The workspace’s exports, newest first: vault backups (ZIP) and spreadsheets (CSV) made in the background. Each has status (queued, running, done, failed, canceled), progress { done, total, bytes }, error, and once done its file { name, size, rows or entries and missing } and download_url. Kept 7 days.

POST/api/exportsStart an export

Start an export: { "type": vault | chats | transactions | fans | links | payouts | chargebacks | profile_visitors, "account": a name, or "*" for every account (not vault), "from", "to" (UTC days, both included; default the last 30 days, chats 7; vault: none = all), "options" }. vault: { lists: [vault list ids] (none = the whole vault), types: photo, video, audio, gif }. fans: { type: active | expired | all, total_spent, tips, total_spent_under, tips_under, query } (the first 5,000 fans of each account: OnlyFans hands out no more; a file cut short has file.capped). links: { days }. One runs per account at a time, two per workspace; the same export asked for again while it waits gets that one.

GET/api/exports/{export_id}Get an export

One export: status, progress { done, total, bytes }, error, and once done its file and download_url.

DELETE/api/exports/{export_id}Cancel or delete an export

Cancel an export that is waiting or running (its file goes; it stays listed as canceled), or delete a finished one and its file.

GET/api/exports/{export_id}/downloadDownload an export

The export’s file (ZIP or CSV), as an attachment. Range works (206), so a download that was cut off carries on. A plain browser link works with ?workspace=<id> and the panel sign-in. Read-only keys may download.

Banned words 3

Word lists, text checks

GET/api/banned-wordsList banned words

Words to keep out of posts and messages: the built-in list (what OnlyFans’ policy bans, and what commonly gets flagged) plus this workspace’s own words, minus the built-in ones it turned off. [{ word, level: blocked|risky, why, own }].

PUT/api/banned-wordsUpdate banned words

The workspace’s own words and the built-in ones it turns off: { "add": [{ "word", "level": "blocked"|"risky" }], "off": [built-in words] }. Replaces both. Workspace owners (and API keys).

POST/api/banned-words/checkCheck a text

The flagged words in a text: { "text" } -> { blocked: [words], risky: [words] }. Whole words with their endings, look-alikes (t33n, r@pe) and written ages under 18.

Other 2

Raw OnlyFans requests, the endpoint list

ANY/api/{account}/proxy/{onlyfans_path}Raw OnlyFans request

Escape hatch. Send ANY OnlyFans API path straight through — it is signed and forwarded exactly as given. Copy a request from onlyfans.com’s DevTools and paste its path here. Money-movement and security paths (payouts, bank, login, password, 2FA) are blocked by design.

GET/api/{account}/endpointsList endpoints

Every route this API exposes, as "METHOD /path", some with a note after it in brackets.