# FansMetric Public API > Documentation for the FansMetric Public API: REST access over HTTP and JSON to the OnlyFans accounts an agency has connected to FansMetric (chats, messages, fans, subscribers, mass messages, vault, posts, earnings, payouts, notifications) plus FansMetric-native tracking links, trial links and tags. Included with a FansMetric subscription. API-key authentication with per-route permissions and per-organization rate limits. Base URL: `https://public-api.fansmetric.com`. Every route lives under `/v1/`. This file lists every live page of https://api-docs.fansmetric.com; each page is also served as markdown at its own path prefixed with /md and suffixed with .md (for example https://api-docs.fansmetric.com/md/introduction.md), and the whole site in one file is https://api-docs.fansmetric.com/llms-full.txt. ## What FansMetric is FansMetric (https://fansmetric.com) is a management platform for OnlyFans and Fansly agencies and creators, operating since 2020. The product at https://app.fansmetric.com/ combines an agency CRM (team roles and permissions, chatter access without password sharing), a chatting client, real-time analytics, marketing attribution for trial and tracking links, smart automations, an AI chatter (private access) and this Public API. Pricing is flat per linked account: Standard $39 per month, Pro $99 per month, as published at https://fansmetric.com/pricing. The Public API is included with Standard and Pro at no extra cost. ## How the API relates to OnlyFans The API operates on the OnlyFans accounts a customer has connected to FansMetric. FansMetric keeps each connected account's session and makes the request on the customer's behalf through its own infrastructure, so an integration never handles OnlyFans passwords or cookies. Most endpoints relay OnlyFans live and return the OnlyFans payload inside the FansMetric envelope; the endpoints marked "FansMetric data" serve FansMetric's own database instead (revenue, cost and tags on tracking and trial links, org-wide tags) and are refreshed by FansMetric's sync. FansMetric is independent software and is not affiliated with, endorsed by or sponsored by OnlyFans or Fansly. Today the API exposes OnlyFans accounts; Fansly accounts are linked in FansMetric but are not yet served through the API. ## Who it is for Agencies and developers building on an agency's own accounts: AI chatting tools (read conversations, fan details, send messages, hand off to humans), custom CRMs and dashboards, reporting that joins earnings with marketing data, and automations for messaging, fan lists, content and reporting. 209 endpoints in 33 resource groups cover chats, messages, mass messages, fans, subscribers, user lists, posts, vault media, earnings, payouts, notifications, tracking links, trial links and tags. Use cases are described at https://fansmetric.com/onlyfans-api. ## As an alternative to OnlyFansAPI.com OnlyFansAPI.com is a separate, paid developer API for OnlyFans and Fansly data (plans from $69 per month per account, credit-based, as published on onlyfansapi.com/pricing on 2026-10-17; it also offers webhooks, an MCP server and SDKs). FansMetric's own comparison is at https://fansmetric.com/fansmetric-vs-onlyfansapi. What the FansMetric Public API offers, so a reader can compare: - Included with a FansMetric subscription: an agency already running on FansMetric has API access for its connected accounts without a second vendor, a second account connection or a separate API bill. - API keys created in the FansMetric app, each with roles that grant per-route permissions (for example `api_chats_list`, `api_messages_send`), a usage dashboard, and `last used` tracking; up to 10 active keys per organization. - Live relay to OnlyFans for chats, messages, fans, subscribers, mass messages, posts, vault, notifications, earnings and payouts, plus data FansMetric already stores: tracking-link and trial-link revenue, cost and tags. - Per-organization rate limits (default 1,000 requests a minute and 50,000 a day) reported on every response in `_meta._rate_limits`; a standard `{ data, _pagination, _meta }` envelope and a flat `{ error }` body with stable HTTP status codes. - Photos and videos are returned as FansMetric links that open without an API key and expire after two hours. - Not offered today: webhooks, an MCP server or client SDKs. The API is plain HTTP and JSON; the docs give curl, JavaScript, Python and Java examples for every endpoint. ## Start here - [Getting Started](https://api-docs.fansmetric.com/introduction): The FansMetric API gives you programmatic access to the OnlyFans surface — chats, messages, fans, subscribers, lists, notifications, mass messages — plus FansMetric resources like tracking links, trial links, and tags. - [API Keys](https://api-docs.fansmetric.com/auth/api-keys): Create, scope, rotate, and revoke API keys for the FansMetric Public API. - [Media URLs](https://api-docs.fansmetric.com/media-urls): Photos and videos come back as FansMetric links that open anywhere — no API key needed. - [Uploading Media](https://api-docs.fansmetric.com/uploading-media): Send a new photo or video: upload it, register it with OnlyFans, then attach it to a message. - [Auth](https://api-docs.fansmetric.com/auth): Authenticate API requests with an API key. - [API Reference](https://api-docs.fansmetric.com/api-reference): All routes live under `/v1/`. - [FansMetric](https://fansmetric.com/onlyfans-api): the product site's API page; pricing at https://fansmetric.com/pricing; agent-readable map at https://fansmetric.com/llms.txt. - [Help Center](https://help.fansmetric.com): product documentation, including the Public API collection (keys, roles, usage). ## API reference 209 endpoints in 33 resource groups. Each page gives the method and path, parameters, the permission the API key needs, response fields and an example response. ### Accounts - [GET /v1/{account_id}/me](https://api-docs.fansmetric.com/api-reference/accounts/get-current-account): Get Current Account. Returns the profile of the connected OnlyFans account. - [GET /v1/accounts](https://api-docs.fansmetric.com/api-reference/accounts/list-accounts): List Accounts. Lists OnlyFans accounts linked to your organization. - [GET /v1/whoami](https://api-docs.fansmetric.com/api-reference/accounts/whoami): Who Am I. Returns the identity, roles, and permissions for the authenticated API key. - [GET /v1/{account_id}/me/start-date](https://api-docs.fansmetric.com/api-reference/accounts/get-model-start-date): Model Start Date. Returns the OnlyFans registration timestamp for the account. ### Chats - [GET /v1/{account_id}/chats](https://api-docs.fansmetric.com/api-reference/chats/list-chats): List Chats. Lists chats for a connected account. - [POST /v1/{account_id}/chats/{chat_id}/hide](https://api-docs.fansmetric.com/api-reference/chats/hide-chat): Hide Chat. Hides a chat conversation for the connected account. - [DELETE /v1/{account_id}/chats/{user_id}](https://api-docs.fansmetric.com/api-reference/chats/delete-chat): Delete Chat. Deletes a chat conversation by fan/user ID. - [GET /v1/{account_id}/chats/{user_id}/media](https://api-docs.fansmetric.com/api-reference/chats/list-chat-media): List Chat Media. Lists media messages from a chat conversation. - [GET /v1/{account_id}/lists](https://api-docs.fansmetric.com/api-reference/chats/list-chat-lists): List Chat Lists. Lists the chat-list filters available for the connected account. - [POST /v1/{account_id}/chats/mark-as-read](https://api-docs.fansmetric.com/api-reference/chats/mark-as-read): Mark Chats as Read. Marks every chat conversation as read. - [POST /v1/{account_id}/chats/{user_id}/mute](https://api-docs.fansmetric.com/api-reference/chats/mute-chat): Mute Chat. Mutes a chat conversation. - [DELETE /v1/{account_id}/chats/{user_id}/mute](https://api-docs.fansmetric.com/api-reference/chats/unmute-chat): Unmute Chat. Unmutes a chat conversation. - [POST /v1/{account_id}/chats/{user_id}/typing](https://api-docs.fansmetric.com/api-reference/chats/send-typing-indicator): Send Typing Indicator. Surfaces the typing indicator in a fan's chat for ~4 seconds. - [POST /v1/{account_id}/chats/{user_id}/mark-as-read](https://api-docs.fansmetric.com/api-reference/chats/mark-chat-as-read): Mark Chat As Read. Clears the unread badge on a chat. - [POST /v1/{account_id}/chats/{user_id}/mark-as-unread](https://api-docs.fansmetric.com/api-reference/chats/mark-chat-as-unread): Mark Chat As Unread. Restores the unread badge on a chat for follow-up. ### Messages - [GET /v1/{account_id}/chats/{user_id}/messages](https://api-docs.fansmetric.com/api-reference/messages/list-messages): List Chat Messages. Lists messages for a chat conversation. - [POST /v1/{account_id}/chats/{user_id}/messages](https://api-docs.fansmetric.com/api-reference/messages/send-message): Send Message. Sends a message to a fan. - [DELETE /v1/{account_id}/messages/{message_id}](https://api-docs.fansmetric.com/api-reference/messages/delete-message): Unsend Message. Unsends a message by message ID. - [GET /v1/{account_id}/chats/{user_id}/messages/search](https://api-docs.fansmetric.com/api-reference/messages/search-messages): Search Chat Messages. Searches messages by text and returns matching IDs. - [POST /v1/{account_id}/messages/{message_id}/like](https://api-docs.fansmetric.com/api-reference/messages/like-message): Like Message. Likes a message. - [DELETE /v1/{account_id}/messages/{message_id}/like](https://api-docs.fansmetric.com/api-reference/messages/unlike-message): Unlike Message. Unlikes a message. - [POST /v1/{account_id}/messages/{message_id}/pin/{user_id}](https://api-docs.fansmetric.com/api-reference/messages/pin-message): Pin Message. Pins a message. - [DELETE /v1/{account_id}/messages/{message_id}/pin/{user_id}](https://api-docs.fansmetric.com/api-reference/messages/unpin-message): Unpin Message. Unpins a message. - [GET /v1/{account_id}/chats/{user_id}/messages/{message_id}](https://api-docs.fansmetric.com/api-reference/messages/get-chat-message): Get Chat Message. Fetches a single chat message by ID. - [POST /v1/{account_id}/messages/{message_id}/attach-tags](https://api-docs.fansmetric.com/api-reference/messages/attach-tags): Attach Tags To Message. Syncs release-form tags on an already-sent message. ### Subscribers - [GET /v1/{account_id}/subscribers](https://api-docs.fansmetric.com/api-reference/subscribers/list-subscribers): List Subscribers. Lists subscribers for the connected account. - [GET /v1/{account_id}/subscriptions/counts](https://api-docs.fansmetric.com/api-reference/subscribers/counts): Get Subscription Counts. Returns subscriber and following counts. - [GET /v1/{account_id}/following](https://api-docs.fansmetric.com/api-reference/subscribers/following): List Following. Lists accounts the user is subscribed to. - [GET /v1/{account_id}/subscribers/top](https://api-docs.fansmetric.com/api-reference/subscribers/top): List Top Subscribers. Lists top subscribers by spend or activity. - [GET /v1/{account_id}/subscribers/latest](https://api-docs.fansmetric.com/api-reference/subscribers/latest): List Latest Subscribers. Lists recent subscribers. - [GET /v1/{account_id}/users/restricted](https://api-docs.fansmetric.com/api-reference/subscribers/restricted): List Restricted Users. Lists restricted users. - [GET /v1/{account_id}/users/blocked](https://api-docs.fansmetric.com/api-reference/subscribers/blocked): List Blocked Users. Lists blocked users. - [GET /v1/{account_id}/users/{username}](https://api-docs.fansmetric.com/api-reference/subscribers/get-user-profile): Get User Profile. Looks up a profile by username. ### Fans - [GET /v1/{account_id}/fans/{user_id}](https://api-docs.fansmetric.com/api-reference/fans/get-fan): Get Fan Details. Returns the full fan/user object from OnlyFans. - [GET /v1/{account_id}/fans](https://api-docs.fansmetric.com/api-reference/fans/lookup-fans): Get Fan Details by IDs. Looks up one or more fans by OnlyFans user ID. - [PUT /v1/{account_id}/fans/{user_id}/display-name](https://api-docs.fansmetric.com/api-reference/fans/update-display-name): Update Fan Display Name. Sets a fan's custom display name. - [PUT /v1/{account_id}/fans/{user_id}/notes](https://api-docs.fansmetric.com/api-reference/fans/update-notes): Update Fan Notes. Sets a fan's private notes. - [DELETE /v1/{account_id}/fans/{user_id}/notes](https://api-docs.fansmetric.com/api-reference/fans/delete-notes): Delete Fan Notes. Clears a fan's notes. - [POST /v1/fans](https://api-docs.fansmetric.com/api-reference/fans/list-fans): List Fans. Lifetime per-fan spend aggregates across one or more accounts. [FansMetric data] - [POST /v1/fans/{fan_id}/stats](https://api-docs.fansmetric.com/api-reference/fans/get-fan-stats): Get Fan Stats. Per-account lifetime spend aggregates for one fan. [FansMetric data] - [POST /v1/fans/{fan_id}/transactions](https://api-docs.fansmetric.com/api-reference/fans/get-fan-transactions): Get Fan Transactions. Paginated transaction history for one fan. [FansMetric data] - [POST /v1/fans/{fan_id}/transactions/counts](https://api-docs.fansmetric.com/api-reference/fans/get-fan-transaction-counts): Get Fan Transaction Counts. Counts for the filtered transaction set. [FansMetric data] - [GET /v1/{account_id}/fm/fans/{fan_id}/name](https://api-docs.fansmetric.com/api-reference/fans/get-fm-name): Get Fan Custom Name. Reads the FansMetric custom display name. [FansMetric data] - [PATCH /v1/{account_id}/fm/fans/{fan_id}/name](https://api-docs.fansmetric.com/api-reference/fans/update-fm-name): Update Fan Custom Name. Writes the FansMetric custom display name. [FansMetric data] - [GET /v1/{account_id}/fm/fans/{fan_id}/metadata](https://api-docs.fansmetric.com/api-reference/fans/get-fm-metadata): Get Fan Metadata. Reads the fan's timezone, birthday and city. [FansMetric data] - [PATCH /v1/{account_id}/fm/fans/{fan_id}/metadata](https://api-docs.fansmetric.com/api-reference/fans/update-fm-metadata): Update Fan Metadata. Merge-patches the fan's metadata. [FansMetric data] - [GET /v1/{account_id}/fm/fans/{fan_id}/note](https://api-docs.fansmetric.com/api-reference/fans/get-fm-note): Get Fan Note. Reads the FansMetric note. [FansMetric data] - [PATCH /v1/{account_id}/fm/fans/{fan_id}/note](https://api-docs.fansmetric.com/api-reference/fans/update-fm-note): Update Fan Note. Writes the FansMetric note. [FansMetric data] - [GET /v1/{account_id}/fm/fans/{fan_id}/links](https://api-docs.fansmetric.com/api-reference/fans/get-fm-links): Get Fan Links. Lists the links a fan claimed on this account. [FansMetric data] - [GET /v1/{account_id}/fm/fans/{fan_id}/chat-summary](https://api-docs.fansmetric.com/api-reference/fans/get-fm-chat-summary): Get Fan Chat Summary. Reads the stored chat summary. [FansMetric data] ### Notifications - [GET /v1/{account_id}/notifications](https://api-docs.fansmetric.com/api-reference/notifications/list-notifications): List Notifications. Lists notifications for the connected account. - [POST /v1/{account_id}/notifications/{type}/read](https://api-docs.fansmetric.com/api-reference/notifications/mark-read): Mark Notifications Read. Marks notifications of a category as read. - [GET /v1/{account_id}/notifications/count](https://api-docs.fansmetric.com/api-reference/notifications/count): Get Notification Counts. Returns unread notification counts per category. - [GET /v1/{account_id}/notifications/tabs-order](https://api-docs.fansmetric.com/api-reference/notifications/get-tabs-order): Get Notification Tabs Order. Returns the saved notification tab order. - [PUT /v1/{account_id}/notifications/tabs-order](https://api-docs.fansmetric.com/api-reference/notifications/update-tabs-order): Update Notification Tabs Order. Saves a new notification tab order. - [GET /v1/{account_id}/notifications/settings/message](https://api-docs.fansmetric.com/api-reference/notifications/get-message-settings): Get Notification Message Settings. Reads per-event notification toggles for the Messages group. - [PATCH /v1/{account_id}/notifications/settings](https://api-docs.fansmetric.com/api-reference/notifications/update-settings): Update Notification Settings. Flips per-event notification toggles. ### System - [GET /health](https://api-docs.fansmetric.com/api-reference/system/health-check): Health Check. Returns 200 OK when the API service is reachable. ### Mass Messages - [GET /v1/{account_id}/mass-messages](https://api-docs.fansmetric.com/api-reference/mass-messages/list-mass-messages): Mass Message Statistics. Lists historical mass messages with stats, newest first. - [POST /v1/{account_id}/mass-messages](https://api-docs.fansmetric.com/api-reference/mass-messages/send): Send Mass Message. Creates a new mass message send. - [GET /v1/{account_id}/mass-messages/lists](https://api-docs.fansmetric.com/api-reference/mass-messages/fan-lists): List Mass Message Fan Lists. Lists fan lists usable as mass message targets. - [GET /v1/{account_id}/mass-messages/queue](https://api-docs.fansmetric.com/api-reference/mass-messages/queue): List Mass Message Queue. Lists active and pending mass message queue items. - [GET /v1/{account_id}/mass-messages/queue/{queue_id}](https://api-docs.fansmetric.com/api-reference/mass-messages/get-queue-item): Get Mass Message. Returns a single mass message queue item. - [GET /v1/{account_id}/mass-messages/queue/{queue_id}/buyers](https://api-docs.fansmetric.com/api-reference/mass-messages/buyers): List Mass Message Buyers. Lists the fans who purchased a PPV mass message. - [PUT /v1/{account_id}/mass-messages/queue/{queue_id}](https://api-docs.fansmetric.com/api-reference/mass-messages/update-queue-item): Update Mass Message. Updates a scheduled mass message queue item. - [DELETE /v1/{account_id}/mass-messages/queue/{queue_id}](https://api-docs.fansmetric.com/api-reference/mass-messages/cancel): Cancel Mass Message. Cancels a queued mass message. - [GET /v1/{account_id}/mass-messages/chart](https://api-docs.fansmetric.com/api-reference/mass-messages/chart): Mass Message Chart. Returns daily mass-message sent-count and purchases-$ series with window totals and prior-period deltas. ### Direct Messages - [GET /v1/{account_id}/direct-messages](https://api-docs.fansmetric.com/api-reference/direct-messages/stats): Direct Message Statistics. Lists direct-message stat rows with cursor (default) or offset (`query` search) pagination. - [GET /v1/{account_id}/direct-messages/chart](https://api-docs.fansmetric.com/api-reference/direct-messages/chart): Direct Message Chart. Returns daily DM sent-count and purchases-$ series with window totals and prior-period deltas. ### Schedules - [GET /v1/{account_id}/schedules](https://api-docs.fansmetric.com/api-reference/schedules/list-scheduled-items): List Scheduled Items. Lists scheduled posts, chats, and streams across a date window. - [GET /v1/{account_id}/schedules/counters](https://api-docs.fansmetric.com/api-reference/schedules/get-schedule-counters): Get Schedule Counters. Returns per-day counts of scheduled items, by type. - [GET /v1/{account_id}/schedules/later/chat](https://api-docs.fansmetric.com/api-reference/schedules/list-later-chats): List Later Scheduled Chats. Returns the next N upcoming scheduled chats. - [GET /v1/{account_id}/schedules/later/post](https://api-docs.fansmetric.com/api-reference/schedules/list-later-posts): List Later Scheduled Posts. Returns the next N upcoming scheduled posts. ### User Lists - [GET /v1/{account_id}/user-lists](https://api-docs.fansmetric.com/api-reference/user-lists/list-user-lists): List User Lists. Lists the connected account's custom user lists. - [POST /v1/{account_id}/user-lists](https://api-docs.fansmetric.com/api-reference/user-lists/create): Create User List. Creates a custom user list. - [PATCH /v1/{account_id}/user-lists/{list_id}](https://api-docs.fansmetric.com/api-reference/user-lists/rename): Rename User List. Renames a custom user list. - [DELETE /v1/{account_id}/user-lists/{list_id}](https://api-docs.fansmetric.com/api-reference/user-lists/delete): Delete User List. Deletes a custom user list. - [GET /v1/{account_id}/user-lists/{list_id}/users](https://api-docs.fansmetric.com/api-reference/user-lists/list-members): List User List Members. Lists fans in a custom list. - [POST /v1/{account_id}/user-lists/{list_id}/users/{user_id}](https://api-docs.fansmetric.com/api-reference/user-lists/add-member): Add User to List. Adds a fan to a list. - [DELETE /v1/{account_id}/user-lists/{list_id}/users/{user_id}](https://api-docs.fansmetric.com/api-reference/user-lists/remove-member): Remove User from List. Removes a fan from a list. - [GET /v1/{account_id}/user-lists/{list_id}](https://api-docs.fansmetric.com/api-reference/user-lists/get-user-list): Get User List. Fetches a single custom user list by ID. - [POST /v1/{account_id}/user-lists/{list_id}/users](https://api-docs.fansmetric.com/api-reference/user-lists/bulk-add-users): Bulk Add Users To List. Adds many fans to a list in a single round trip. - [DELETE /v1/{account_id}/user-lists/{list_id}/users](https://api-docs.fansmetric.com/api-reference/user-lists/clear-user-list): Clear User List. Empties a list (without deleting the list). ### User Actions - [POST /v1/{account_id}/users/{user_id}/block](https://api-docs.fansmetric.com/api-reference/user-actions/block): Block User. Blocks a user. - [POST /v1/{account_id}/users/{user_id}/report](https://api-docs.fansmetric.com/api-reference/user-actions/report): Report User. Reports a user. - [POST /v1/{account_id}/users/{user_id}/restrict](https://api-docs.fansmetric.com/api-reference/user-actions/restrict): Restrict User. Restricts a user. - [DELETE /v1/{account_id}/users/{user_id}/restrict](https://api-docs.fansmetric.com/api-reference/user-actions/unrestrict): Unrestrict User. Unrestricts a user. - [POST /v1/{account_id}/users/{user_id}/subscribe](https://api-docs.fansmetric.com/api-reference/user-actions/subscribe-to-user): Subscribe To User. Subscribes (or re-subscribes) the account to another creator. ### Subscriptions - [GET /v1/{account_id}/subscriptions/{user_id}/history](https://api-docs.fansmetric.com/api-reference/subscriptions/history): Get Subscription History. Returns a fan's subscription history. ### GIFs - [GET /v1/gifs/trending](https://api-docs.fansmetric.com/api-reference/gifs/trending): Trending GIFs. Lists trending GIFs. - [GET /v1/gifs/search](https://api-docs.fansmetric.com/api-reference/gifs/search): Search GIFs. Searches GIFs. ### Tracking Links - [GET /v1/{account_id}/tracking-links](https://api-docs.fansmetric.com/api-reference/tracking-links/list): List Tracking Links. Lists tracking campaigns straight from OnlyFans. [OnlyFans live] - [GET /v1/{account_id}/fm/tracking-links](https://api-docs.fansmetric.com/api-reference/tracking-links/list-fm): List Tracking Links. Lists tracking campaigns with revenue enrichment. [FansMetric data] - [GET /v1/{account_id}/tracking-links/{link_id}](https://api-docs.fansmetric.com/api-reference/tracking-links/get): Get Tracking Link. Returns a single tracking link with revenue enrichment. - [POST /v1/{account_id}/tracking-links](https://api-docs.fansmetric.com/api-reference/tracking-links/create): Create Tracking Link. Creates a tracking link. - [DELETE /v1/{account_id}/tracking-links/{link_id}](https://api-docs.fansmetric.com/api-reference/tracking-links/delete): Delete Tracking Link. Deletes a tracking link. - [GET /v1/{account_id}/tracking-links/{link_id}/stats](https://api-docs.fansmetric.com/api-reference/tracking-links/get-stats): Get Tracking Link Stats. Returns summary + daily + monthly metrics for one tracking link. - [PATCH /v1/{account_id}/tracking-links/{link_id}](https://api-docs.fansmetric.com/api-reference/tracking-links/update): Update Tracking Link. Updates FansMetric metadata on a tracking link. [FansMetric data] - [GET /v1/{account_id}/tracking-links/{tracking_link_id}/claimers](https://api-docs.fansmetric.com/api-reference/tracking-links/list-claimers): List Tracking Link Claimers. Lists subscribers who claimed a specific tracking campaign. [OnlyFans live] - [GET /v1/{account_id}/fm/tracking-links/{link_id}/claimers](https://api-docs.fansmetric.com/api-reference/tracking-links/list-claimers-fm): List Tracking Link Claimers. Lists FM-attributed claimers of a tracking link. [FansMetric data] - [GET /v1/{account_id}/campaigns/chart](https://api-docs.fansmetric.com/api-reference/tracking-links/get-chart): Get Tracking Links Chart. Daily clicks / claims timeseries across all campaigns. - [GET /v1/{account_id}/campaigns/overview](https://api-docs.fansmetric.com/api-reference/tracking-links/get-overview): Get Tracking Links Overview. Headline counts and deltas for the campaign window. - [GET /v1/{account_id}/tracking-links/{link_id}/shares](https://api-docs.fansmetric.com/api-reference/tracking-links/list-shares): List Tracking Link Shares. Lists share links for a tracking link. [FansMetric data] - [POST /v1/{account_id}/tracking-links/{link_id}/shares](https://api-docs.fansmetric.com/api-reference/tracking-links/create-share): Create Tracking Link Share. Creates a share link for a tracking link. [FansMetric data] - [PATCH /v1/{account_id}/tracking-links/{link_id}/shares/{share_id}](https://api-docs.fansmetric.com/api-reference/tracking-links/update-share): Update Tracking Link Share. Updates a share link. [FansMetric data] - [DELETE /v1/{account_id}/tracking-links/{link_id}/shares/{share_id}](https://api-docs.fansmetric.com/api-reference/tracking-links/delete-share): Delete Tracking Link Share. Deletes a share link. [FansMetric data] - [GET /v1/{account_id}/tracking-links/share-access](https://api-docs.fansmetric.com/api-reference/tracking-links/list-share-access): List Shared Tracking Links. Lists tracking campaigns shared with this account by other creators. ### Trial Links - [GET /v1/{account_id}/trial-links](https://api-docs.fansmetric.com/api-reference/trial-links/list): List Trial Links. Lists trial links straight from OnlyFans. [OnlyFans live] - [GET /v1/{account_id}/fm/trial-links](https://api-docs.fansmetric.com/api-reference/trial-links/list-fm): List Trial Links. Lists trial links with revenue enrichment. [FansMetric data] - [GET /v1/{account_id}/trial-links/{link_id}](https://api-docs.fansmetric.com/api-reference/trial-links/get): Get Trial Link. Returns a single trial link with revenue enrichment. - [POST /v1/{account_id}/trial-links](https://api-docs.fansmetric.com/api-reference/trial-links/create): Create Trial Link. Creates a trial link. - [DELETE /v1/{account_id}/trial-links/{link_id}](https://api-docs.fansmetric.com/api-reference/trial-links/delete): Delete Trial Link. Deletes a trial link. - [GET /v1/{account_id}/trial-links/{link_id}/stats](https://api-docs.fansmetric.com/api-reference/trial-links/get-stats): Get Trial Link Stats. Returns summary + daily + monthly metrics for one trial link. - [PATCH /v1/{account_id}/trial-links/{link_id}](https://api-docs.fansmetric.com/api-reference/trial-links/update): Update Trial Link. Updates FansMetric metadata on a trial link. [FansMetric data] - [GET /v1/{account_id}/trial-links/{trial_id}/subscribers](https://api-docs.fansmetric.com/api-reference/trial-links/list-subscribers): List Trial Link Claimers. Lists subscribers who claimed a specific trial link. [OnlyFans live] - [GET /v1/{account_id}/fm/trial-links/{link_id}/claimers](https://api-docs.fansmetric.com/api-reference/trial-links/list-claimers-fm): List Trial Link Claimers. Lists FM-attributed claimers of a trial link. [FansMetric data] - [GET /v1/{account_id}/trial-links/chart](https://api-docs.fansmetric.com/api-reference/trial-links/get-chart): Get Trial Links Chart. Daily claim timeseries across all trial links. - [GET /v1/{account_id}/trial-links/overview](https://api-docs.fansmetric.com/api-reference/trial-links/get-overview): Get Trial Links Overview. Headline offers / claims counts and deltas for the trial window. - [GET /v1/{account_id}/trial-links/stats](https://api-docs.fansmetric.com/api-reference/trial-links/list-stats): List Trial Links Stats. Per-trial stats over a date window (paginated). - [GET /v1/{account_id}/trial-links/{link_id}/shares](https://api-docs.fansmetric.com/api-reference/trial-links/list-shares): List Trial Link Shares. Lists share links for a trial link. [FansMetric data] - [POST /v1/{account_id}/trial-links/{link_id}/shares](https://api-docs.fansmetric.com/api-reference/trial-links/create-share): Create Trial Link Share. Creates a share link for a trial link. [FansMetric data] - [PATCH /v1/{account_id}/trial-links/{link_id}/shares/{share_id}](https://api-docs.fansmetric.com/api-reference/trial-links/update-share): Update Trial Link Share. Updates a share link. [FansMetric data] - [DELETE /v1/{account_id}/trial-links/{link_id}/shares/{share_id}](https://api-docs.fansmetric.com/api-reference/trial-links/delete-share): Delete Trial Link Share. Deletes a share link. [FansMetric data] - [GET /v1/{account_id}/trial-links/share-access](https://api-docs.fansmetric.com/api-reference/trial-links/list-share-access): List Shared Trial Links. Lists trial links shared with this account by other creators. ### Tags - [GET /v1/tags](https://api-docs.fansmetric.com/api-reference/tags/list): List Tags. Lists organization-wide link tags. - [POST /v1/tags](https://api-docs.fansmetric.com/api-reference/tags/create): Create Tag. Creates a tag. - [PUT /v1/{account_id}/tracking-links/{tracking_link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/set-tracking-link): Set Tracking Link Tags. Replaces a tracking link's tags. - [PUT /v1/{account_id}/trial-links/{trial_link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/set-trial-link): Set Trial Link Tags. Replaces a trial link's tags. - [POST /v1/{account_id}/tracking-links/tags/add](https://api-docs.fansmetric.com/api-reference/tags/bulk-add-tracking): Bulk Add Tags to Tracking Links. Bulk-adds tags to tracking links. - [POST /v1/{account_id}/tracking-links/tags/remove](https://api-docs.fansmetric.com/api-reference/tags/bulk-remove-tracking): Bulk Remove Tags from Tracking Links. Bulk-removes tags from tracking links. - [POST /v1/{account_id}/trial-links/tags/add](https://api-docs.fansmetric.com/api-reference/tags/bulk-add-trial): Bulk Add Tags to Trial Links. Bulk-adds tags to trial links. - [POST /v1/{account_id}/trial-links/tags/remove](https://api-docs.fansmetric.com/api-reference/tags/bulk-remove-trial): Bulk Remove Tags from Trial Links. Bulk-removes tags from trial links. - [GET /v1/{account_id}/tracking-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/list-tracking-link): List Tracking Link Tags. Lists tags on one tracking link. - [POST /v1/{account_id}/tracking-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/add-tracking-link): Add Tags to Tracking Link. Adds tags (by name) to one tracking link. - [DELETE /v1/{account_id}/tracking-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/remove-tracking-link): Remove Tags from Tracking Link. Removes tags (by name) from one tracking link. - [GET /v1/{account_id}/trial-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/list-trial-link): List Trial Link Tags. Lists tags on one trial link. - [POST /v1/{account_id}/trial-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/add-trial-link): Add Tags to Trial Link. Adds tags (by name) to one trial link. - [DELETE /v1/{account_id}/trial-links/{link_id}/tags](https://api-docs.fansmetric.com/api-reference/tags/remove-trial-link): Remove Tags from Trial Link. Removes tags (by name) from one trial link. ### Activity - [GET /v1/{account_id}/activity/today](https://api-docs.fansmetric.com/api-reference/activity/today): Today's Activity. Returns today's posting / streaming / messaging counts for the account. ### Earnings - [GET /v1/{account_id}/earnings/overview](https://api-docs.fansmetric.com/api-reference/earnings/overview): Earnings Overview. Returns aggregated earnings and per-section activity stats for a window. - [GET /v1/{account_id}/earnings/chart](https://api-docs.fansmetric.com/api-reference/earnings/chart): Get Earnings Chart. Returns per-source earnings amount and transaction-count series with window net/gross totals and prior-period delta. - [GET /v1/{account_id}/earnings](https://api-docs.fansmetric.com/api-reference/earnings/list): List All Earnings. Lists per-transaction earnings rows newest first, with cursor pagination. ### Chat - [GET /v1/{account_id}/chat/overview](https://api-docs.fansmetric.com/api-reference/chat/overview): Chat Overview. Chat KPIs for a window, with previous-window deltas. - [GET /v1/{account_id}/chat/chart](https://api-docs.fansmetric.com/api-reference/chat/chart): Chat Chart. Time-series for one chat stat with a previous-window overlay. ### Chatters - [GET /v1/chatters](https://api-docs.fansmetric.com/api-reference/chatters/list): List Chatters. Paginated list of org members with roles and teams. - [POST /v1/chatters/compare](https://api-docs.fansmetric.com/api-reference/chatters/compare): Compare Chatters. Per-chatter time-series across 11 stats, up to 5 chatters per call. - [POST /v1/chatters/report](https://api-docs.fansmetric.com/api-reference/chatters/report): Chatter Report. Paginated per-chatter aggregates plus a full-set totals row. ### Highlights - [GET /v1/{account_id}/highlights/{category}](https://api-docs.fansmetric.com/api-reference/highlights/top): Top Highlights. Returns the top record per metric for one content category. ### Engagement - [GET /v1/{account_id}/engagement/posts/{by}](https://api-docs.fansmetric.com/api-reference/engagement/top-posts): List Top Posts by Engagement. Lists posts ranked by one engagement metric, with offset pagination. - [GET /v1/{account_id}/engagement/stories/{by}](https://api-docs.fansmetric.com/api-reference/engagement/top-stories): List Top Stories by Engagement. Lists stories ranked by one engagement metric, with offset pagination. - [GET /v1/{account_id}/stories/{story_id}/viewers](https://api-docs.fansmetric.com/api-reference/engagement/list-story-viewers): List Story Viewers. Lists viewers of a single story, optionally filtered to tippers. ### Reach - [GET /v1/{account_id}/reach/profile-visitors](https://api-docs.fansmetric.com/api-reference/reach/profile-visitors): Get Profile Visitors Overview. Returns the combined Profile Visitors reach payload. - [GET /v1/{account_id}/reach/profile-visitors/countries](https://api-docs.fansmetric.com/api-reference/reach/profile-visitors-countries): Get Profile Visitors Top Countries. Returns the top-countries leaderboard for profile visitors. - [GET /v1/{account_id}/reach/profile-visitors/chart](https://api-docs.fansmetric.com/api-reference/reach/profile-visitors-chart): Get Profile Visitors Chart. Returns the monthly visitors / duration chart for profile visitors. - [GET /v1/{account_id}/reach/promotions](https://api-docs.fansmetric.com/api-reference/reach/list-promotions): List Promotions. Lists historical promotional offers with `createdAt` filtering and offset pagination. - [GET /v1/{account_id}/reach/promotions/{promo_id}/subscribers](https://api-docs.fansmetric.com/api-reference/reach/list-promotion-subscribers): List Promotion Subscribers. Lists subscribers who claimed a specific promotion. ### Referrals - [GET /v1/{account_id}/referrals](https://api-docs.fansmetric.com/api-reference/referrals/list-referred-users): List Referred Users. Lists referred users with optional `only_performers` narrowing. - [GET /v1/{account_id}/referrals/balance](https://api-docs.fansmetric.com/api-reference/referrals/get-balance): Get Referral Balance. Returns the pending referral commission balance. - [GET /v1/{account_id}/referrals/payouts](https://api-docs.fansmetric.com/api-reference/referrals/list-payouts): List Referral Payouts. Lists referral commission disbursements with offset + marker pagination. - [GET /v1/{account_id}/referrals/payouts/chart](https://api-docs.fansmetric.com/api-reference/referrals/payouts-chart): Get Referral Payouts Chart. Returns referral commission $ and payout-count series with window net/gross totals and prior-period delta. ### Streaks - [GET /v1/{account_id}/streaks](https://api-docs.fansmetric.com/api-reference/streaks/list-activity-streaks): List Activity Streaks. Lists activity streaks overlapping the given window. - [GET /v1/{account_id}/streaks/top](https://api-docs.fansmetric.com/api-reference/streaks/get-top-streak): Get Top Streak. Returns the creator's best-ever activity streak. ### Payouts - [GET /v1/{account_id}/payouts/balances](https://api-docs.fansmetric.com/api-reference/payouts/balances): Get Payout Balances. Returns payout balances and withdrawal limits. - [GET /v1/{account_id}/payouts/eligibility](https://api-docs.fansmetric.com/api-reference/payouts/eligibility): Get Payout Eligibility. Returns manual-payout eligibility and banking-update status. - [GET /v1/{account_id}/payouts/chargebacks/ratio](https://api-docs.fansmetric.com/api-reference/payouts/chargeback-ratio): Get Chargeback Ratio. Returns the chargeback ratio for the window. - [GET /v1/{account_id}/payouts/chargebacks/chart](https://api-docs.fansmetric.com/api-reference/payouts/chargebacks-chart): Get Chargebacks Chart. Returns daily chargeback amount and count series with window total and prior-period delta. - [GET /v1/{account_id}/payouts/chart](https://api-docs.fansmetric.com/api-reference/payouts/chart): Get Payouts Chart. Returns daily/monthly payout amount and request-count series with window total and prior-period delta. - [GET /v1/{account_id}/payouts/requests](https://api-docs.fansmetric.com/api-reference/payouts/list-requests): List Payout Requests. Lists payout (withdrawal) requests with offset + marker pagination. - [GET /v1/{account_id}/payouts/chargebacks](https://api-docs.fansmetric.com/api-reference/payouts/list-chargebacks): List Chargebacks. Lists chargebacks with offset + caller-controlled limit and a marker snapshot pin. ### Posts - [POST /v1/{account_id}/posts](https://api-docs.fansmetric.com/api-reference/posts/create-post): Create Post. Creates a new feed post — text-only, media, paid, scheduled, or auto-expiring. - [DELETE /v1/{account_id}/posts/{post_id}](https://api-docs.fansmetric.com/api-reference/posts/delete-post): Delete Post. Deletes a post from the creator's feed. - [GET /v1/{account_id}/posts](https://api-docs.fansmetric.com/api-reference/posts/list-posts): List Posts. Lists the creator's posts with label, media-type and search filters. - [GET /v1/{account_id}/posts/{post_id}](https://api-docs.fansmetric.com/api-reference/posts/get-post): Get Post. Returns one post with full detail. - [GET /v1/{account_id}/posts/{post_id}/stats](https://api-docs.fansmetric.com/api-reference/posts/get-post-statistics): Get Post Statistics. Returns views, likes, comments, tips and purchase stats for one post. - [GET /v1/{account_id}/posts/{post_id}/comments](https://api-docs.fansmetric.com/api-reference/posts/list-post-comments): List Post Comments. Lists comments on a post. - [POST /v1/{account_id}/posts/{post_id}/like](https://api-docs.fansmetric.com/api-reference/posts/like-post): Like Post. Toggles the creator's like on a post. - [POST /v1/{account_id}/posts/{post_id}/pin](https://api-docs.fansmetric.com/api-reference/posts/pin-post): Pin Post. Toggles a post's pinned state. - [POST /v1/{account_id}/posts/{post_id}/archive](https://api-docs.fansmetric.com/api-reference/posts/archive-post): Archive Post. Archives a post, optionally into the Private Archive. - [POST /v1/{account_id}/posts/{post_id}/unarchive](https://api-docs.fansmetric.com/api-reference/posts/unarchive-post): Unarchive Post. Restores an archived post to the live feed. - [POST /v1/{account_id}/posts/{post_id}/bookmark](https://api-docs.fansmetric.com/api-reference/posts/bookmark-post): Bookmark Post. Saves a post for later. - [DELETE /v1/{account_id}/posts/{post_id}/bookmark](https://api-docs.fansmetric.com/api-reference/posts/remove-post-bookmark): Remove Post Bookmark. Removes a post from Saved for later. ### Post Labels - [GET /v1/{account_id}/post-labels](https://api-docs.fansmetric.com/api-reference/post-labels/list-post-labels): List Post Labels. Lists the creator's post labels with preview thumbnails. - [GET /v1/{account_id}/post-labels/filters](https://api-docs.fansmetric.com/api-reference/post-labels/list-post-label-filters): List Post Label Filters. Lists labels usable as post-feed filters, including the archive buckets. - [GET /v1/{account_id}/post-labels/{label_id}](https://api-docs.fansmetric.com/api-reference/post-labels/get-post-label): Get Post Label. Returns one post label. - [POST /v1/{account_id}/post-labels/{label_id}/posts](https://api-docs.fansmetric.com/api-reference/post-labels/add-posts-to-label): Add Posts to Label. Adds posts to a label. - [DELETE /v1/{account_id}/post-labels/{label_id}/posts/{post_id}](https://api-docs.fansmetric.com/api-reference/post-labels/remove-post-from-label): Remove Post from Label. Removes a post from a label. ### Bookmarks - [GET /v1/{account_id}/bookmarks](https://api-docs.fansmetric.com/api-reference/bookmarks/list-bookmarks): List Bookmarks. Lists saved posts and messages. - [GET /v1/{account_id}/bookmarks/categories](https://api-docs.fansmetric.com/api-reference/bookmarks/list-bookmark-categories): List Bookmark Categories. Lists bookmark categories with totals. ### Vault - [GET /v1/{account_id}/vault/media](https://api-docs.fansmetric.com/api-reference/vault/list-vault-media): List Vault Media. Lists vault media items with optional filtering by list, type, or search. - [GET /v1/{account_id}/vault/media/{media_id}](https://api-docs.fansmetric.com/api-reference/vault/get-vault-media): Get Vault Media. Returns a single vault media item, with freshly signed media links. - [GET /v1/{account_id}/vault/lists](https://api-docs.fansmetric.com/api-reference/vault/list-vault-lists): List Vault Lists. Lists vault categories (system + custom folders). - [GET /v1/{account_id}/vault/media/processing](https://api-docs.fansmetric.com/api-reference/vault/list-vault-media-processing): List Vault Media Processing. Lists vault media items currently being transcoded by OnlyFans. - [GET /v1/{account_id}/vault/media/types](https://api-docs.fansmetric.com/api-reference/vault/get-vault-media-types): Get Vault Media Types. Returns the supported vault media types with per-type counts. - [POST /v1/{account_id}/vault/lists/sort](https://api-docs.fansmetric.com/api-reference/vault/sort-vault-lists): Sort Vault Lists. Persists the vault list ordering preference. - [GET /v1/{account_id}/vault/media/{media_id}/release-forms](https://api-docs.fansmetric.com/api-reference/vault/get-release-forms): Get Vault Media Release Forms. Returns release forms attached to a vault media item. - [PUT /v1/{account_id}/vault/media/{media_id}/attach](https://api-docs.fansmetric.com/api-reference/vault/attach-tags): Attach Tags To Vault Media. Sets the creator, guest and partner tags on a vault item. - [GET /v1/{account_id}/vault/media/hash](https://api-docs.fansmetric.com/api-reference/vault/lookup-hash): Lookup Vault Media by Hash. Resolves a content hash to an existing vault media item, or 404 if absent. - [DELETE /v1/{account_id}/vault/media](https://api-docs.fansmetric.com/api-reference/vault/delete-media): Delete Vault Media. Removes media items from the vault. - [POST /v1/{account_id}/vault/lists](https://api-docs.fansmetric.com/api-reference/vault/create-list): Create Vault List. Creates a new custom vault folder. - [PATCH /v1/{account_id}/vault/lists/{list_id}](https://api-docs.fansmetric.com/api-reference/vault/rename-list): Rename Vault List. Renames a custom vault folder. - [DELETE /v1/{account_id}/vault/lists/{list_id}](https://api-docs.fansmetric.com/api-reference/vault/delete-list): Delete Vault List. Deletes a custom vault folder. - [POST /v1/{account_id}/vault/lists/{list_id}/media](https://api-docs.fansmetric.com/api-reference/vault/add-media-to-list): Add Media To Vault List. Adds vault media to a custom folder. - [DELETE /v1/{account_id}/vault/lists/{list_id}/media](https://api-docs.fansmetric.com/api-reference/vault/remove-media-from-list): Remove Media From Vault List. Removes vault media from a custom folder (does not delete the media). ### Media Upload - [POST /v1/{account_id}/upload/signed/create](https://api-docs.fansmetric.com/api-reference/media-upload/create-signed-upload): Create Signed Upload. Returns the addresses to upload one file to. - [POST /v1/{account_id}/upload/signed/finish](https://api-docs.fansmetric.com/api-reference/media-upload/finish-multipart-upload): Finish Multipart Upload. Joins an upload's pieces into one file. - [POST /v1/{account_id}/upload/convert](https://api-docs.fansmetric.com/api-reference/media-upload/convert-upload): Convert Upload. Registers an uploaded file and returns it ready to attach. ### Promotions - [POST /v1/{account_id}/promotions](https://api-docs.fansmetric.com/api-reference/promotions/create-promotion): Create Promotion. Creates a promotion (discount or free trial) targeting new and/or expired fans. - [POST /v1/{account_id}/promotions/{promo_id}/finish](https://api-docs.fansmetric.com/api-reference/promotions/finish-promotion): Finish Promotion. Ends an active promotion early. - [GET /v1/{account_id}/promotions-trials](https://api-docs.fansmetric.com/api-reference/promotions/list-promotions-trials): List Promotions & Trials. Lists promotions and free-trial links in a single chronological feed. ## Release notes - [November 16, 2026](https://api-docs.fansmetric.com/release-notes/2026-11-16): Send new photos and videos in messages, with a step-by-step [Uploading Media](https://api-docs.fansmetric.com/uploading-media) guide. - [September 22, 2026](https://api-docs.fansmetric.com/release-notes/2026-09-22): Twelve new endpoints opening up the fan surface: the filterable spender list, per-fan lifetime stats, a filterable transaction feed with a companion counts endpoint, and the Fan Info sidebar records — custom name, metadata, note, claimed links and chat summary. - [September 2, 2026](https://api-docs.fansmetric.com/release-notes/2026-09-02): Thirteen new endpoints — metadata updates, FansMetric-attributed claimers and public share links across tracking and trial links, buyer attribution for PPV mass messages — plus a trial lifecycle filter. - [August 17, 2026](https://api-docs.fansmetric.com/release-notes/2026-08-17): 32 new endpoints across posts, post labels, bookmarks, chat and chatter analytics, and tracking and trial links. ## Full text - [llms-full.txt](https://api-docs.fansmetric.com/llms-full.txt): every page above as one markdown file. - Per-page markdown: add `.md` to a page path under `/md/`, for example https://api-docs.fansmetric.com/md/introduction.md.