Getting Started
Make your first authenticated API call in under 5 minutes.
Base URL
All API requests use this base URL. There is no version prefix — use paths directly.
/apiQuick Start
Create an account
Sign up at the dashboard and create your organization. You'll start on the Free plan with 100 credits.
Connect a model
Go to Models and connect an OnlyFans creator account. You'll get a UUID used in all API calls.
Generate an API key
Go to API Keys and create your first key. Copy it — it won't be shown again.
Make your first request
Pass your API key in the X-API-Key header. Each successful proxy call deducts credits.
Your First Request
Get the profile of a connected model. Replace MODEL_UUID with the UUID from your Models page.
curl "/api/models/MODEL_UUID/users/me" \
-H "X-API-Key: sk_live_your_api_key_here"Credit cost
{ data, _meta } envelope — the OnlyFans payload is in data, and billing metadata (credits used/balance, rate limit remaining) is in _meta. See Response Envelope for details.Response Format
Successful proxy responses are wrapped in a {data, _meta} envelope. The OnlyFans payload is in data; billing metadata (credits used/balance and rate limit info) is in _meta.
{
"data": {
"id": 523990756,
"name": "molly",
"username": "mollyy2006",
"subscribersCount": 108,
"postsCount": 75,
"subscribePrice": 20,
"performerTop": 3.3,
"isPerformer": true,
"isVerified": true,
"joinDate": "2025-09-16T00:00:00+00:00"
},
"_meta": {
"_credits": { "used": 1, "balance": 99 },
"_rate_limits": { "limit_minute": 10, "remaining_minute": 9 }
}
}Error Responses
When something goes wrong, the response includes an error object with a machine-readable code and human-readable message.
HTTP 402 Payment Required
{
"error": "Not enough credits to complete this request.",
"code": "INSUFFICIENT_CREDITS"
}Next steps