Reference overview
API Reference
All routes live under /v1/. Most endpoints are scoped to a connected OnlyFans account and accept account_id as the first path segment. Authentication is by API key.
Reference directory
Chats
11Messages
10Subscribers
8Fans
17- Get Fan Detailslive
- Get Fan Details by IDslive
- Update Fan Display Namelive
- Update Fan Noteslive
- Delete Fan Noteslive
- List FansFM
- Get Fan StatsFM
- Get Fan TransactionsFM
- Get Fan Transaction CountsFM
- Get Fan Custom NameFM
- Update Fan Custom NameFM
- Get Fan MetadataFM
- Update Fan MetadataFM
- Get Fan NoteFM
- Update Fan NoteFM
- Get Fan LinksFM
- Get Fan Chat SummaryFM
Notifications
7System
1Mass Messages
9Direct Messages
2Schedules
4User Lists
10Subscriptions
1Tracking Links
16- List Tracking LinksOF
- List Tracking LinksFM
- Get Tracking Linklive
- Create Tracking Linklive
- Delete Tracking Linklive
- Get Tracking Link Statslive
- Update Tracking LinkFM
- List Tracking Link ClaimersOF
- List Tracking Link ClaimersFM
- Get Tracking Links Chartlive
- Get Tracking Links Overviewlive
- List Tracking Link SharesFM
- Create Tracking Link ShareFM
- Update Tracking Link ShareFM
- Delete Tracking Link ShareFM
- List Shared Tracking Linkslive
Trial Links
17- List Trial LinksOF
- List Trial LinksFM
- Get Trial Linklive
- Create Trial Linklive
- Delete Trial Linklive
- Get Trial Link Statslive
- Update Trial LinkFM
- List Trial Link ClaimersOF
- List Trial Link ClaimersFM
- Get Trial Links Chartlive
- Get Trial Links Overviewlive
- List Trial Links Statslive
- List Trial Link SharesFM
- Create Trial Link ShareFM
- Update Trial Link ShareFM
- Delete Trial Link ShareFM
- List Shared Trial Linkslive
Tags
14- List Tagslive
- Create Taglive
- Set Tracking Link Tagslive
- Set Trial Link Tagslive
- Bulk Add Tags to Tracking Linkslive
- Bulk Remove Tags from Tracking Linkslive
- Bulk Add Tags to Trial Linkslive
- Bulk Remove Tags from Trial Linkslive
- List Tracking Link Tagslive
- Add Tags to Tracking Linklive
- Remove Tags from Tracking Linklive
- List Trial Link Tagslive
- Add Tags to Trial Linklive
- Remove Tags from Trial Linklive
Activity
1Highlights
1Reach
5Referrals
4Payouts
7Posts
12Post Labels
5Vault
14- List Vault Medialive
- Get Vault Medialive
- List Vault Listslive
- List Vault Media Processinglive
- Get Vault Media Typeslive
- Sort Vault Listslive
- Get Vault Media Release Formslive
- Lookup Vault Media by Hashlive
- Delete Vault Medialive
- Create Vault Listlive
- Rename Vault Listlive
- Delete Vault Listlive
- Add Media To Vault Listlive
- Remove Media From Vault Listlive
Media Upload
2Base URL and authentication
Every authenticated route lives under /v1/. Pass your API key in one of two ways: Authorization: Bearer fm_api_... or X-API-Key: fm_api_....
Rate limits are enforced per organization, so all keys in the same org share the same limit windows.
- Base URL:
https://public-api.fansmetric.com - Health check (no auth):
GET /health - Auth header:
Authorization: Bearer fm_api_...orX-API-Key: fm_api_...
Response envelope
Successful responses are wrapped in a standard envelope with data, optional _pagination, and _meta. The data shape varies per endpoint. _pagination is omitted on the last page. _meta is present on every authenticated response and contains credit usage and rate-limit info.
data— the response payload (object, array, or wrapper)_pagination.next_page— relative URL to the next page, or omitted_meta._credits.used— credits consumed:1on success and on any error past the auth gate (400, 402, 403, 404, 413, 424, 5xx);0only when auth itself fails (401) or you are throttled (429)_meta._rate_limits—limit_minute,remaining_minute,limit_day,remaining_day- Errors do not use the envelope:
{ "error": "..." }
Available endpoints
Each endpoint has a per-route permission. An API key only sees the routes its role grants.
- Accounts: list accounts, get current account
- Chats: list, hide, delete, mute/unmute, mark as read, list chat media, list chat lists
- Messages: list, search, send, unsend, like/unlike, pin/unpin
- Mass messages: list, send, list queue, cancel queue, list fan lists
- User lists: full CRUD plus member add/remove
- Subscribers: counts, list, top, latest, following, restricted, blocked, profile by username
- Fans: detail by id, batch detail by ids, update display name, update/delete notes
- User actions: block, report, restrict/unrestrict
- Subscriptions: history
- Notifications: list, mark read, count, get/update tabs order
- GIFs: trending, search
- Tracking links: list (OnlyFans relay), list (FansMetric data), share-access, claimers, chart, overview, get, create, delete
- Trial links: list (OnlyFans relay), list (FansMetric data), share-access, subscribers, chart, overview, stats, get, create, delete
- Tags: list, create, set/bulk add/remove on tracking and trial links