Skip to content

ofmapi/postman-collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

OnlyFans API · Postman Collection

The official Postman collection for OFMAPI — explore, test, and prototype against the OnlyFans API in seconds.

License: MIT Docs Status


🚧 Preview release. General availability launching shortly. Sign up at ofmapi.com to be notified.

What is this

This repo is the source-of-truth mirror for the public OFMAPI Postman workspace. The collection covers every endpoint of the OnlyFans API, with:

  • Pre-configured request shapes and example bodies
  • Realistic example responses for every endpoint
  • Environment templates (production / staging / local-dev)
  • Pre-request scripts that auto-attach your API key
  • Tests on every response that validate envelope shape and rate-limit headers

Get the collection

Option 1: Public Postman workspace

Open the live OFMAPI workspace and click "Fork" to add it to your own Postman.

Option 2: Direct import

# Clone this repo
git clone https://github.com/ofmapi/postman-collection
cd postman-collection

# In Postman: File → Import → upload collection.json

The collection is auto-regenerated from our OpenAPI 3.1 spec on every API release, so it's always in sync.

Setup

  1. Get an OnlyFans API key at ofmapi.com — free, no credit card required.
  2. In Postman, open EnvironmentsOFMAPI Production.
  3. Set OFMAPI_API_KEY to your ofmapi_... value.
  4. Click any request and hit Send.

Run the collection in CI

The included newman/ directory has a Newman script for running the collection in CI as a smoke / contract test:

npm install -g newman
newman run collection.json --environment ./environments/production.json

Build the next generation of OnlyFans software

Use this collection to prototype products in the spirit of:

  • 🤖 AI chat platforms like Botly, Supercreator, Substy, ChatPersona
  • 📊 Creator CRMs like Infloww, OnlyMonster, CreatorHero
  • 📈 Analytics & metrics tools like FansMetric, FansIQ
  • 🎯 Traffic & attribution platforms like CreatorTraffic
  • 🔗 Link-in-bio + deeplink products like Juicy Bio, Hello Butter
  • 🛠️ Agency back-offices managing hundreds of accounts from a single dashboard

Click around the collection to feel the OnlyFans API surface — then export the requests as code in your language of choice.

What's covered

  • 💬 Messaging (chats, send, mass messaging, queue, PPV)
  • 📝 Posts, vault, stories, polls
  • 👥 Fans, subscriptions, lists, bundles
  • 💰 Earnings, transactions, payouts, chargebacks, analytics
  • 🌐 Public profile search
  • 🔗 Smart Links, free-trial links, tracking
  • 🔔 Webhook endpoint management
  • 📡 Realtime token issuance for the WebSocket
  • ⚙️ Account management, API keys, billing

Documentation

License

MIT — see LICENSE. The collection is yours to use, modify, fork, embed in your own tools, distribute internally — anything.


OFMAPI is an independent organisation, not affiliated with OnlyFans.com or Fenix International Limited. "OnlyFans" is a registered trademark of Fenix International Limited. Postman is a trademark of Postman, Inc.

About

Public Postman collection mirror of the OFMAPI OnlyFans API

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors